SDK for PHP 3.x

Client: Aws\GameLift\GameLiftClient
Service ID: gamelift
Version: 2015-10-01

This page describes the parameters and results for the operations of the Amazon GameLift (2015-10-01), and shows how to use the Aws\GameLift\GameLiftClient object to call the described operations. This documentation is specific to the 2015-10-01 API version of the service.

Operation Summary

Each of the following operations can be created from a client using $client->getCommand('CommandName'), where "CommandName" is the name of one of the following operations. Note: a command is a value that encapsulates an operation and the parameters used to create an HTTP request.

You can also create and send a command immediately using the magic methods available on a client object: $client->commandName(/* parameters */). You can send the command asynchronously (returning a promise) by appending the word "Async" to the operation name: $client->commandNameAsync(/* parameters */).

AcceptMatch ( array $params = [] )
Registers a player's acceptance or rejection of a proposed FlexMatch match.
ClaimGameServer ( array $params = [] )
This operation is used with the Amazon GameLift FleetIQ solution and game server groups.
CreateAlias ( array $params = [] )
Creates an alias for a fleet.
CreateBuild ( array $params = [] )
Creates a new Amazon GameLift build resource for your game server binary files.
CreateContainerGroupDefinition ( array $params = [] )
This operation is used with the Amazon GameLift containers feature, which is currently in public preview.
CreateFleet ( array $params = [] )
This operation has been expanded to use with the Amazon GameLift containers feature, which is currently in public preview.
CreateFleetLocations ( array $params = [] )
This operation has been expanded to use with the Amazon GameLift containers feature, which is currently in public preview.
CreateGameServerGroup ( array $params = [] )
This operation is used with the Amazon GameLift FleetIQ solution and game server groups.
CreateGameSession ( array $params = [] )
Creates a multiplayer game session for players in a specific fleet location.
CreateGameSessionQueue ( array $params = [] )
Creates a placement queue that processes requests for new game sessions.
CreateLocation ( array $params = [] )
Creates a custom location for use in an Anywhere fleet.
CreateMatchmakingConfiguration ( array $params = [] )
Defines a new matchmaking configuration for use with FlexMatch.
CreateMatchmakingRuleSet ( array $params = [] )
Creates a new rule set for FlexMatch matchmaking.
CreatePlayerSession ( array $params = [] )
Reserves an open player slot in a game session for a player.
CreatePlayerSessions ( array $params = [] )
Reserves open slots in a game session for a group of players.
CreateScript ( array $params = [] )
Creates a new script record for your Realtime Servers script.
CreateVpcPeeringAuthorization ( array $params = [] )
Requests authorization to create or delete a peer connection between the VPC for your Amazon GameLift fleet and a virtual private cloud (VPC) in your Amazon Web Services account.
CreateVpcPeeringConnection ( array $params = [] )
Establishes a VPC peering connection between a virtual private cloud (VPC) in an Amazon Web Services account with the VPC for your Amazon GameLift fleet.
DeleteAlias ( array $params = [] )
Deletes an alias.
DeleteBuild ( array $params = [] )
Deletes a build.
DeleteContainerGroupDefinition ( array $params = [] )
This operation is used with the Amazon GameLift containers feature, which is currently in public preview.
DeleteFleet ( array $params = [] )
Deletes all resources and information related to a fleet and shuts down any currently running fleet instances, including those in remote locations.
DeleteFleetLocations ( array $params = [] )
Removes locations from a multi-location fleet.
DeleteGameServerGroup ( array $params = [] )
This operation is used with the Amazon GameLift FleetIQ solution and game server groups.
DeleteGameSessionQueue ( array $params = [] )
Deletes a game session queue.
DeleteLocation ( array $params = [] )
Deletes a custom location.
DeleteMatchmakingConfiguration ( array $params = [] )
Permanently removes a FlexMatch matchmaking configuration.
DeleteMatchmakingRuleSet ( array $params = [] )
Deletes an existing matchmaking rule set.
DeleteScalingPolicy ( array $params = [] )
Deletes a fleet scaling policy.
DeleteScript ( array $params = [] )
Deletes a Realtime script.
DeleteVpcPeeringAuthorization ( array $params = [] )
Cancels a pending VPC peering authorization for the specified VPC.
DeleteVpcPeeringConnection ( array $params = [] )
Removes a VPC peering connection.
DeregisterCompute ( array $params = [] )
This operation has been expanded to use with the Amazon GameLift containers feature, which is currently in public preview.
DeregisterGameServer ( array $params = [] )
This operation is used with the Amazon GameLift FleetIQ solution and game server groups.
DescribeAlias ( array $params = [] )
Retrieves properties for an alias.
DescribeBuild ( array $params = [] )
Retrieves properties for a custom game build.
DescribeCompute ( array $params = [] )
This operation has been expanded to use with the Amazon GameLift containers feature, which is currently in public preview.
DescribeContainerGroupDefinition ( array $params = [] )
This operation is used with the Amazon GameLift containers feature, which is currently in public preview.
DescribeEC2InstanceLimits ( array $params = [] )
Retrieves the instance limits and current utilization for an Amazon Web Services Region or location.
DescribeFleetAttributes ( array $params = [] )
This operation has been expanded to use with the Amazon GameLift containers feature, which is currently in public preview.
DescribeFleetCapacity ( array $params = [] )
This operation has been expanded to use with the Amazon GameLift containers feature, which is currently in public preview.
DescribeFleetEvents ( array $params = [] )
Retrieves entries from a fleet's event log.
DescribeFleetLocationAttributes ( array $params = [] )
Retrieves information on a fleet's remote locations, including life-cycle status and any suspended fleet activity.
DescribeFleetLocationCapacity ( array $params = [] )
Retrieves the resource capacity settings for a fleet location.
DescribeFleetLocationUtilization ( array $params = [] )
Retrieves current usage data for a fleet location.
DescribeFleetPortSettings ( array $params = [] )
Retrieves a fleet's inbound connection permissions.
DescribeFleetUtilization ( array $params = [] )
Retrieves utilization statistics for one or more fleets.
DescribeGameServer ( array $params = [] )
This operation is used with the Amazon GameLift FleetIQ solution and game server groups.
DescribeGameServerGroup ( array $params = [] )
This operation is used with the Amazon GameLift FleetIQ solution and game server groups.
DescribeGameServerInstances ( array $params = [] )
This operation is used with the Amazon GameLift FleetIQ solution and game server groups.
DescribeGameSessionDetails ( array $params = [] )
Retrieves additional game session properties, including the game session protection policy in force, a set of one or more game sessions in a specific fleet location.
DescribeGameSessionPlacement ( array $params = [] )
Retrieves information, including current status, about a game session placement request.
DescribeGameSessionQueues ( array $params = [] )
Retrieves the properties for one or more game session queues.
DescribeGameSessions ( array $params = [] )
Retrieves a set of one or more game sessions in a specific fleet location.
DescribeInstances ( array $params = [] )
Retrieves information about the EC2 instances in an Amazon GameLift managed fleet, including instance ID, connection data, and status.
DescribeMatchmaking ( array $params = [] )
Retrieves one or more matchmaking tickets.
DescribeMatchmakingConfigurations ( array $params = [] )
Retrieves the details of FlexMatch matchmaking configurations.
DescribeMatchmakingRuleSets ( array $params = [] )
Retrieves the details for FlexMatch matchmaking rule sets.
DescribePlayerSessions ( array $params = [] )
Retrieves properties for one or more player sessions.
DescribeRuntimeConfiguration ( array $params = [] )
Retrieves a fleet's runtime configuration settings.
DescribeScalingPolicies ( array $params = [] )
Retrieves all scaling policies applied to a fleet.
DescribeScript ( array $params = [] )
Retrieves properties for a Realtime script.
DescribeVpcPeeringAuthorizations ( array $params = [] )
Retrieves valid VPC peering authorizations that are pending for the Amazon Web Services account.
DescribeVpcPeeringConnections ( array $params = [] )
Retrieves information on VPC peering connections.
GetComputeAccess ( array $params = [] )
This operation has been expanded to use with the Amazon GameLift containers feature, which is currently in public preview.
GetComputeAuthToken ( array $params = [] )
Requests an authentication token from Amazon GameLift for a compute resource in an Amazon GameLift Anywhere fleet or container fleet.
GetGameSessionLogUrl ( array $params = [] )
Retrieves the location of stored game session logs for a specified game session on Amazon GameLift managed fleets.
GetInstanceAccess ( array $params = [] )
Requests authorization to remotely connect to an instance in an Amazon GameLift managed fleet.
ListAliases ( array $params = [] )
Retrieves all aliases for this Amazon Web Services account.
ListBuilds ( array $params = [] )
Retrieves build resources for all builds associated with the Amazon Web Services account in use.
ListCompute ( array $params = [] )
This operation has been expanded to use with the Amazon GameLift containers feature, which is currently in public preview.
ListContainerGroupDefinitions ( array $params = [] )
This operation is used with the Amazon GameLift containers feature, which is currently in public preview.
ListFleets ( array $params = [] )
This operation has been expanded to use with the Amazon GameLift containers feature, which is currently in public preview.
ListGameServerGroups ( array $params = [] )
Lists a game server groups.
ListGameServers ( array $params = [] )
This operation is used with the Amazon GameLift FleetIQ solution and game server groups.
ListLocations ( array $params = [] )
Lists all custom and Amazon Web Services locations.
ListScripts ( array $params = [] )
Retrieves script records for all Realtime scripts that are associated with the Amazon Web Services account in use.
ListTagsForResource ( array $params = [] )
Retrieves all tags assigned to a Amazon GameLift resource.
PutScalingPolicy ( array $params = [] )
Creates or updates a scaling policy for a fleet.
RegisterCompute ( array $params = [] )
This operation has been expanded to use with the Amazon GameLift containers feature, which is currently in public preview.
RegisterGameServer ( array $params = [] )
This operation is used with the Amazon GameLift FleetIQ solution and game server groups.
RequestUploadCredentials ( array $params = [] )
Retrieves a fresh set of credentials for use when uploading a new set of game build files to Amazon GameLift's Amazon S3.
ResolveAlias ( array $params = [] )
Attempts to retrieve a fleet ID that is associated with an alias.
ResumeGameServerGroup ( array $params = [] )
This operation is used with the Amazon GameLift FleetIQ solution and game server groups.
SearchGameSessions ( array $params = [] )
Retrieves all active game sessions that match a set of search criteria and sorts them into a specified order.
StartFleetActions ( array $params = [] )
Resumes certain types of activity on fleet instances that were suspended with StopFleetActions.
StartGameSessionPlacement ( array $params = [] )
Places a request for a new game session in a queue.
StartMatchBackfill ( array $params = [] )
Finds new players to fill open slots in currently running game sessions.
StartMatchmaking ( array $params = [] )
Uses FlexMatch to create a game match for a group of players based on custom matchmaking rules.
StopFleetActions ( array $params = [] )
Suspends certain types of activity in a fleet location.
StopGameSessionPlacement ( array $params = [] )
Cancels a game session placement that is in PENDING status.
StopMatchmaking ( array $params = [] )
Cancels a matchmaking ticket or match backfill ticket that is currently being processed.
SuspendGameServerGroup ( array $params = [] )
This operation is used with the Amazon GameLift FleetIQ solution and game server groups.
TagResource ( array $params = [] )
Assigns a tag to an Amazon GameLift resource.
UntagResource ( array $params = [] )
Removes a tag assigned to a Amazon GameLift resource.
UpdateAlias ( array $params = [] )
Updates properties for an alias.
UpdateBuild ( array $params = [] )
Updates metadata in a build resource, including the build name and version.
UpdateFleetAttributes ( array $params = [] )
Updates a fleet's mutable attributes, such as game session protection and resource creation limits.
UpdateFleetCapacity ( array $params = [] )
This operation has been expanded to use with the Amazon GameLift containers feature, which is currently in public preview.
UpdateFleetPortSettings ( array $params = [] )
Updates permissions that allow inbound traffic to connect to game sessions in the fleet.
UpdateGameServer ( array $params = [] )
This operation is used with the Amazon GameLift FleetIQ solution and game server groups.
UpdateGameServerGroup ( array $params = [] )
This operation is used with the Amazon GameLift FleetIQ solution and game server groups.
UpdateGameSession ( array $params = [] )
Updates the mutable properties of a game session.
UpdateGameSessionQueue ( array $params = [] )
Updates the configuration of a game session queue, which determines how the queue processes new game session requests.
UpdateMatchmakingConfiguration ( array $params = [] )
Updates settings for a FlexMatch matchmaking configuration.
UpdateRuntimeConfiguration ( array $params = [] )
Updates the runtime configuration for the specified fleet.
UpdateScript ( array $params = [] )
Updates Realtime script metadata and content.
ValidateMatchmakingRuleSet ( array $params = [] )
Validates the syntax of a matchmaking rule or rule set.

Paginators

Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:

DescribeFleetAttributes
DescribeFleetCapacity
DescribeFleetEvents
DescribeFleetLocationAttributes
DescribeFleetUtilization
DescribeGameServerInstances
DescribeGameSessionDetails
DescribeGameSessionQueues
DescribeGameSessions
DescribeInstances
DescribeMatchmakingConfigurations
DescribeMatchmakingRuleSets
DescribePlayerSessions
DescribeScalingPolicies
ListAliases
ListBuilds
ListCompute
ListContainerGroupDefinitions
ListFleets
ListGameServerGroups
ListGameServers
ListLocations
ListScripts
SearchGameSessions

Operations

AcceptMatch

$result = $client->acceptMatch([/* ... */]);
$promise = $client->acceptMatchAsync([/* ... */]);

Registers a player's acceptance or rejection of a proposed FlexMatch match. A matchmaking configuration may require player acceptance; if so, then matches built with that configuration cannot be completed unless all players accept the proposed match within a specified time limit.

When FlexMatch builds a match, all the matchmaking tickets involved in the proposed match are placed into status REQUIRES_ACCEPTANCE. This is a trigger for your game to get acceptance from all players in each ticket. Calls to this action are only valid for tickets that are in this status; calls for tickets not in this status result in an error.

To register acceptance, specify the ticket ID, one or more players, and an acceptance response. When all players have accepted, Amazon GameLift advances the matchmaking tickets to status PLACING, and attempts to create a new game session for the match.

If any player rejects the match, or if acceptances are not received before a specified timeout, the proposed match is dropped. Each matchmaking ticket in the failed match is handled as follows:

  • If the ticket has one or more players who rejected the match or failed to respond, the ticket status is set CANCELLED and processing is terminated.

  • If all players in the ticket accepted the match, the ticket status is returned to SEARCHING to find a new match.

Learn more

Add FlexMatch to a game client

FlexMatch events (reference)

Parameter Syntax

$result = $client->acceptMatch([
    'AcceptanceType' => 'ACCEPT|REJECT', // REQUIRED
    'PlayerIds' => ['<string>', ...], // REQUIRED
    'TicketId' => '<string>', // REQUIRED
]);

Parameter Details

Members
AcceptanceType
Required: Yes
Type: string

Player response to the proposed match.

PlayerIds
Required: Yes
Type: Array of strings

A unique identifier for a player delivering the response. This parameter can include one or multiple player IDs.

TicketId
Required: Yes
Type: string

A unique identifier for a matchmaking ticket. The ticket must be in status REQUIRES_ACCEPTANCE; otherwise this request will fail.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InvalidRequestException:

One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

NotFoundException:

THe requested resources was not found. The resource was either not created yet or deleted.

InternalServiceException:

The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

UnsupportedRegionException:

The requested operation is not supported in the Region specified.

ClaimGameServer

$result = $client->claimGameServer([/* ... */]);
$promise = $client->claimGameServerAsync([/* ... */]);

This operation is used with the Amazon GameLift FleetIQ solution and game server groups.

Locates an available game server and temporarily reserves it to host gameplay and players. This operation is called from a game client or client service (such as a matchmaker) to request hosting resources for a new game session. In response, Amazon GameLift FleetIQ locates an available game server, places it in CLAIMED status for 60 seconds, and returns connection information that players can use to connect to the game server.

To claim a game server, identify a game server group. You can also specify a game server ID, although this approach bypasses Amazon GameLift FleetIQ placement optimization. Optionally, include game data to pass to the game server at the start of a game session, such as a game map or player information. Add filter options to further restrict how a game server is chosen, such as only allowing game servers on ACTIVE instances to be claimed.

When a game server is successfully claimed, connection information is returned. A claimed game server's utilization status remains AVAILABLE while the claim status is set to CLAIMED for up to 60 seconds. This time period gives the game server time to update its status to UTILIZED after players join. If the game server's status is not updated within 60 seconds, the game server reverts to unclaimed status and is available to be claimed by another request. The claim time period is a fixed value and is not configurable.

If you try to claim a specific game server, this request will fail in the following cases:

  • If the game server utilization status is UTILIZED.

  • If the game server claim status is CLAIMED.

  • If the game server is running on an instance in DRAINING status and the provided filter option does not allow placing on DRAINING instances.

Learn more

Amazon GameLift FleetIQ Guide

Parameter Syntax

$result = $client->claimGameServer([
    'FilterOption' => [
        'InstanceStatuses' => ['<string>', ...],
    ],
    'GameServerData' => '<string>',
    'GameServerGroupName' => '<string>', // REQUIRED
    'GameServerId' => '<string>',
]);

Parameter Details

Members
FilterOption
Type: ClaimFilterOption structure

Object that restricts how a claimed game server is chosen.

GameServerData
Type: string

A set of custom game server properties, formatted as a single string value. This data is passed to a game client or service when it requests information on game servers.

GameServerGroupName
Required: Yes
Type: string

A unique identifier for the game server group where the game server is running. If you are not specifying a game server to claim, this value identifies where you want Amazon GameLift FleetIQ to look for an available game server to claim.

GameServerId
Type: string

A custom string that uniquely identifies the game server to claim. If this parameter is left empty, Amazon GameLift FleetIQ searches for an available game server in the specified game server group.

Result Syntax

[
    'GameServer' => [
        'ClaimStatus' => 'CLAIMED',
        'ConnectionInfo' => '<string>',
        'GameServerData' => '<string>',
        'GameServerGroupArn' => '<string>',
        'GameServerGroupName' => '<string>',
        'GameServerId' => '<string>',
        'InstanceId' => '<string>',
        'LastClaimTime' => <DateTime>,
        'LastHealthCheckTime' => <DateTime>,
        'RegistrationTime' => <DateTime>,
        'UtilizationStatus' => 'AVAILABLE|UTILIZED',
    ],
]

Result Details

Members
GameServer
Type: GameServer structure

Object that describes the newly claimed game server.

Errors

InvalidRequestException:

One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

NotFoundException:

THe requested resources was not found. The resource was either not created yet or deleted.

ConflictException:

The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request.

OutOfCapacityException:

The specified game server group has no available game servers to fulfill a ClaimGameServer request. Clients can retry such requests immediately or after a waiting period.

UnauthorizedException:

The client failed authentication. Clients should not retry such requests.

InternalServiceException:

The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

CreateAlias

$result = $client->createAlias([/* ... */]);
$promise = $client->createAliasAsync([/* ... */]);

Creates an alias for a fleet. In most situations, you can use an alias ID in place of a fleet ID. An alias provides a level of abstraction for a fleet that is useful when redirecting player traffic from one fleet to another, such as when updating your game build.

Amazon GameLift supports two types of routing strategies for aliases: simple and terminal. A simple alias points to an active fleet. A terminal alias is used to display messaging or link to a URL instead of routing players to an active fleet. For example, you might use a terminal alias when a game version is no longer supported and you want to direct players to an upgrade site.

To create a fleet alias, specify an alias name, routing strategy, and optional description. Each simple alias can point to only one fleet, but a fleet can have multiple aliases. If successful, a new alias record is returned, including an alias ID and an ARN. You can reassign an alias to another fleet by calling UpdateAlias.

Related actions

All APIs by task

Parameter Syntax

$result = $client->createAlias([
    'Description' => '<string>',
    'Name' => '<string>', // REQUIRED
    'RoutingStrategy' => [ // REQUIRED
        'FleetId' => '<string>',
        'Message' => '<string>',
        'Type' => 'SIMPLE|TERMINAL',
    ],
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Members
Description
Type: string

A human-readable description of the alias.

Name
Required: Yes
Type: string

A descriptive label that is associated with an alias. Alias names do not need to be unique.

RoutingStrategy
Required: Yes
Type: RoutingStrategy structure

The routing configuration, including routing type and fleet target, for the alias.

Tags
Type: Array of Tag structures

A list of labels to assign to the new alias resource. Tags are developer-defined key-value pairs. Tagging Amazon Web Services resources are useful for resource management, access management and cost allocation. For more information, see Tagging Amazon Web Services Resources in the Amazon Web Services General Reference.

Result Syntax

[
    'Alias' => [
        'AliasArn' => '<string>',
        'AliasId' => '<string>',
        'CreationTime' => <DateTime>,
        'Description' => '<string>',
        'LastUpdatedTime' => <DateTime>,
        'Name' => '<string>',
        'RoutingStrategy' => [
            'FleetId' => '<string>',
            'Message' => '<string>',
            'Type' => 'SIMPLE|TERMINAL',
        ],
    ],
]

Result Details

Members
Alias
Type: Alias structure

The newly created alias resource.

Errors

UnauthorizedException:

The client failed authentication. Clients should not retry such requests.

InvalidRequestException:

One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

ConflictException:

The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request.

InternalServiceException:

The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

LimitExceededException:

The requested operation would cause the resource to exceed the allowed service limit. Resolve the issue before retrying.

TaggingFailedException:

The requested tagging operation did not succeed. This may be due to invalid tag format or the maximum tag limit may have been exceeded. Resolve the issue before retrying.

CreateBuild

$result = $client->createBuild([/* ... */]);
$promise = $client->createBuildAsync([/* ... */]);

Creates a new Amazon GameLift build resource for your game server binary files. Combine game server binaries into a zip file for use with Amazon GameLift.

When setting up a new game build for Amazon GameLift, we recommend using the CLI command upload-build . This helper command combines two tasks: (1) it uploads your build files from a file directory to an Amazon GameLift Amazon S3 location, and (2) it creates a new build resource.

You can use the CreateBuild operation in the following scenarios:

  • Create a new game build with build files that are in an Amazon S3 location under an Amazon Web Services account that you control. To use this option, you give Amazon GameLift access to the Amazon S3 bucket. With permissions in place, specify a build name, operating system, and the Amazon S3 storage location of your game build.

  • Upload your build files to a Amazon GameLift Amazon S3 location. To use this option, specify a build name and operating system. This operation creates a new build resource and also returns an Amazon S3 location with temporary access credentials. Use the credentials to manually upload your build files to the specified Amazon S3 location. For more information, see Uploading Objects in the Amazon S3 Developer Guide. After you upload build files to the Amazon GameLift Amazon S3 location, you can't update them.

If successful, this operation creates a new build resource with a unique build ID and places it in INITIALIZED status. A build must be in READY status before you can create fleets with it.

Learn more

Uploading Your Game

Create a Build with Files in Amazon S3

All APIs by task

Parameter Syntax

$result = $client->createBuild([
    'Name' => '<string>',
    'OperatingSystem' => 'WINDOWS_2012|AMAZON_LINUX|AMAZON_LINUX_2|WINDOWS_2016|AMAZON_LINUX_2023',
    'ServerSdkVersion' => '<string>',
    'StorageLocation' => [
        'Bucket' => '<string>',
        'Key' => '<string>',
        'ObjectVersion' => '<string>',
        'RoleArn' => '<string>',
    ],
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'Version' => '<string>',
]);

Parameter Details

Members
Name
Type: string

A descriptive label associated with a build. Build names don't need to be unique. You can change this value later.

OperatingSystem
Type: string

The operating system that your game server binaries run on. This value determines the type of fleet resources that you use for this build. If your game build contains multiple executables, they all must run on the same operating system. You must specify a valid operating system in this request. There is no default value. You can't change a build's operating system later.

If you have active fleets using the Windows Server 2012 operating system, you can continue to create new builds using this OS until October 10, 2023, when Microsoft ends its support. All others must use Windows Server 2016 when creating new Windows-based builds.

ServerSdkVersion
Type: string

A server SDK version you used when integrating your game server build with Amazon GameLift. For more information see Integrate games with custom game servers. By default Amazon GameLift sets this value to 4.0.2.

StorageLocation
Type: S3Location structure

Information indicating where your game build files are stored. Use this parameter only when creating a build with files stored in an Amazon S3 bucket that you own. The storage location must specify an Amazon S3 bucket name and key. The location must also specify a role ARN that you set up to allow Amazon GameLift to access your Amazon S3 bucket. The S3 bucket and your new build must be in the same Region.

If a StorageLocation is specified, the size of your file can be found in your Amazon S3 bucket. Amazon GameLift will report a SizeOnDisk of 0.

Tags
Type: Array of Tag structures

A list of labels to assign to the new build resource. Tags are developer defined key-value pairs. Tagging Amazon Web Services resources are useful for resource management, access management and cost allocation. For more information, see Tagging Amazon Web Services Resources in the Amazon Web Services General Reference. Once the resource is created, you can use TagResource, UntagResource, and ListTagsForResource to add, remove, and view tags. The maximum tag limit may be lower than stated. See the Amazon Web Services General Reference for actual tagging limits.

Version
Type: string

Version information associated with a build or script. Version strings don't need to be unique. You can change this value later.

Result Syntax

[
    'Build' => [
        'BuildArn' => '<string>',
        'BuildId' => '<string>',
        'CreationTime' => <DateTime>,
        'Name' => '<string>',
        'OperatingSystem' => 'WINDOWS_2012|AMAZON_LINUX|AMAZON_LINUX_2|WINDOWS_2016|AMAZON_LINUX_2023',
        'ServerSdkVersion' => '<string>',
        'SizeOnDisk' => <integer>,
        'Status' => 'INITIALIZED|READY|FAILED',
        'Version' => '<string>',
    ],
    'StorageLocation' => [
        'Bucket' => '<string>',
        'Key' => '<string>',
        'ObjectVersion' => '<string>',
        'RoleArn' => '<string>',
    ],
    'UploadCredentials' => [
        'AccessKeyId' => '<string>',
        'SecretAccessKey' => '<string>',
        'SessionToken' => '<string>',
    ],
]

Result Details

Members
Build
Type: Build structure

The newly created build resource, including a unique build IDs and status.

StorageLocation
Type: S3Location structure

Amazon S3 location for your game build file, including bucket name and key.

UploadCredentials
Type: AwsCredentials structure

This element is returned only when the operation is called without a storage location. It contains credentials to use when you are uploading a build file to an Amazon S3 bucket that is owned by Amazon GameLift. Credentials have a limited life span. To refresh these credentials, call RequestUploadCredentials.

Errors

UnauthorizedException:

The client failed authentication. Clients should not retry such requests.

InvalidRequestException:

One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

ConflictException:

The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request.

TaggingFailedException:

The requested tagging operation did not succeed. This may be due to invalid tag format or the maximum tag limit may have been exceeded. Resolve the issue before retrying.

InternalServiceException:

The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

CreateContainerGroupDefinition

$result = $client->createContainerGroupDefinition([/* ... */]);
$promise = $client->createContainerGroupDefinitionAsync([/* ... */]);

This operation is used with the Amazon GameLift containers feature, which is currently in public preview.

Creates a ContainerGroupDefinition resource that describes a set of containers for hosting your game server with Amazon GameLift managed EC2 hosting. An Amazon GameLift container group is similar to a container "task" and "pod". Each container group can have one or more containers.

Use container group definitions when you create a container fleet. Container group definitions determine how Amazon GameLift deploys your containers to each instance in a container fleet.

You can create two types of container groups, based on scheduling strategy:

  • A replica container group manages the containers that run your game server application and supporting software. Replica container groups might be replicated multiple times on each fleet instance, depending on instance resources.

  • A daemon container group manages containers that run other software, such as background services, logging, or test processes. You might use a daemon container group for processes that need to run only once per fleet instance, or processes that need to persist independently of the replica container group.

To create a container group definition, specify a group name, a list of container definitions, and maximum total CPU and memory requirements for the container group. Specify an operating system and scheduling strategy or use the default values. When using the Amazon Web Services CLI tool, you can pass in your container definitions as a JSON file.

This operation requires Identity and Access Management (IAM) permissions to access container images in Amazon ECR repositories. See IAM permissions for Amazon GameLift for help setting the appropriate permissions.

If successful, this operation creates a new ContainerGroupDefinition resource with an ARN value assigned. You can't change the properties of a container group definition. Instead, create a new one.

Learn more

Parameter Syntax

$result = $client->createContainerGroupDefinition([
    'ContainerDefinitions' => [ // REQUIRED
        [
            'Command' => ['<string>', ...],
            'ContainerName' => '<string>', // REQUIRED
            'Cpu' => <integer>,
            'DependsOn' => [
                [
                    'Condition' => 'START|COMPLETE|SUCCESS|HEALTHY', // REQUIRED
                    'ContainerName' => '<string>', // REQUIRED
                ],
                // ...
            ],
            'EntryPoint' => ['<string>', ...],
            'Environment' => [
                [
                    'Name' => '<string>', // REQUIRED
                    'Value' => '<string>', // REQUIRED
                ],
                // ...
            ],
            'Essential' => true || false,
            'HealthCheck' => [
                'Command' => ['<string>', ...], // REQUIRED
                'Interval' => <integer>,
                'Retries' => <integer>,
                'StartPeriod' => <integer>,
                'Timeout' => <integer>,
            ],
            'ImageUri' => '<string>', // REQUIRED
            'MemoryLimits' => [
                'HardLimit' => <integer>,
                'SoftLimit' => <integer>,
            ],
            'PortConfiguration' => [
                'ContainerPortRanges' => [ // REQUIRED
                    [
                        'FromPort' => <integer>, // REQUIRED
                        'Protocol' => 'TCP|UDP', // REQUIRED
                        'ToPort' => <integer>, // REQUIRED
                    ],
                    // ...
                ],
            ],
            'WorkingDirectory' => '<string>',
        ],
        // ...
    ],
    'Name' => '<string>', // REQUIRED
    'OperatingSystem' => 'AMAZON_LINUX_2023', // REQUIRED
    'SchedulingStrategy' => 'REPLICA|DAEMON',
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'TotalCpuLimit' => <integer>, // REQUIRED
    'TotalMemoryLimit' => <integer>, // REQUIRED
]);

Parameter Details

Members
ContainerDefinitions
Required: Yes
Type: Array of ContainerDefinitionInput structures

Definitions for all containers in this group. Each container definition identifies the container image and specifies configuration settings for the container. See the Container fleet design guide for container guidelines.

Name
Required: Yes
Type: string

A descriptive identifier for the container group definition. The name value must be unique in an Amazon Web Services Region.

OperatingSystem
Required: Yes
Type: string

The platform that is used by containers in the container group definition. All containers in a group must run on the same operating system.

SchedulingStrategy
Type: string

The method for deploying the container group across fleet instances. A replica container group might have multiple copies on each fleet instance. A daemon container group has one copy per fleet instance. Default value is REPLICA.

Tags
Type: Array of Tag structures

A list of labels to assign to the container group definition resource. Tags are developer-defined key-value pairs. Tagging Amazon Web Services resources are useful for resource management, access management and cost allocation. For more information, see Tagging Amazon Web Services Resources in the Amazon Web Services General Reference.

TotalCpuLimit
Required: Yes
Type: int

The maximum amount of CPU units to allocate to the container group. Set this parameter to an integer value in CPU units (1 vCPU is equal to 1024 CPU units). All containers in the group share this memory. If you specify CPU limits for individual containers, set this parameter based on the following guidelines. The value must be equal to or greater than the sum of the CPU limits for all containers in the group.

TotalMemoryLimit
Required: Yes
Type: int

The maximum amount of memory (in MiB) to allocate to the container group. All containers in the group share this memory. If you specify memory limits for individual containers, set this parameter based on the following guidelines. The value must be (1) greater than the sum of the soft memory limits for all containers in the group, and (2) greater than any individual container's hard memory limit.

Result Syntax

[
    'ContainerGroupDefinition' => [
        'ContainerDefinitions' => [
            [
                'Command' => ['<string>', ...],
                'ContainerName' => '<string>',
                'Cpu' => <integer>,
                'DependsOn' => [
                    [
                        'Condition' => 'START|COMPLETE|SUCCESS|HEALTHY',
                        'ContainerName' => '<string>',
                    ],
                    // ...
                ],
                'EntryPoint' => ['<string>', ...],
                'Environment' => [
                    [
                        'Name' => '<string>',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
                'Essential' => true || false,
                'HealthCheck' => [
                    'Command' => ['<string>', ...],
                    'Interval' => <integer>,
                    'Retries' => <integer>,
                    'StartPeriod' => <integer>,
                    'Timeout' => <integer>,
                ],
                'ImageUri' => '<string>',
                'MemoryLimits' => [
                    'HardLimit' => <integer>,
                    'SoftLimit' => <integer>,
                ],
                'PortConfiguration' => [
                    'ContainerPortRanges' => [
                        [
                            'FromPort' => <integer>,
                            'Protocol' => 'TCP|UDP',
                            'ToPort' => <integer>,
                        ],
                        // ...
                    ],
                ],
                'ResolvedImageDigest' => '<string>',
                'WorkingDirectory' => '<string>',
            ],
            // ...
        ],
        'ContainerGroupDefinitionArn' => '<string>',
        'CreationTime' => <DateTime>,
        'Name' => '<string>',
        'OperatingSystem' => 'AMAZON_LINUX_2023',
        'SchedulingStrategy' => 'REPLICA|DAEMON',
        'Status' => 'READY|COPYING|FAILED',
        'StatusReason' => '<string>',
        'TotalCpuLimit' => <integer>,
        'TotalMemoryLimit' => <integer>,
    ],
]

Result Details

Members
ContainerGroupDefinition
Type: ContainerGroupDefinition structure

The properties of the newly created container group definition resource. You use this resource to create a container fleet.

Errors

UnauthorizedException:

The client failed authentication. Clients should not retry such requests.

InvalidRequestException:

One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

ConflictException:

The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request.

LimitExceededException:

The requested operation would cause the resource to exceed the allowed service limit. Resolve the issue before retrying.

TaggingFailedException:

The requested tagging operation did not succeed. This may be due to invalid tag format or the maximum tag limit may have been exceeded. Resolve the issue before retrying.

InternalServiceException:

The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

UnsupportedRegionException:

The requested operation is not supported in the Region specified.

CreateFleet

$result = $client->createFleet([/* ... */]);
$promise = $client->createFleetAsync([/* ... */]);

This operation has been expanded to use with the Amazon GameLift containers feature, which is currently in public preview.

Creates a fleet of compute resources to host your game servers. Use this operation to set up the following types of fleets based on compute type:

Managed EC2 fleet

An EC2 fleet is a set of Amazon Elastic Compute Cloud (Amazon EC2) instances. Your game server build is deployed to each fleet instance. Amazon GameLift manages the fleet's instances and controls the lifecycle of game server processes, which host game sessions for players. EC2 fleets can have instances in multiple locations. Each instance in the fleet is designated a Compute.

To create an EC2 fleet, provide these required parameters:

  • Either BuildId or ScriptId

  • ComputeType set to EC2 (the default value)

  • EC2InboundPermissions

  • EC2InstanceType

  • FleetType

  • Name

  • RuntimeConfiguration with at least one ServerProcesses configuration

If successful, this operation creates a new fleet resource and places it in NEW status while Amazon GameLift initiates the fleet creation workflow. To debug your fleet, fetch logs, view performance metrics or other actions on the fleet, create a development fleet with port 22/3389 open. As a best practice, we recommend opening ports for remote access only when you need them and closing them when you're finished.

When the fleet status is ACTIVE, you can adjust capacity settings and turn autoscaling on/off for each location.

Managed container fleet

A container fleet is a set of Amazon Elastic Compute Cloud (Amazon EC2) instances. Your container architecture is deployed to each fleet instance based on the fleet configuration. Amazon GameLift manages the containers on each fleet instance and controls the lifecycle of game server processes, which host game sessions for players. Container fleets can have instances in multiple locations. Each container on an instance that runs game server processes is registered as a Compute.

To create a container fleet, provide these required parameters:

  • ComputeType set to CONTAINER

  • ContainerGroupsConfiguration

  • EC2InboundPermissions

  • EC2InstanceType

  • FleetType set to ON_DEMAND

  • Name

  • RuntimeConfiguration with at least one ServerProcesses configuration

If successful, this operation creates a new fleet resource and places it in NEW status while Amazon GameLift initiates the fleet creation workflow.

When the fleet status is ACTIVE, you can adjust capacity settings and turn autoscaling on/off for each location.

Anywhere fleet

An Anywhere fleet represents compute resources that are not owned or managed by Amazon GameLift. You might create an Anywhere fleet with your local machine for testing, or use one to host game servers with on-premises hardware or other game hosting solutions.

To create an Anywhere fleet, provide these required parameters:

  • ComputeType set to ANYWHERE

  • Locations specifying a custom location

  • Name

If successful, this operation creates a new fleet resource and places it in ACTIVE status. You can register computes with a fleet in ACTIVE status.

Learn more

Setting up fleets

Setting up a container fleet

Debug fleet creation issues

Multi-location fleets

Parameter Syntax

$result = $client->createFleet([
    'AnywhereConfiguration' => [
        'Cost' => '<string>', // REQUIRED
    ],
    'BuildId' => '<string>',
    'CertificateConfiguration' => [
        'CertificateType' => 'DISABLED|GENERATED', // REQUIRED
    ],
    'ComputeType' => 'EC2|ANYWHERE|CONTAINER',
    'ContainerGroupsConfiguration' => [
        'ConnectionPortRange' => [ // REQUIRED
            'FromPort' => <integer>, // REQUIRED
            'ToPort' => <integer>, // REQUIRED
        ],
        'ContainerGroupDefinitionNames' => ['<string>', ...], // REQUIRED
        'DesiredReplicaContainerGroupsPerInstance' => <integer>,
    ],
    'Description' => '<string>',
    'EC2InboundPermissions' => [
        [
            'FromPort' => <integer>, // REQUIRED
            'IpRange' => '<string>', // REQUIRED
            'Protocol' => 'TCP|UDP', // REQUIRED
            'ToPort' => <integer>, // REQUIRED
        ],
        // ...
    ],
    'EC2InstanceType' => 't2.micro|t2.small|t2.medium|t2.large|c3.large|c3.xlarge|c3.2xlarge|c3.4xlarge|c3.8xlarge|c4.large|c4.xlarge|c4.2xlarge|c4.4xlarge|c4.8xlarge|c5.large|c5.xlarge|c5.2xlarge|c5.4xlarge|c5.9xlarge|c5.12xlarge|c5.18xlarge|c5.24xlarge|c5a.large|c5a.xlarge|c5a.2xlarge|c5a.4xlarge|c5a.8xlarge|c5a.12xlarge|c5a.16xlarge|c5a.24xlarge|r3.large|r3.xlarge|r3.2xlarge|r3.4xlarge|r3.8xlarge|r4.large|r4.xlarge|r4.2xlarge|r4.4xlarge|r4.8xlarge|r4.16xlarge|r5.large|r5.xlarge|r5.2xlarge|r5.4xlarge|r5.8xlarge|r5.12xlarge|r5.16xlarge|r5.24xlarge|r5a.large|r5a.xlarge|r5a.2xlarge|r5a.4xlarge|r5a.8xlarge|r5a.12xlarge|r5a.16xlarge|r5a.24xlarge|m3.medium|m3.large|m3.xlarge|m3.2xlarge|m4.large|m4.xlarge|m4.2xlarge|m4.4xlarge|m4.10xlarge|m5.large|m5.xlarge|m5.2xlarge|m5.4xlarge|m5.8xlarge|m5.12xlarge|m5.16xlarge|m5.24xlarge|m5a.large|m5a.xlarge|m5a.2xlarge|m5a.4xlarge|m5a.8xlarge|m5a.12xlarge|m5a.16xlarge|m5a.24xlarge|c5d.large|c5d.xlarge|c5d.2xlarge|c5d.4xlarge|c5d.9xlarge|c5d.12xlarge|c5d.18xlarge|c5d.24xlarge|c6a.large|c6a.xlarge|c6a.2xlarge|c6a.4xlarge|c6a.8xlarge|c6a.12xlarge|c6a.16xlarge|c6a.24xlarge|c6i.large|c6i.xlarge|c6i.2xlarge|c6i.4xlarge|c6i.8xlarge|c6i.12xlarge|c6i.16xlarge|c6i.24xlarge|r5d.large|r5d.xlarge|r5d.2xlarge|r5d.4xlarge|r5d.8xlarge|r5d.12xlarge|r5d.16xlarge|r5d.24xlarge|m6g.medium|m6g.large|m6g.xlarge|m6g.2xlarge|m6g.4xlarge|m6g.8xlarge|m6g.12xlarge|m6g.16xlarge|c6g.medium|c6g.large|c6g.xlarge|c6g.2xlarge|c6g.4xlarge|c6g.8xlarge|c6g.12xlarge|c6g.16xlarge|r6g.medium|r6g.large|r6g.xlarge|r6g.2xlarge|r6g.4xlarge|r6g.8xlarge|r6g.12xlarge|r6g.16xlarge|c6gn.medium|c6gn.large|c6gn.xlarge|c6gn.2xlarge|c6gn.4xlarge|c6gn.8xlarge|c6gn.12xlarge|c6gn.16xlarge|c7g.medium|c7g.large|c7g.xlarge|c7g.2xlarge|c7g.4xlarge|c7g.8xlarge|c7g.12xlarge|c7g.16xlarge|r7g.medium|r7g.large|r7g.xlarge|r7g.2xlarge|r7g.4xlarge|r7g.8xlarge|r7g.12xlarge|r7g.16xlarge|m7g.medium|m7g.large|m7g.xlarge|m7g.2xlarge|m7g.4xlarge|m7g.8xlarge|m7g.12xlarge|m7g.16xlarge|g5g.xlarge|g5g.2xlarge|g5g.4xlarge|g5g.8xlarge|g5g.16xlarge',
    'FleetType' => 'ON_DEMAND|SPOT',
    'InstanceRoleArn' => '<string>',
    'InstanceRoleCredentialsProvider' => 'SHARED_CREDENTIAL_FILE',
    'Locations' => [
        [
            'Location' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'LogPaths' => ['<string>', ...],
    'MetricGroups' => ['<string>', ...],
    'Name' => '<string>', // REQUIRED
    'NewGameSessionProtectionPolicy' => 'NoProtection|FullProtection',
    'PeerVpcAwsAccountId' => '<string>',
    'PeerVpcId' => '<string>',
    'ResourceCreationLimitPolicy' => [
        'NewGameSessionsPerCreator' => <integer>,
        'PolicyPeriodInMinutes' => <integer>,
    ],
    'RuntimeConfiguration' => [
        'GameSessionActivationTimeoutSeconds' => <integer>,
        'MaxConcurrentGameSessionActivations' => <integer>,
        'ServerProcesses' => [
            [
                'ConcurrentExecutions' => <integer>, // REQUIRED
                'LaunchPath' => '<string>', // REQUIRED
                'Parameters' => '<string>',
            ],
            // ...
        ],
    ],
    'ScriptId' => '<string>',
    'ServerLaunchParameters' => '<string>',
    'ServerLaunchPath' => '<string>',
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Members
AnywhereConfiguration
Type: AnywhereConfiguration structure

Amazon GameLift Anywhere configuration options.

BuildId
Type: string

The unique identifier for a custom game server build to be deployed to a fleet with compute type EC2. You can use either the build ID or ARN. The build must be uploaded to Amazon GameLift and in READY status. This fleet property can't be changed after the fleet is created.

CertificateConfiguration
Type: CertificateConfiguration structure

Prompts Amazon GameLift to generate a TLS/SSL certificate for the fleet. Amazon GameLift uses the certificates to encrypt traffic between game clients and the game servers running on Amazon GameLift. By default, the CertificateConfiguration is DISABLED. You can't change this property after you create the fleet.

Certificate Manager (ACM) certificates expire after 13 months. Certificate expiration can cause fleets to fail, preventing players from connecting to instances in the fleet. We recommend you replace fleets before 13 months, consider using fleet aliases for a smooth transition.

ACM isn't available in all Amazon Web Services regions. A fleet creation request with certificate generation enabled in an unsupported Region, fails with a 4xx error. For more information about the supported Regions, see Supported Regions in the Certificate Manager User Guide.

ComputeType
Type: string

The type of compute resource used to host your game servers.

  • EC2 – The game server build is deployed to Amazon EC2 instances for cloud hosting. This is the default setting.

  • CONTAINER – Container images with your game server build and supporting software are deployed to Amazon EC2 instances for cloud hosting. With this compute type, you must specify the ContainerGroupsConfiguration parameter.

  • ANYWHERE – Game servers or container images with your game server and supporting software are deployed to compute resources that are provided and managed by you. With this compute type, you can also set the AnywhereConfiguration parameter.

ContainerGroupsConfiguration

The container groups to deploy to instances in the container fleet and other fleet-level configuration settings. Use the CreateContainerGroupDefinition action to create container groups. A container fleet must have exactly one replica container group, and can optionally have one daemon container group. You can't change this property after you create the fleet.

Description
Type: string

A description for the fleet.

EC2InboundPermissions
Type: Array of IpPermission structures

The IP address ranges and port settings that allow inbound traffic to access game server processes and other processes on this fleet. Set this parameter for EC2 and container fleets. You can leave this parameter empty when creating the fleet, but you must call UpdateFleetPortSettings to set it before players can connect to game sessions. As a best practice, we recommend opening ports for remote access only when you need them and closing them when you're finished. For Realtime Servers fleets, Amazon GameLift automatically sets TCP and UDP ranges.

To manage inbound access for a container fleet, set this parameter to the same port numbers that you set for the fleet's connection port range. During the life of the fleet, update this parameter to control which connection ports are open to inbound traffic.

EC2InstanceType
Type: string

The Amazon GameLift-supported Amazon EC2 instance type to use with EC2 and container fleets. Instance type determines the computing resources that will be used to host your game servers, including CPU, memory, storage, and networking capacity. See Amazon Elastic Compute Cloud Instance Types for detailed descriptions of Amazon EC2 instance types.

FleetType
Type: string

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 fleet property can't be changed after the fleet is created.

InstanceRoleArn
Type: string

A unique identifier for an IAM role with access permissions to other Amazon Web Services services. Any application that runs on an instance in the fleet--including install scripts, server processes, and other processes--can use these permissions to interact with Amazon Web Services resources that you own or have access to. For more information about using the role with your game server builds, see Communicate with other Amazon Web Services resources from your fleets. This fleet property can't be changed after the fleet is created.

InstanceRoleCredentialsProvider
Type: string

Prompts Amazon GameLift to generate a shared credentials file for the IAM role that's defined in InstanceRoleArn. The shared credentials file is stored on each fleet instance and refreshed as needed. Use shared credentials for applications that are deployed along with the game server executable, if the game server is integrated with server SDK version 5.x. For more information about using shared credentials, see Communicate with other Amazon Web Services resources from your fleets.

Locations
Type: Array of LocationConfiguration structures

A set of remote locations to deploy additional instances to and manage as part of the fleet. This parameter can only be used when creating fleets in Amazon Web Services Regions that support multiple locations. You can add any Amazon GameLift-supported Amazon Web Services Region as a remote location, in the form of an Amazon Web Services Region code, such as us-west-2 or Local Zone code. To create a fleet with instances in the home Region only, don't set this parameter.

When using this parameter, Amazon GameLift requires you to include your home location in the request.

LogPaths
Type: Array of strings

This parameter is no longer used. To specify where Amazon GameLift should store log files once a server process shuts down, use the Amazon GameLift server API ProcessReady() and specify one or more directory paths in logParameters. For more information, see Initialize the server process in the Amazon GameLift Developer Guide.

MetricGroups
Type: Array of strings

The name of an Amazon Web Services CloudWatch metric group to add this fleet to. A metric group is used to aggregate the metrics for multiple fleets. You can specify an existing metric group name or set a new name to create a new metric group. A fleet can be included in only one metric group at a time.

Name
Required: Yes
Type: string

A descriptive label that is associated with a fleet. Fleet names do not need to be unique.

NewGameSessionProtectionPolicy
Type: string

The status of termination protection for active game sessions on the fleet. By default, this property is set to NoProtection. You can also set game session protection for an individual game session by calling UpdateGameSession.

  • NoProtection - Game sessions can be terminated during active gameplay as a result of a scale-down event.

  • FullProtection - Game sessions in ACTIVE status cannot be terminated during a scale-down event.

PeerVpcAwsAccountId
Type: string

Used when peering your Amazon GameLift fleet with a VPC, the unique identifier for the Amazon Web Services account that owns the VPC. You can find your account ID in the Amazon Web Services Management Console under account settings.

PeerVpcId
Type: string

A unique identifier for a VPC with resources to be accessed by your Amazon GameLift fleet. The VPC must be in the same Region as your fleet. To look up a VPC ID, use the VPC Dashboard in the Amazon Web Services Management Console. Learn more about VPC peering in VPC Peering with Amazon GameLift Fleets.

ResourceCreationLimitPolicy
Type: ResourceCreationLimitPolicy structure

A policy that limits the number of game sessions that an individual player can create on instances in this fleet within a specified span of time.

RuntimeConfiguration
Type: RuntimeConfiguration structure

Instructions for how to launch and run server processes on the fleet. Set runtime configuration for EC2 fleets and container fleets. For an Anywhere fleets, set this parameter only if the fleet is running the Amazon GameLift Agent. The runtime configuration defines one or more server process configurations. Each server process identifies a game executable or Realtime script file and the number of processes to run concurrently.

This parameter replaces the parameters ServerLaunchPath and ServerLaunchParameters, which are still supported for backward compatibility.

ScriptId
Type: string

The unique identifier for a Realtime configuration script to be deployed to a fleet with compute type EC2. You can use either the script ID or ARN. Scripts must be uploaded to Amazon GameLift prior to creating the fleet. This fleet property can't be changed after the fleet is created.

ServerLaunchParameters
Type: string

This parameter is no longer used. Specify server launch parameters using the RuntimeConfiguration parameter. Requests that use this parameter instead continue to be valid.

ServerLaunchPath
Type: string

This parameter is no longer used. Specify a server launch path using the RuntimeConfiguration parameter. Requests that use this parameter instead continue to be valid.

Tags
Type: Array of Tag structures

A list of labels to assign to the new fleet resource. Tags are developer-defined key-value pairs. Tagging Amazon Web Services resources are useful for resource management, access management and cost allocation. For more information, see Tagging Amazon Web Services Resources in the Amazon Web Services General Reference.

Result Syntax

[
    'FleetAttributes' => [
        'AnywhereConfiguration' => [
            'Cost' => '<string>',
        ],
        'BuildArn' => '<string>',
        'BuildId' => '<string>',
        'CertificateConfiguration' => [
            'CertificateType' => 'DISABLED|GENERATED',
        ],
        'ComputeType' => 'EC2|ANYWHERE|CONTAINER',
        'ContainerGroupsAttributes' => [
            'ConnectionPortRange' => [
                'FromPort' => <integer>,
                'ToPort' => <integer>,
            ],
            'ContainerGroupDefinitionProperties' => [
                [
                    'ContainerGroupDefinitionName' => '<string>',
                    'SchedulingStrategy' => 'REPLICA|DAEMON',
                ],
                // ...
            ],
            'ContainerGroupsPerInstance' => [
                'DesiredReplicaContainerGroupsPerInstance' => <integer>,
                'MaxReplicaContainerGroupsPerInstance' => <integer>,
            ],
        ],
        'CreationTime' => <DateTime>,
        'Description' => '<string>',
        'FleetArn' => '<string>',
        'FleetId' => '<string>',
        'FleetType' => 'ON_DEMAND|SPOT',
        'InstanceRoleArn' => '<string>',
        'InstanceRoleCredentialsProvider' => 'SHARED_CREDENTIAL_FILE',
        'InstanceType' => 't2.micro|t2.small|t2.medium|t2.large|c3.large|c3.xlarge|c3.2xlarge|c3.4xlarge|c3.8xlarge|c4.large|c4.xlarge|c4.2xlarge|c4.4xlarge|c4.8xlarge|c5.large|c5.xlarge|c5.2xlarge|c5.4xlarge|c5.9xlarge|c5.12xlarge|c5.18xlarge|c5.24xlarge|c5a.large|c5a.xlarge|c5a.2xlarge|c5a.4xlarge|c5a.8xlarge|c5a.12xlarge|c5a.16xlarge|c5a.24xlarge|r3.large|r3.xlarge|r3.2xlarge|r3.4xlarge|r3.8xlarge|r4.large|r4.xlarge|r4.2xlarge|r4.4xlarge|r4.8xlarge|r4.16xlarge|r5.large|r5.xlarge|r5.2xlarge|r5.4xlarge|r5.8xlarge|r5.12xlarge|r5.16xlarge|r5.24xlarge|r5a.large|r5a.xlarge|r5a.2xlarge|r5a.4xlarge|r5a.8xlarge|r5a.12xlarge|r5a.16xlarge|r5a.24xlarge|m3.medium|m3.large|m3.xlarge|m3.2xlarge|m4.large|m4.xlarge|m4.2xlarge|m4.4xlarge|m4.10xlarge|m5.large|m5.xlarge|m5.2xlarge|m5.4xlarge|m5.8xlarge|m5.12xlarge|m5.16xlarge|m5.24xlarge|m5a.large|m5a.xlarge|m5a.2xlarge|m5a.4xlarge|m5a.8xlarge|m5a.12xlarge|m5a.16xlarge|m5a.24xlarge|c5d.large|c5d.xlarge|c5d.2xlarge|c5d.4xlarge|c5d.9xlarge|c5d.12xlarge|c5d.18xlarge|c5d.24xlarge|c6a.large|c6a.xlarge|c6a.2xlarge|c6a.4xlarge|c6a.8xlarge|c6a.12xlarge|c6a.16xlarge|c6a.24xlarge|c6i.large|c6i.xlarge|c6i.2xlarge|c6i.4xlarge|c6i.8xlarge|c6i.12xlarge|c6i.16xlarge|c6i.24xlarge|r5d.large|r5d.xlarge|r5d.2xlarge|r5d.4xlarge|r5d.8xlarge|r5d.12xlarge|r5d.16xlarge|r5d.24xlarge|m6g.medium|m6g.large|m6g.xlarge|m6g.2xlarge|m6g.4xlarge|m6g.8xlarge|m6g.12xlarge|m6g.16xlarge|c6g.medium|c6g.large|c6g.xlarge|c6g.2xlarge|c6g.4xlarge|c6g.8xlarge|c6g.12xlarge|c6g.16xlarge|r6g.medium|r6g.large|r6g.xlarge|r6g.2xlarge|r6g.4xlarge|r6g.8xlarge|r6g.12xlarge|r6g.16xlarge|c6gn.medium|c6gn.large|c6gn.xlarge|c6gn.2xlarge|c6gn.4xlarge|c6gn.8xlarge|c6gn.12xlarge|c6gn.16xlarge|c7g.medium|c7g.large|c7g.xlarge|c7g.2xlarge|c7g.4xlarge|c7g.8xlarge|c7g.12xlarge|c7g.16xlarge|r7g.medium|r7g.large|r7g.xlarge|r7g.2xlarge|r7g.4xlarge|r7g.8xlarge|r7g.12xlarge|r7g.16xlarge|m7g.medium|m7g.large|m7g.xlarge|m7g.2xlarge|m7g.4xlarge|m7g.8xlarge|m7g.12xlarge|m7g.16xlarge|g5g.xlarge|g5g.2xlarge|g5g.4xlarge|g5g.8xlarge|g5g.16xlarge',
        'LogPaths' => ['<string>', ...],
        'MetricGroups' => ['<string>', ...],
        'Name' => '<string>',
        'NewGameSessionProtectionPolicy' => 'NoProtection|FullProtection',
        'OperatingSystem' => 'WINDOWS_2012|AMAZON_LINUX|AMAZON_LINUX_2|WINDOWS_2016|AMAZON_LINUX_2023',
        'ResourceCreationLimitPolicy' => [
            'NewGameSessionsPerCreator' => <integer>,
            'PolicyPeriodInMinutes' => <integer>,
        ],
        'ScriptArn' => '<string>',
        'ScriptId' => '<string>',
        'ServerLaunchParameters' => '<string>',
        'ServerLaunchPath' => '<string>',
        'Status' => 'NEW|DOWNLOADING|VALIDATING|BUILDING|ACTIVATING|ACTIVE|DELETING|ERROR|TERMINATED|NOT_FOUND',
        'StoppedActions' => ['<string>', ...],
        'TerminationTime' => <DateTime>,
    ],
    'LocationStates' => [
        [
            'Location' => '<string>',
            'Status' => 'NEW|DOWNLOADING|VALIDATING|BUILDING|ACTIVATING|ACTIVE|DELETING|ERROR|TERMINATED|NOT_FOUND',
        ],
        // ...
    ],
]

Result Details

Members
FleetAttributes
Type: FleetAttributes structure

The properties for the new fleet, including the current status. All fleets are placed in NEW status on creation.

LocationStates
Type: Array of LocationState structures

The fleet's locations and life-cycle status of each location. For new fleets, the status of all locations is set to NEW. During fleet creation, Amazon GameLift updates each location status as instances are deployed there and prepared for game hosting. This list includes an entry for the fleet's home Region. For fleets with no remote locations, only one entry, representing the home Region, is returned.

Errors

InternalServiceException:

The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

NotFoundException:

THe requested resources was not found. The resource was either not created yet or deleted.

NotReadyException:

The operation failed because Amazon GameLift has not yet finished validating this compute. We recommend attempting 8 to 10 retries over 3 to 5 minutes with exponential backoffs and jitter.

ConflictException:

The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request.

LimitExceededException:

The requested operation would cause the resource to exceed the allowed service limit. Resolve the issue before retrying.

InvalidRequestException:

One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

UnauthorizedException:

The client failed authentication. Clients should not retry such requests.

TaggingFailedException:

The requested tagging operation did not succeed. This may be due to invalid tag format or the maximum tag limit may have been exceeded. Resolve the issue before retrying.

UnsupportedRegionException:

The requested operation is not supported in the Region specified.

CreateFleetLocations

$result = $client->createFleetLocations([/* ... */]);
$promise = $client->createFleetLocationsAsync([/* ... */]);

This operation has been expanded to use with the Amazon GameLift containers feature, which is currently in public preview.

Adds remote locations to an EC2 or container fleet and begins populating the new locations with instances. The new instances conform to the fleet's instance type, auto-scaling, and other configuration settings.

You can't add remote locations to a fleet that resides in an Amazon Web Services Region that doesn't support multiple locations. Fleets created prior to March 2021 can't support multiple locations.

To add fleet locations, specify the fleet to be updated and provide a list of one or more locations.

If successful, this operation returns the list of added locations with their status set to NEW. Amazon GameLift initiates the process of starting an instance in each added location. You can track the status of each new location by monitoring location creation events using DescribeFleetEvents.

Learn more

Setting up fleets

Multi-location fleets

Parameter Syntax

$result = $client->createFleetLocations([
    'FleetId' => '<string>', // REQUIRED
    'Locations' => [ // REQUIRED
        [
            'Location' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Members
FleetId
Required: Yes
Type: string

A unique identifier for the fleet to add locations to. You can use either the fleet ID or ARN value.

Locations
Required: Yes
Type: Array of LocationConfiguration structures

A list of locations to deploy additional instances to and manage as part of the fleet. You can add any Amazon GameLift-supported Amazon Web Services Region as a remote location, in the form of an Amazon Web Services Region code such as us-west-2.

Result Syntax

[
    'FleetArn' => '<string>',
    'FleetId' => '<string>',
    'LocationStates' => [
        [
            'Location' => '<string>',
            'Status' => 'NEW|DOWNLOADING|VALIDATING|BUILDING|ACTIVATING|ACTIVE|DELETING|ERROR|TERMINATED|NOT_FOUND',
        ],
        // ...
    ],
]

Result Details

Members
FleetArn
Type: string

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.

FleetId
Type: string

A unique identifier for the fleet that was updated with new locations.

LocationStates
Type: Array of LocationState structures

The remote locations that are being added to the fleet, and the life-cycle status of each location. For new locations, the status is set to NEW. During location creation, Amazon GameLift updates each location's status as instances are deployed there and prepared for game hosting. This list does not include the fleet home Region or any remote locations that were already added to the fleet.

Errors

InternalServiceException:

The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

InvalidRequestException:

One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

UnauthorizedException:

The client failed authentication. Clients should not retry such requests.

NotFoundException:

THe requested resources was not found. The resource was either not created yet or deleted.

NotReadyException:

The operation failed because Amazon GameLift has not yet finished validating this compute. We recommend attempting 8 to 10 retries over 3 to 5 minutes with exponential backoffs and jitter.

InvalidFleetStatusException:

The requested operation would cause a conflict with the current state of a resource associated with the request and/or the fleet. Resolve the conflict before retrying.

UnsupportedRegionException:

The requested operation is not supported in the Region specified.

ConflictException:

The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request.

LimitExceededException:

The requested operation would cause the resource to exceed the allowed service limit. Resolve the issue before retrying.

CreateGameServerGroup

$result = $client->createGameServerGroup([/* ... */]);
$promise = $client->createGameServerGroupAsync([/* ... */]);

This operation is used with the Amazon GameLift FleetIQ solution and game server groups.

Creates a Amazon GameLift FleetIQ game server group for managing game hosting on a collection of Amazon Elastic Compute Cloud instances for game hosting. This operation creates the game server group, creates an Auto Scaling group in your Amazon Web Services account, and establishes a link between the two groups. You can view the status of your game server groups in the Amazon GameLift console. Game server group metrics and events are emitted to Amazon CloudWatch.

Before creating a new game server group, you must have the following:

  • An Amazon Elastic Compute Cloud launch template that specifies how to launch Amazon Elastic Compute Cloud instances with your game server build. For more information, see Launching an Instance from a Launch Template in the Amazon Elastic Compute Cloud User Guide.

  • An IAM role that extends limited access to your Amazon Web Services account to allow Amazon GameLift FleetIQ to create and interact with the Auto Scaling group. For more information, see Create IAM roles for cross-service interaction in the Amazon GameLift FleetIQ Developer Guide.

To create a new game server group, specify a unique group name, IAM role and Amazon Elastic Compute Cloud launch template, and provide a list of instance types that can be used in the group. You must also set initial maximum and minimum limits on the group's instance count. You can optionally set an Auto Scaling policy with target tracking based on a Amazon GameLift FleetIQ metric.

Once the game server group and corresponding Auto Scaling group are created, you have full access to change the Auto Scaling group's configuration as needed. Several properties that are set when creating a game server group, including maximum/minimum size and auto-scaling policy settings, must be updated directly in the Auto Scaling group. Keep in mind that some Auto Scaling group properties are periodically updated by Amazon GameLift FleetIQ as part of its balancing activities to optimize for availability and cost.

Learn more

Amazon GameLift FleetIQ Guide

Parameter Syntax

$result = $client->createGameServerGroup([
    'AutoScalingPolicy' => [
        'EstimatedInstanceWarmup' => <integer>,
        'TargetTrackingConfiguration' => [ // REQUIRED
            'TargetValue' => <float>, // REQUIRED
        ],
    ],
    'BalancingStrategy' => 'SPOT_ONLY|SPOT_PREFERRED|ON_DEMAND_ONLY',
    'GameServerGroupName' => '<string>', // REQUIRED
    'GameServerProtectionPolicy' => 'NO_PROTECTION|FULL_PROTECTION',
    'InstanceDefinitions' => [ // REQUIRED
        [
            'InstanceType' => 'c4.large|c4.xlarge|c4.2xlarge|c4.4xlarge|c4.8xlarge|c5.large|c5.xlarge|c5.2xlarge|c5.4xlarge|c5.9xlarge|c5.12xlarge|c5.18xlarge|c5.24xlarge|c5a.large|c5a.xlarge|c5a.2xlarge|c5a.4xlarge|c5a.8xlarge|c5a.12xlarge|c5a.16xlarge|c5a.24xlarge|c6g.medium|c6g.large|c6g.xlarge|c6g.2xlarge|c6g.4xlarge|c6g.8xlarge|c6g.12xlarge|c6g.16xlarge|r4.large|r4.xlarge|r4.2xlarge|r4.4xlarge|r4.8xlarge|r4.16xlarge|r5.large|r5.xlarge|r5.2xlarge|r5.4xlarge|r5.8xlarge|r5.12xlarge|r5.16xlarge|r5.24xlarge|r5a.large|r5a.xlarge|r5a.2xlarge|r5a.4xlarge|r5a.8xlarge|r5a.12xlarge|r5a.16xlarge|r5a.24xlarge|r6g.medium|r6g.large|r6g.xlarge|r6g.2xlarge|r6g.4xlarge|r6g.8xlarge|r6g.12xlarge|r6g.16xlarge|m4.large|m4.xlarge|m4.2xlarge|m4.4xlarge|m4.10xlarge|m5.large|m5.xlarge|m5.2xlarge|m5.4xlarge|m5.8xlarge|m5.12xlarge|m5.16xlarge|m5.24xlarge|m5a.large|m5a.xlarge|m5a.2xlarge|m5a.4xlarge|m5a.8xlarge|m5a.12xlarge|m5a.16xlarge|m5a.24xlarge|m6g.medium|m6g.large|m6g.xlarge|m6g.2xlarge|m6g.4xlarge|m6g.8xlarge|m6g.12xlarge|m6g.16xlarge', // REQUIRED
            'WeightedCapacity' => '<string>',
        ],
        // ...
    ],
    'LaunchTemplate' => [ // REQUIRED
        'LaunchTemplateId' => '<string>',
        'LaunchTemplateName' => '<string>',
        'Version' => '<string>',
    ],
    'MaxSize' => <integer>, // REQUIRED
    'MinSize' => <integer>, // REQUIRED
    'RoleArn' => '<string>', // REQUIRED
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'VpcSubnets' => ['<string>', ...],
]);

Parameter Details

Members
AutoScalingPolicy

Configuration settings to define a scaling policy for the Auto Scaling group that is optimized for game hosting. The scaling policy uses the metric "PercentUtilizedGameServers" to maintain a buffer of idle game servers that can immediately accommodate new games and players. After the Auto Scaling group is created, update this value directly in the Auto Scaling group using the Amazon Web Services console or APIs.

BalancingStrategy
Type: string

Indicates how Amazon GameLift FleetIQ balances the use of Spot Instances and On-Demand Instances in the game server group. Method options include the following:

  • SPOT_ONLY - Only Spot Instances are used in the game server group. If Spot Instances are unavailable or not viable for game hosting, the game server group provides no hosting capacity until Spot Instances can again be used. Until then, no new instances are started, and the existing nonviable Spot Instances are terminated (after current gameplay ends) and are not replaced.

  • SPOT_PREFERRED - (default value) Spot Instances are used whenever available in the game server group. If Spot Instances are unavailable, the game server group continues to provide hosting capacity by falling back to On-Demand Instances. Existing nonviable Spot Instances are terminated (after current gameplay ends) and are replaced with new On-Demand Instances.

  • ON_DEMAND_ONLY - Only On-Demand Instances are used in the game server group. No Spot Instances are used, even when available, while this balancing strategy is in force.

GameServerGroupName
Required: Yes
Type: string

An identifier for the new game server group. This value is used to generate unique ARN identifiers for the Amazon EC2 Auto Scaling group and the Amazon GameLift FleetIQ game server group. The name must be unique per Region per Amazon Web Services account.

GameServerProtectionPolicy
Type: string

A flag that indicates whether instances in the game server group are protected from early termination. Unprotected instances that have active game servers running might be terminated during a scale-down event, causing players to be dropped from the game. Protected instances cannot be terminated while there are active game servers running except in the event of a forced game server group deletion (see ). An exception to this is with Spot Instances, which can be terminated by Amazon Web Services regardless of protection status. This property is set to NO_PROTECTION by default.

InstanceDefinitions
Required: Yes
Type: Array of InstanceDefinition structures

The Amazon EC2 instance types and sizes to use in the Auto Scaling group. The instance definitions must specify at least two different instance types that are supported by Amazon GameLift FleetIQ. For more information on instance types, see EC2 Instance Types in the Amazon Elastic Compute Cloud User Guide. You can optionally specify capacity weighting for each instance type. If no weight value is specified for an instance type, it is set to the default value "1". For more information about capacity weighting, see Instance Weighting for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

LaunchTemplate
Required: Yes
Type: LaunchTemplateSpecification structure

The Amazon EC2 launch template that contains configuration settings and game server code to be deployed to all instances in the game server group. You can specify the template using either the template name or ID. For help with creating a launch template, see Creating a Launch Template for an Auto Scaling Group in the Amazon Elastic Compute Cloud Auto Scaling User Guide. After the Auto Scaling group is created, update this value directly in the Auto Scaling group using the Amazon Web Services console or APIs.

If you specify network interfaces in your launch template, you must explicitly set the property AssociatePublicIpAddress to "true". If no network interface is specified in the launch template, Amazon GameLift FleetIQ uses your account's default VPC.

MaxSize
Required: Yes
Type: int

The maximum number of instances allowed in the Amazon EC2 Auto Scaling group. During automatic scaling events, Amazon GameLift FleetIQ and EC2 do not scale up the group above this maximum. After the Auto Scaling group is created, update this value directly in the Auto Scaling group using the Amazon Web Services console or APIs.

MinSize
Required: Yes
Type: int

The minimum number of instances allowed in the Amazon EC2 Auto Scaling group. During automatic scaling events, Amazon GameLift FleetIQ and Amazon EC2 do not scale down the group below this minimum. In production, this value should be set to at least 1. After the Auto Scaling group is created, update this value directly in the Auto Scaling group using the Amazon Web Services console or APIs.

RoleArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) for an IAM role that allows Amazon GameLift to access your Amazon EC2 Auto Scaling groups.

Tags
Type: Array of Tag structures

A list of labels to assign to the new game server group resource. Tags are developer-defined key-value pairs. Tagging Amazon Web Services resources is useful for resource management, access management, and cost allocation. For more information, see Tagging Amazon Web Services Resources in the Amazon Web Services General Reference.

VpcSubnets
Type: Array of strings

A list of virtual private cloud (VPC) subnets to use with instances in the game server group. By default, all Amazon GameLift FleetIQ-supported Availability Zones are used. You can use this parameter to specify VPCs that you've set up. This property cannot be updated after the game server group is created, and the corresponding Auto Scaling group will always use the property value that is set with this request, even if the Auto Scaling group is updated directly.

Result Syntax

[
    'GameServerGroup' => [
        'AutoScalingGroupArn' => '<string>',
        'BalancingStrategy' => 'SPOT_ONLY|SPOT_PREFERRED|ON_DEMAND_ONLY',
        'CreationTime' => <DateTime>,
        'GameServerGroupArn' => '<string>',
        'GameServerGroupName' => '<string>',
        'GameServerProtectionPolicy' => 'NO_PROTECTION|FULL_PROTECTION',
        'InstanceDefinitions' => [
            [
                'InstanceType' => 'c4.large|c4.xlarge|c4.2xlarge|c4.4xlarge|c4.8xlarge|c5.large|c5.xlarge|c5.2xlarge|c5.4xlarge|c5.9xlarge|c5.12xlarge|c5.18xlarge|c5.24xlarge|c5a.large|c5a.xlarge|c5a.2xlarge|c5a.4xlarge|c5a.8xlarge|c5a.12xlarge|c5a.16xlarge|c5a.24xlarge|c6g.medium|c6g.large|c6g.xlarge|c6g.2xlarge|c6g.4xlarge|c6g.8xlarge|c6g.12xlarge|c6g.16xlarge|r4.large|r4.xlarge|r4.2xlarge|r4.4xlarge|r4.8xlarge|r4.16xlarge|r5.large|r5.xlarge|r5.2xlarge|r5.4xlarge|r5.8xlarge|r5.12xlarge|r5.16xlarge|r5.24xlarge|r5a.large|r5a.xlarge|r5a.2xlarge|r5a.4xlarge|r5a.8xlarge|r5a.12xlarge|r5a.16xlarge|r5a.24xlarge|r6g.medium|r6g.large|r6g.xlarge|r6g.2xlarge|r6g.4xlarge|r6g.8xlarge|r6g.12xlarge|r6g.16xlarge|m4.large|m4.xlarge|m4.2xlarge|m4.4xlarge|m4.10xlarge|m5.large|m5.xlarge|m5.2xlarge|m5.4xlarge|m5.8xlarge|m5.12xlarge|m5.16xlarge|m5.24xlarge|m5a.large|m5a.xlarge|m5a.2xlarge|m5a.4xlarge|m5a.8xlarge|m5a.12xlarge|m5a.16xlarge|m5a.24xlarge|m6g.medium|m6g.large|m6g.xlarge|m6g.2xlarge|m6g.4xlarge|m6g.8xlarge|m6g.12xlarge|m6g.16xlarge',
                'WeightedCapacity' => '<string>',
            ],
            // ...
        ],
        'LastUpdatedTime' => <DateTime>,
        'RoleArn' => '<string>',
        'Status' => 'NEW|ACTIVATING|ACTIVE|DELETE_SCHEDULED|DELETING|DELETED|ERROR',
        'StatusReason' => '<string>',
        'SuspendedActions' => ['<string>', ...],
    ],
]

Result Details

Members
GameServerGroup
Type: GameServerGroup structure

The newly created game server group object, including the new ARN value for the Amazon GameLift FleetIQ game server group and the object's status. The Amazon EC2 Auto Scaling group ARN is initially null, since the group has not yet been created. This value is added once the game server group status reaches ACTIVE.

Errors

InvalidRequestException:

One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

ConflictException:

The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request.

UnauthorizedException:

The client failed authentication. Clients should not retry such requests.

InternalServiceException:

The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

LimitExceededException:

The requested operation would cause the resource to exceed the allowed service limit. Resolve the issue before retrying.

CreateGameSession

$result = $client->createGameSession([/* ... */]);
$promise = $client->createGameSessionAsync([/* ... */]);

Creates a multiplayer game session for players in a specific fleet location. This operation prompts an available server process to start a game session and retrieves connection information for the new game session. As an alternative, consider using the Amazon GameLift game session placement feature with StartGameSessionPlacement , which uses the FleetIQ algorithm and queues to optimize the placement process.

When creating a game session, you specify exactly where you want to place it and provide a set of game session configuration settings. The target fleet must be in ACTIVE status.

You can use this operation in the following ways:

  • To create a game session on an instance in a fleet's home Region, provide a fleet or alias ID along with your game session configuration.

  • To create a game session on an instance in a fleet's remote location, provide a fleet or alias ID and a location name, along with your game session configuration.

  • To create a game session on an instance in an Anywhere fleet, specify the fleet's custom location.

If successful, Amazon GameLift initiates a workflow to start a new game session and returns a GameSession object containing the game session configuration and status. When the game session status is ACTIVE, it is updated with connection information and you can create player sessions for the game session. By default, newly created game sessions are open to new players. You can restrict new player access by using UpdateGameSession to change the game session's player session creation policy.

Amazon GameLift retains logs for active for 14 days. To access the logs, call GetGameSessionLogUrl to download the log files.

Available in Amazon GameLift Local.

Learn more

Start a game session

All APIs by task

Parameter Syntax

$result = $client->createGameSession([
    'AliasId' => '<string>',
    'CreatorId' => '<string>',
    'FleetId' => '<string>',
    'GameProperties' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'GameSessionData' => '<string>',
    'GameSessionId' => '<string>',
    'IdempotencyToken' => '<string>',
    'Location' => '<string>',
    'MaximumPlayerSessionCount' => <integer>, // REQUIRED
    'Name' => '<string>',
]);

Parameter Details

Members
AliasId
Type: string

A unique identifier for the alias associated with the fleet to create a game session in. You can use either the alias ID or ARN value. Each request must reference either a fleet ID or alias ID, but not both.

CreatorId
Type: string

A unique identifier for a player or entity creating the game session.

If you add a resource creation limit policy to a fleet, the CreateGameSession operation requires a CreatorId. Amazon GameLift limits the number of game session creation requests with the same CreatorId in a specified time period.

If you your fleet doesn't have a resource creation limit policy and you provide a CreatorId in your CreateGameSession requests, Amazon GameLift limits requests to one request per CreatorId per second.

To not limit CreateGameSession requests with the same CreatorId, don't provide a CreatorId in your CreateGameSession request.

FleetId
Type: string

A unique identifier for the fleet to create a game session in. You can use either the fleet ID or ARN value. Each request must reference either a fleet ID or alias ID, but not both.

GameProperties
Type: Array of GameProperty structures

A set of key-value pairs that can store custom data in a game session. For example: {"Key": "difficulty", "Value": "novice"}. For an example, see Create a game session with custom properties.

GameSessionData
Type: string

A set of custom game session properties, formatted as a single string value. This data is passed to a game server process with a request to start a new game session (see Start a Game Session).

GameSessionId
Type: string

This parameter is deprecated. Use IdempotencyToken instead.

Custom string that uniquely identifies a request for a new game session. Maximum token length is 48 characters. If provided, this string is included in the new game session's ID.

IdempotencyToken
Type: string

Custom string that uniquely identifies the new game session request. This is useful for ensuring that game session requests with the same idempotency token are processed only once. Subsequent requests with the same string return the original GameSession object, with an updated status. Maximum token length is 48 characters. If provided, this string is included in the new game session's ID. A game session ARN has the following format: arn:aws:gamelift:<region>::gamesession/<fleet ID>/<custom ID string or idempotency token>. Idempotency tokens remain in use for 30 days after a game session has ended; game session objects are retained for this time period and then deleted.

Location
Type: string

A fleet's remote location to place the new game session in. If this parameter is not set, the new game session is placed in the fleet's home Region. Specify a remote location with an Amazon Web Services Region code such as us-west-2. When using an Anywhere fleet, this parameter is required and must be set to the Anywhere fleet's custom location.

MaximumPlayerSessionCount
Required: Yes
Type: int

The maximum number of players that can be connected simultaneously to the game session.

Name
Type: string

A descriptive label that is associated with a game session. Session names do not need to be unique.

Result Syntax

[
    'GameSession' => [
        'CreationTime' => <DateTime>,
        'CreatorId' => '<string>',
        'CurrentPlayerSessionCount' => <integer>,
        'DnsName' => '<string>',
        'FleetArn' => '<string>',
        'FleetId' => '<string>',
        'GameProperties' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
        'GameSessionData' => '<string>',
        'GameSessionId' => '<string>',
        'IpAddress' => '<string>',
        'Location' => '<string>',
        'MatchmakerData' => '<string>',
        'MaximumPlayerSessionCount' => <integer>,
        'Name' => '<string>',
        'PlayerSessionCreationPolicy' => 'ACCEPT_ALL|DENY_ALL',
        'Port' => <integer>,
        'Status' => 'ACTIVE|ACTIVATING|TERMINATED|TERMINATING|ERROR',
        'StatusReason' => 'INTERRUPTED',
        'TerminationTime' => <DateTime>,
    ],
]

Result Details

Members
GameSession
Type: GameSession structure

Object that describes the newly created game session record.

Errors

ConflictException:

The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request.

InternalServiceException:

The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

UnauthorizedException:

The client failed authentication. Clients should not retry such requests.

InvalidFleetStatusException:

The requested operation would cause a conflict with the current state of a resource associated with the request and/or the fleet. Resolve the conflict before retrying.

TerminalRoutingStrategyException:

The service is unable to resolve the routing for a particular alias because it has a terminal RoutingStrategy associated with it. The message returned in this exception is the message defined in the routing strategy itself. Such requests should only be retried if the routing strategy for the specified alias is modified.

InvalidRequestException:

One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

NotFoundException:

THe requested resources was not found. The resource was either not created yet or deleted.

FleetCapacityExceededException:

The specified fleet has no available instances to fulfill a CreateGameSession request. Clients can retry such requests immediately or after a waiting period.

LimitExceededException:

The requested operation would cause the resource to exceed the allowed service limit. Resolve the issue before retrying.

IdempotentParameterMismatchException:

A game session with this custom ID string already exists in this fleet. Resolve this conflict before retrying this request.

UnsupportedRegionException:

The requested operation is not supported in the Region specified.

CreateGameSessionQueue

$result = $client->createGameSessionQueue([/* ... */]);
$promise = $client->createGameSessionQueueAsync([/* ... */]);

Creates a placement queue that processes requests for new game sessions. A queue uses FleetIQ algorithms to determine the best placement locations and find an available game server there, then prompts the game server process to start a new game session.

A game session queue is configured with a set of destinations (Amazon GameLift fleets or aliases), which determine the locations where the queue can place new game sessions. These destinations can span multiple fleet types (Spot and On-Demand), instance types, and Amazon Web Services Regions. If the queue includes multi-location fleets, the queue is able to place game sessions in all of a fleet's remote locations. You can opt to filter out individual locations if needed.

The queue configuration also determines how FleetIQ selects the best available placement for a new game session. Before searching for an available game server, FleetIQ first prioritizes the queue's destinations and locations, with the best placement locations on top. You can set up the queue to use the FleetIQ default prioritization or provide an alternate set of priorities.

To create a new queue, provide a name, timeout value, and a list of destinations. Optionally, specify a sort configuration and/or a filter, and define a set of latency cap policies. You can also include the ARN for an Amazon Simple Notification Service (SNS) topic to receive notifications of game session placement activity. Notifications using SNS or CloudWatch events is the preferred way to track placement activity.

If successful, a new GameSessionQueue object is returned with an assigned queue ARN. New game session requests, which are submitted to queue with StartGameSessionPlacement or StartMatchmaking, reference a queue's name or ARN.

Learn more

Design a game session queue

Create a game session queue

Related actions

CreateGameSessionQueue | DescribeGameSessionQueues | UpdateGameSessionQueue | DeleteGameSessionQueue | All APIs by task

Parameter Syntax

$result = $client->createGameSessionQueue([
    'CustomEventData' => '<string>',
    'Destinations' => [
        [
            'DestinationArn' => '<string>',
        ],
        // ...
    ],
    'FilterConfiguration' => [
        'AllowedLocations' => ['<string>', ...],
    ],
    'Name' => '<string>', // REQUIRED
    'NotificationTarget' => '<string>',
    'PlayerLatencyPolicies' => [
        [
            'MaximumIndividualPlayerLatencyMilliseconds' => <integer>,
            'PolicyDurationSeconds' => <integer>,
        ],
        // ...
    ],
    'PriorityConfiguration' => [
        'LocationOrder' => ['<string>', ...],
        'PriorityOrder' => ['<string>', ...],
    ],
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'TimeoutInSeconds' => <integer>,
]);

Parameter Details

Members
CustomEventData
Type: string

Information to be added to all events that are related to this game session queue.

Destinations
Type: Array of GameSessionQueueDestination structures

A list of fleets and/or fleet aliases that can be used to fulfill game session placement requests in the queue. Destinations are identified by either a fleet ARN or a fleet alias ARN, and are listed in order of placement preference.

FilterConfiguration
Type: FilterConfiguration structure

A list of locations where a queue is allowed to place new game sessions. Locations are specified in the form of Amazon Web Services Region codes, such as us-west-2. If this parameter is not set, game sessions can be placed in any queue location.

Name
Required: Yes
Type: string

A descriptive label that is associated with game session queue. Queue names must be unique within each Region.

NotificationTarget
Type: string

An SNS topic ARN that is set up to receive game session placement notifications. See Setting up notifications for game session placement.

PlayerLatencyPolicies
Type: Array of PlayerLatencyPolicy structures

A set of policies that act as a sliding cap on player latency. FleetIQ works to deliver low latency for most players in a game session. These policies ensure that no individual player can be placed into a game with unreasonably high latency. Use multiple policies to gradually relax latency requirements a step at a time. Multiple policies are applied based on their maximum allowed latency, starting with the lowest value.

PriorityConfiguration
Type: PriorityConfiguration structure

Custom settings to use when prioritizing destinations and locations for game session placements. This configuration replaces the FleetIQ default prioritization process. Priority types that are not explicitly named will be automatically applied at the end of the prioritization process.

Tags
Type: Array of Tag structures

A list of labels to assign to the new game session queue resource. Tags are developer-defined key-value pairs. Tagging Amazon Web Services resources are useful for resource management, access management and cost allocation. For more information, see Tagging Amazon Web Services Resources in the Amazon Web Services General Reference.

TimeoutInSeconds
Type: int

The maximum time, in seconds, that a new game session placement request remains in the queue. When a request exceeds this time, the game session placement changes to a TIMED_OUT status. By default, this property is set to 600.

Result Syntax

[
    'GameSessionQueue' => [
        'CustomEventData' => '<string>',
        'Destinations' => [
            [
                'DestinationArn' => '<string>',
            ],
            // ...
        ],
        'FilterConfiguration' => [
            'AllowedLocations' => ['<string>', ...],
        ],
        'GameSessionQueueArn' => '<string>',
        'Name' => '<string>',
        'NotificationTarget' => '<string>',
        'PlayerLatencyPolicies' => [
            [
                'MaximumIndividualPlayerLatencyMilliseconds' => <integer>,
                'PolicyDurationSeconds' => <integer>,
            ],
            // ...
        ],
        'PriorityConfiguration' => [
            'LocationOrder' => ['<string>', ...],
            'PriorityOrder' => ['<string>', ...],
        ],
        'TimeoutInSeconds' => <integer>,
    ],
]

Result Details

Members
GameSessionQueue
Type: GameSessionQueue structure

An object that describes the newly created game session queue.

Errors

InternalServiceException:

The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

InvalidRequestException:

One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

UnauthorizedException:

The client failed authentication. Clients should not retry such requests.

LimitExceededException:

The requested operation would cause the resource to exceed the allowed service limit. Resolve the issue before retrying.

NotFoundException:

THe requested resources was not found. The resource was either not created yet or deleted.

TaggingFailedException:

The requested tagging operation did not succeed. This may be due to invalid tag format or the maximum tag limit may have been exceeded. Resolve the issue before retrying.

CreateLocation

$result = $client->createLocation([/* ... */]);
$promise = $client->createLocationAsync([/* ... */]);

Creates a custom location for use in an Anywhere fleet.

Parameter Syntax

$result = $client->createLocation([
    'LocationName' => '<string>', // REQUIRED
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Members
LocationName
Required: Yes
Type: string

A descriptive name for the custom location.

Tags
Type: Array of Tag structures

A list of labels to assign to the new matchmaking configuration resource. Tags are developer-defined key-value pairs. Tagging Amazon Web Services resources are useful for resource management, access management and cost allocation. For more information, see Tagging Amazon Web Services Resources in the Amazon Web Services General Rareference.

Result Syntax

[
    'Location' => [
        'LocationArn' => '<string>',
        'LocationName' => '<string>',
    ],
]

Result Details

Members
Location
Type: LocationModel structure

The details of the custom location you created.

Errors

UnauthorizedException:

The client failed authentication. Clients should not retry such requests.

InvalidRequestException:

One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

LimitExceededException:

The requested operation would cause the resource to exceed the allowed service limit. Resolve the issue before retrying.

ConflictException:

The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request.

TaggingFailedException:

The requested tagging operation did not succeed. This may be due to invalid tag format or the maximum tag limit may have been exceeded. Resolve the issue before retrying.

InternalServiceException:

The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

CreateMatchmakingConfiguration

$result = $client->createMatchmakingConfiguration([/* ... */]);
$promise = $client->createMatchmakingConfigurationAsync([/* ... */]);

Defines a new matchmaking configuration for use with FlexMatch. Whether your are using FlexMatch with Amazon GameLift hosting or as a standalone matchmaking service, the matchmaking configuration sets out rules for matching players and forming teams. If you're also using Amazon GameLift hosting, it defines how to start game sessions for each match. Your matchmaking system can use multiple configurations to handle different game scenarios. All matchmaking requests identify the matchmaking configuration to use and provide player attributes consistent with that configuration.

To create a matchmaking configuration, you must provide the following: configuration name and FlexMatch mode (with or without Amazon GameLift hosting); a rule set that specifies how to evaluate players and find acceptable matches; whether player acceptance is required; and the maximum time allowed for a matchmaking attempt. When using FlexMatch with Amazon GameLift hosting, you also need to identify the game session queue to use when starting a game session for the match.

In addition, you must set up an Amazon Simple Notification Service topic to receive matchmaking notifications. Provide the topic ARN in the matchmaking configuration.

Learn more

Design a FlexMatch matchmaker

Set up FlexMatch event notification

Parameter Syntax

$result = $client->createMatchmakingConfiguration([
    'AcceptanceRequired' => true || false, // REQUIRED
    'AcceptanceTimeoutSeconds' => <integer>,
    'AdditionalPlayerCount' => <integer>,
    'BackfillMode' => 'AUTOMATIC|MANUAL',
    'CustomEventData' => '<string>',
    'Description' => '<string>',
    'FlexMatchMode' => 'STANDALONE|WITH_QUEUE',
    'GameProperties' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'GameSessionData' => '<string>',
    'GameSessionQueueArns' => ['<string>', ...],
    'Name' => '<string>', // REQUIRED
    'NotificationTarget' => '<string>',
    'RequestTimeoutSeconds' => <integer>, // REQUIRED
    'RuleSetName' => '<string>', // REQUIRED
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Members
AcceptanceRequired
Required: Yes
Type: boolean

A flag that determines whether a match that was created with this configuration must be accepted by the matched players. To require acceptance, set to TRUE. With this option enabled, matchmaking tickets use the status REQUIRES_ACCEPTANCE to indicate when a completed potential match is waiting for player acceptance.

AcceptanceTimeoutSeconds
Type: int

The length of time (in seconds) to wait for players to accept a proposed match, if acceptance is required.

AdditionalPlayerCount
Type: int

The number of player slots in a match to keep open for future players. For example, if the configuration's rule set specifies a match for a single 10-person team, and the additional player count is set to 2, 10 players will be selected for the match and 2 more player slots will be open for future players. This parameter is not used if FlexMatchMode is set to STANDALONE.

BackfillMode
Type: string

The method used to backfill game sessions that are created with this matchmaking configuration. Specify MANUAL when your game manages backfill requests manually or does not use the match backfill feature. Specify AUTOMATIC to have Amazon GameLift create a backfill request whenever a game session has one or more open slots. Learn more about manual and automatic backfill in Backfill Existing Games with FlexMatch. Automatic backfill is not available when FlexMatchMode is set to STANDALONE.

CustomEventData
Type: string

Information to be added to all events related to this matchmaking configuration.

Description
Type: string

A human-readable description of the matchmaking configuration.

FlexMatchMode
Type: string

Indicates whether this matchmaking configuration is being used with Amazon GameLift hosting or as a standalone matchmaking solution.

  • STANDALONE - FlexMatch forms matches and returns match information, including players and team assignments, in a MatchmakingSucceeded event.

  • WITH_QUEUE - FlexMatch forms matches and uses the specified Amazon GameLift queue to start a game session for the match.

GameProperties
Type: Array of GameProperty structures

A set of key-value pairs that can store custom data in a game session. For example: {"Key": "difficulty", "Value": "novice"}. This information is added to the new GameSession object that is created for a successful match. This parameter is not used if FlexMatchMode is set to STANDALONE.

GameSessionData
Type: string

A set of custom game session properties, formatted as a single string value. This data is passed to a game server process with a request to start a new game session (see Start a Game Session). This information is added to the new GameSession object that is created for a successful match. This parameter is not used if FlexMatchMode is set to STANDALONE.

GameSessionQueueArns
Type: Array of strings

The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift game session queue resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::gamesessionqueue/<queue name>. Queues can be located in any Region. Queues are used to start new Amazon GameLift-hosted game sessions for matches that are created with this matchmaking configuration. If FlexMatchMode is set to STANDALONE, do not set this parameter.

Name
Required: Yes
Type: string

A unique identifier for the matchmaking configuration. This name is used to identify the configuration associated with a matchmaking request or ticket.

NotificationTarget
Type: string

An SNS topic ARN that is set up to receive matchmaking notifications. See Setting up notifications for matchmaking for more information.

RequestTimeoutSeconds
Required: Yes
Type: int

The maximum duration, in seconds, that a matchmaking ticket can remain in process before timing out. Requests that fail due to timing out can be resubmitted as needed.

RuleSetName
Required: Yes
Type: string

A unique identifier for the matchmaking rule set to use with this configuration. You can use either the rule set name or ARN value. A matchmaking configuration can only use rule sets that are defined in the same Region.

Tags
Type: Array of Tag structures

A list of labels to assign to the new matchmaking configuration resource. Tags are developer-defined key-value pairs. Tagging Amazon Web Services resources are useful for resource management, access management and cost allocation. For more information, see Tagging Amazon Web Services Resources in the Amazon Web Services General Reference.

Result Syntax

[
    'Configuration' => [
        'AcceptanceRequired' => true || false,
        'AcceptanceTimeoutSeconds' => <integer>,
        'AdditionalPlayerCount' => <integer>,
        'BackfillMode' => 'AUTOMATIC|MANUAL',
        'ConfigurationArn' => '<string>',
        'CreationTime' => <DateTime>,
        'CustomEventData' => '<string>',
        'Description' => '<string>',
        'FlexMatchMode' => 'STANDALONE|WITH_QUEUE',
        'GameProperties' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
        'GameSessionData' => '<string>',
        'GameSessionQueueArns' => ['<string>', ...],
        'Name' => '<string>',
        'NotificationTarget' => '<string>',
        'RequestTimeoutSeconds' => <integer>,
        'RuleSetArn' => '<string>',
        'RuleSetName' => '<string>',
    ],
]

Result Details

Members
Configuration
Type: MatchmakingConfiguration structure

Object that describes the newly created matchmaking configuration.

Errors

InvalidRequestException:

One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

LimitExceededException:

The requested operation would cause the resource to exceed the allowed service limit. Resolve the issue before retrying.

NotFoundException:

THe requested resources was not found. The resource was either not created yet or deleted.

InternalServiceException:

The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

UnsupportedRegionException:

The requested operation is not supported in the Region specified.

TaggingFailedException:

The requested tagging operation did not succeed. This may be due to invalid tag format or the maximum tag limit may have been exceeded. Resolve the issue before retrying.

CreateMatchmakingRuleSet

$result = $client->createMatchmakingRuleSet([/* ... */]);
$promise = $client->createMatchmakingRuleSetAsync([/* ... */]);

Creates a new rule set for FlexMatch matchmaking. A rule set describes the type of match to create, such as the number and size of teams. It also sets the parameters for acceptable player matches, such as minimum skill level or character type.

To create a matchmaking rule set, provide unique rule set name and the rule set body in JSON format. Rule sets must be defined in the same Region as the matchmaking configuration they are used with.

Since matchmaking rule sets cannot be edited, it is a good idea to check the rule set syntax using ValidateMatchmakingRuleSet before creating a new rule set.

Learn more

Parameter Syntax

$result = $client->createMatchmakingRuleSet([
    'Name' => '<string>', // REQUIRED
    'RuleSetBody' => '<string>', // REQUIRED
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Members
Name
Required: Yes
Type: string

A unique identifier for the matchmaking rule set. A matchmaking configuration identifies the rule set it uses by this name value. Note that the rule set name is different from the optional name field in the rule set body.

RuleSetBody
Required: Yes
Type: string

A collection of matchmaking rules, formatted as a JSON string. Comments are not allowed in JSON, but most elements support a description field.

Tags
Type: Array of Tag structures

A list of labels to assign to the new matchmaking rule set resource. Tags are developer-defined key-value pairs. Tagging Amazon Web Services resources are useful for resource management, access management and cost allocation. For more information, see Tagging Amazon Web Services Resources in the Amazon Web Services General Reference.

Result Syntax

[
    'RuleSet' => [
        'CreationTime' => <DateTime>,
        'RuleSetArn' => '<string>',
        'RuleSetBody' => '<string>',
        'RuleSetName' => '<string>',
    ],
]

Result Details

Members
RuleSet
Required: Yes
Type: MatchmakingRuleSet structure

The newly created matchmaking rule set.

Errors

InvalidRequestException:

One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

LimitExceededException:

The requested operation would cause the resource to exceed the allowed service limit. Resolve the issue before retrying.

InternalServiceException:

The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

UnsupportedRegionException:

The requested operation is not supported in the Region specified.

TaggingFailedException:

The requested tagging operation did not succeed. This may be due to invalid tag format or the maximum tag limit may have been exceeded. Resolve the issue before retrying.

CreatePlayerSession

$result = $client->createPlayerSession([/* ... */]);
$promise = $client->createPlayerSessionAsync([/* ... */]);

Reserves an open player slot in a game session for a player. New player sessions can be created in any game session with an open slot that is in ACTIVE status and has a player creation policy of ACCEPT_ALL. You can add a group of players to a game session with CreatePlayerSessions .

To create a player session, specify a game session ID, player ID, and optionally a set of player data.

If successful, a slot is reserved in the game session for the player and a new PlayerSessions object is returned with a player session ID. The player references the player session ID when sending a connection request to the game session, and the game server can use it to validate the player reservation with the Amazon GameLift service. Player sessions cannot be updated.

The maximum number of players per game session is 200. It is not adjustable.

Related actions

All APIs by task

Parameter Syntax

$result = $client->createPlayerSession([
    'GameSessionId' => '<string>', // REQUIRED
    'PlayerData' => '<string>',
    'PlayerId' => '<string>', // REQUIRED
]);

Parameter Details

Members
GameSessionId
Required: Yes
Type: string

A unique identifier for the game session to add a player to.

PlayerData
Type: string

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.

PlayerId
Required: Yes
Type: string

A unique identifier for a player. Player IDs are developer-defined.

Result Syntax

[
    'PlayerSession' => [
        'CreationTime' => <DateTime>,
        'DnsName' => '<string>',
        'FleetArn' => '<string>',
        'FleetId' => '<string>',
        'GameSessionId' => '<string>',
        'IpAddress' => '<string>',
        'PlayerData' => '<string>',
        'PlayerId' => '<string>',
        'PlayerSessionId' => '<string>',
        'Port' => <integer>,
        'Status' => 'RESERVED|ACTIVE|COMPLETED|TIMEDOUT',
        'TerminationTime' => <DateTime>,
    ],
]

Result Details

Members
PlayerSession
Type: PlayerSession structure

Object that describes the newly created player session record.

Errors

InternalServiceException:

The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

UnauthorizedException:

The client failed authentication. Clients should not retry such requests.

InvalidGameSessionStatusException:

The requested operation would cause a conflict with the current state of a resource associated with the request and/or the game instance. Resolve the conflict before retrying.

GameSessionFullException:

The game instance is currently full and cannot allow the requested player(s) to join. Clients can retry such requests immediately or after a waiting period.

TerminalRoutingStrategyException:

The service is unable to resolve the routing for a particular alias because it has a terminal RoutingStrategy associated with it. The message returned in this exception is the message defined in the routing strategy itself. Such requests should only be retried if the routing strategy for the specified alias is modified.

InvalidRequestException:

One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

NotFoundException:

THe requested resources was not found. The resource was either not created yet or deleted.

CreatePlayerSessions

$result = $client->createPlayerSessions([/* ... */]);
$promise = $client->createPlayerSessionsAsync([/* ... */]);

Reserves open slots in a game session for a group of players. New player sessions can be created in any game session with an open slot that is in ACTIVE status and has a player creation policy of ACCEPT_ALL. To add a single player to a game session, use CreatePlayerSession

To create player sessions, specify a game session ID and a list of player IDs. Optionally, provide a set of player data for each player ID.

If successful, a slot is reserved in the game session for each player, and new PlayerSession objects are returned with player session IDs. Each player references their player session ID when sending a connection request to the game session, and the game server can use it to validate the player reservation with the Amazon GameLift service. Player sessions cannot be updated.

The maximum number of players per game session is 200. It is not adjustable.

Related actions

All APIs by task

Parameter Syntax

$result = $client->createPlayerSessions([
    'GameSessionId' => '<string>', // REQUIRED
    'PlayerDataMap' => ['<string>', ...],
    'PlayerIds' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members
GameSessionId
Required: Yes
Type: string

A unique identifier for the game session to add players to.

PlayerDataMap
Type: Associative array of custom strings keys (NonZeroAndMaxString) to strings

Map of string pairs, each specifying a player ID and a set of developer-defined information related to the player. Amazon GameLift does not use this data, so it can be formatted as needed for use in the game. Any player data strings for player IDs that are not included in the PlayerIds parameter are ignored.

PlayerIds
Required: Yes
Type: Array of strings

List of unique identifiers for the players to be added.

Result Syntax

[
    'PlayerSessions' => [
        [
            'CreationTime' => <DateTime>,
            'DnsName' => '<string>',
            'FleetArn' => '<string>',
            'FleetId' => '<string>',
            'GameSessionId' => '<string>',
            'IpAddress' => '<string>',
            'PlayerData' => '<string>',
            'PlayerId' => '<string>',
            'PlayerSessionId' => '<string>',
            'Port' => <integer>,
            'Status' => 'RESERVED|ACTIVE|COMPLETED|TIMEDOUT',
            'TerminationTime' => <DateTime>,
        ],
        // ...
    ],
]

Result Details

Members
PlayerSessions
Type: Array of PlayerSession structures

A collection of player session objects created for the added players.

Errors

InternalServiceException:

The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

UnauthorizedException:

The client failed authentication. Clients should not retry such requests.

InvalidGameSessionStatusException:

The requested operation would cause a conflict with the current state of a resource associated with the request and/or the game instance. Resolve the conflict before retrying.

GameSessionFullException:

The game instance is currently full and cannot allow the requested player(s) to join. Clients can retry such requests immediately or after a waiting period.

TerminalRoutingStrategyException:

The service is unable to resolve the routing for a particular alias because it has a terminal RoutingStrategy associated with it. The message returned in this exception is the message defined in the routing strategy itself. Such requests should only be retried if the routing strategy for the specified alias is modified.

InvalidRequestException:

One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

NotFoundException:

THe requested resources was not found. The resource was either not created yet or deleted.

CreateScript

$result = $client->createScript([/* ... */]);
$promise = $client->createScriptAsync([/* ... */]);

Creates a new script record for your Realtime Servers script. Realtime scripts are JavaScript that provide configuration settings and optional custom game logic for your game. The script is deployed when you create a Realtime Servers fleet to host your game sessions. Script logic is executed during an active game session.

To create a new script record, specify a script name and provide the script file(s). The script files and all dependencies must be zipped into a single file. You can pull the zip file from either of these locations:

  • A locally available directory. Use the ZipFile parameter for this option.

  • An Amazon Simple Storage Service (Amazon S3) bucket under your Amazon Web Services account. Use the StorageLocation parameter for this option. You'll need to have an Identity Access Management (IAM) role that allows the Amazon GameLift service to access your S3 bucket.

If the call is successful, a new script record is created with a unique script ID. If the script file is provided as a local file, the file is uploaded to an Amazon GameLift-owned S3 bucket and the script record's storage location reflects this location. If the script file is provided as an S3 bucket, Amazon GameLift accesses the file at this storage location as needed for deployment.

Learn more

Amazon GameLift Realtime Servers

Set Up a Role for Amazon GameLift Access

Related actions

All APIs by task

Parameter Syntax

$result = $client->createScript([
    'Name' => '<string>',
    'StorageLocation' => [
        'Bucket' => '<string>',
        'Key' => '<string>',
        'ObjectVersion' => '<string>',
        'RoleArn' => '<string>',
    ],
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'Version' => '<string>',
    'ZipFile' => <string || resource || Psr\Http\Message\StreamInterface>,
]);

Parameter Details

Members
Name
Type: string

A descriptive label that is associated with a script. Script names don't need to be unique. You can use UpdateScript to change this value later.

StorageLocation
Type: S3Location structure

The location of the Amazon S3 bucket where a zipped file containing your Realtime scripts is stored. The storage location must specify the Amazon S3 bucket name, the zip file name (the "key"), and a role ARN that allows Amazon GameLift to access the Amazon S3 storage location. The S3 bucket must be in the same Region where you want to create a new script. By default, Amazon GameLift uploads the latest version of the zip file; if you have S3 object versioning turned on, you can use the ObjectVersion parameter to specify an earlier version.

Tags
Type: Array of Tag structures

A list of labels to assign to the new script resource. Tags are developer-defined key-value pairs. Tagging Amazon Web Services resources are useful for resource management, access management and cost allocation. For more information, see Tagging Amazon Web Services Resources in the Amazon Web Services General Reference. Once the resource is created, you can use TagResource, UntagResource, and ListTagsForResource to add, remove, and view tags. The maximum tag limit may be lower than stated. See the Amazon Web Services General Reference for actual tagging limits.

Version
Type: string

Version information associated with a build or script. Version strings don't need to be unique. You can use UpdateScript to change this value later.

ZipFile
Type: blob (string|resource|Psr\Http\Message\StreamInterface)

A data object containing your Realtime scripts and dependencies as a zip file. The zip file can have one or multiple files. Maximum size of a zip file is 5 MB.

When using the Amazon Web Services CLI tool to create a script, this parameter is set to the zip file name. It must be prepended with the string "fileb://" to indicate that the file data is a binary object. For example: --zip-file fileb://myRealtimeScript.zip.

Result Syntax

[
    'Script' => [
        'CreationTime' => <DateTime>,
        'Name' => '<string>',
        'ScriptArn' => '<string>',
        'ScriptId' => '<string>',
        'SizeOnDisk' => <integer>,
        'StorageLocation' => [
            'Bucket' => '<string>',
            'Key' => '<string>',
            'ObjectVersion' => '<string>',
            'RoleArn' => '<string>',
        ],
        'Version' => '<string>',
    ],
]

Result Details

Members
Script
Type: Script structure

The newly created script record with a unique script ID and ARN. The new script's storage location reflects an Amazon S3 location: (1) If the script was uploaded from an S3 bucket under your account, the storage location reflects the information that was provided in the CreateScript request; (2) If the script file was uploaded from a local zip file, the storage location reflects an S3 location controls by the Amazon GameLift service.

Errors

UnauthorizedException:

The client failed authentication. Clients should not retry such requests.

InvalidRequestException:

One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

ConflictException:

The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request.

TaggingFailedException:

The requested tagging operation did not succeed. This may be due to invalid tag format or the maximum tag limit may have been exceeded. Resolve the issue before retrying.

InternalServiceException:

The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

CreateVpcPeeringAuthorization

$result = $client->createVpcPeeringAuthorization([/* ... */]);
$promise = $client->createVpcPeeringAuthorizationAsync([/* ... */]);

Requests authorization to create or delete a peer connection between the VPC for your Amazon GameLift fleet and a virtual private cloud (VPC) in your Amazon Web Services account. VPC peering enables the game servers on your fleet to communicate directly with other Amazon Web Services resources. After you've received authorization, use CreateVpcPeeringConnection to establish the peering connection. For more information, see VPC Peering with Amazon GameLift Fleets.

You can peer with VPCs that are owned by any Amazon Web Services account you have access to, including the account that you use to manage your Amazon GameLift fleets. You cannot peer with VPCs that are in different Regions.

To request authorization to create a connection, call this operation from the Amazon Web Services account with the VPC that you want to peer to your Amazon GameLift fleet. For example, to enable your game servers to retrieve data from a DynamoDB table, use the account that manages that DynamoDB resource. Identify the following values: (1) The ID of the VPC that you want to peer with, and (2) the ID of the Amazon Web Services account that you use to manage Amazon GameLift. If successful, VPC peering is authorized for the specified VPC.

To request authorization to delete a connection, call this operation from the Amazon Web Services account with the VPC that is peered with your Amazon GameLift fleet. Identify the following values: (1) VPC ID that you want to delete the peering connection for, and (2) ID of the Amazon Web Services account that you use to manage Amazon GameLift.

The authorization remains valid for 24 hours unless it is canceled. You must create or delete the peering connection while the authorization is valid.

Related actions

All APIs by task

Parameter Syntax

$result = $client->createVpcPeeringAuthorization([
    'GameLiftAwsAccountId' => '<string>', // REQUIRED
    'PeerVpcId' => '<string>', // REQUIRED
]);

Parameter Details

Members
GameLiftAwsAccountId
Required: Yes
Type: string

A unique identifier for the Amazon Web Services account that you use to manage your Amazon GameLift fleet. You can find your Account ID in the Amazon Web Services Management Console under account settings.

PeerVpcId
Required: Yes
Type: string

A unique identifier for a VPC with resources to be accessed by your Amazon GameLift fleet. The VPC must be in the same Region as your fleet. To look up a VPC ID, use the VPC Dashboard in the Amazon Web Services Management Console. Learn more about VPC peering in VPC Peering with Amazon GameLift Fleets.

Result Syntax

[
    'VpcPeeringAuthorization' => [
        'CreationTime' => <DateTime>,
        'ExpirationTime' => <DateTime>,
        'GameLiftAwsAccountId' => '<string>',
        'PeerVpcAwsAccountId' => '<string>',
        'PeerVpcId' => '<string>',
    ],
]

Result Details

Members
VpcPeeringAuthorization
Type: VpcPeeringAuthorization structure

Details on the requested VPC peering authorization, including expiration.

Errors

UnauthorizedException:

The client failed authentication. Clients should not retry such requests.

InvalidRequestException:

One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

NotFoundException:

THe requested resources was not found. The resource was either not created yet or deleted.

InternalServiceException:

The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

CreateVpcPeeringConnection

$result = $client->createVpcPeeringConnection([/* ... */]);
$promise = $client->createVpcPeeringConnectionAsync([/* ... */]);

Establishes a VPC peering connection between a virtual private cloud (VPC) in an Amazon Web Services account with the VPC for your Amazon GameLift fleet. VPC peering enables the game servers on your fleet to communicate directly with other Amazon Web Services resources. You can peer with VPCs in any Amazon Web Services account that you have access to, including the account that you use to manage your Amazon GameLift fleets. You cannot peer with VPCs that are in different Regions. For more information, see VPC Peering with Amazon GameLift Fleets.

Before calling this operation to establish the peering connection, you first need to use CreateVpcPeeringAuthorization and identify the VPC you want to peer with. Once the authorization for the specified VPC is issued, you have 24 hours to establish the connection. These two operations handle all tasks necessary to peer the two VPCs, including acceptance, updating routing tables, etc.

To establish the connection, call this operation from the Amazon Web Services account that is used to manage the Amazon GameLift fleets. Identify the following values: (1) The ID of the fleet you want to be enable a VPC peering connection for; (2) The Amazon Web Services account with the VPC that you want to peer with; and (3) The ID of the VPC you want to peer with. This operation is asynchronous. If successful, a connection request is created. You can use continuous polling to track the request's status using DescribeVpcPeeringConnections , or by monitoring fleet events for success or failure using DescribeFleetEvents .

Related actions

All APIs by task

Parameter Syntax

$result = $client->createVpcPeeringConnection([
    'FleetId' => '<string>', // REQUIRED
    'PeerVpcAwsAccountId' => '<string>', // REQUIRED
    'PeerVpcId' => '<string>', // REQUIRED
]);

Parameter Details

Members
FleetId
Required: Yes
Type: string

A unique identifier for the fleet. You can use either the fleet ID or ARN value. This tells Amazon GameLift which GameLift VPC to peer with.

PeerVpcAwsAccountId
Required: Yes
Type: string

A unique identifier for the Amazon Web Services account with the VPC that you want to peer your Amazon GameLift fleet with. You can find your Account ID in the Amazon Web Services Management Console under account settings.

PeerVpcId
Required: Yes
Type: string

A unique identifier for a VPC with resources to be accessed by your Amazon GameLift fleet. The VPC must be in the same Region as your fleet. To look up a VPC ID, use the VPC Dashboard in the Amazon Web Services Management Console. Learn more about VPC peering in VPC Peering with Amazon GameLift Fleets.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

UnauthorizedException:

The client failed authentication. Clients should not retry such requests.

InvalidRequestException:

One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

NotFoundException:

THe requested resources was not found. The resource was either not created yet or deleted.

InternalServiceException:

The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

DeleteAlias

$result = $client->deleteAlias([/* ... */]);
$promise = $client->deleteAliasAsync([/* ... */]);

Deletes an alias. This operation removes all record of the alias. Game clients attempting to access a server process using the deleted alias receive an error. To delete an alias, specify the alias ID to be deleted.

Related actions

All APIs by task

Parameter Syntax

$result = $client->deleteAlias([
    'AliasId' => '<string>', // REQUIRED
]);

Parameter Details

Members
AliasId
Required: Yes
Type: string

A unique identifier of the alias that you want to delete. You can use either the alias ID or ARN value.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

UnauthorizedException:

The client failed authentication. Clients should not retry such requests.

NotFoundException:

THe requested resources was not found. The resource was either not created yet or deleted.

InvalidRequestException:

One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

TaggingFailedException:

The requested tagging operation did not succeed. This may be due to invalid tag format or the maximum tag limit may have been exceeded. Resolve the issue before retrying.

InternalServiceException:

The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

DeleteBuild

$result = $client->deleteBuild([/* ... */]);
$promise = $client->deleteBuildAsync([/* ... */]);

Deletes a build. This operation permanently deletes the build resource and any uploaded build files. Deleting a build does not affect the status of any active fleets using the build, but you can no longer create new fleets with the deleted build.

To delete a build, specify the build ID.

Learn more

Upload a Custom Server Build

All APIs by task

Parameter Syntax

$result = $client->deleteBuild([
    'BuildId' => '<string>', // REQUIRED
]);

Parameter Details

Members
BuildId
Required: Yes
Type: string

A unique identifier for the build to delete. You can use either the build ID or ARN value.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

UnauthorizedException:

The client failed authentication. Clients should not retry such requests.

NotFoundException:

THe requested resources was not found. The resource was either not created yet or deleted.

InternalServiceException:

The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

TaggingFailedException:

The requested tagging operation did not succeed. This may be due to invalid tag format or the maximum tag limit may have been exceeded. Resolve the issue before retrying.

InvalidRequestException:

One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

DeleteContainerGroupDefinition

$result = $client->deleteContainerGroupDefinition([/* ... */]);
$promise = $client->deleteContainerGroupDefinitionAsync([/* ... */]);

This operation is used with the Amazon GameLift containers feature, which is currently in public preview.

Deletes a container group definition resource. You can delete a container group definition if there are no fleets using the definition.

To delete a container group definition, identify the resource to delete.

Learn more

Parameter Syntax

$result = $client->deleteContainerGroupDefinition([
    'Name' => '<string>', // REQUIRED
]);

Parameter Details

Members
Name
Required: Yes
Type: string

The unique identifier for the container group definition to delete. You can use either the Name or ARN value.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

UnauthorizedException:

The client failed authentication. Clients should not retry such requests.

NotFoundException:

THe requested resources was not found. The resource was either not created yet or deleted.

InternalServiceException:

The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

TaggingFailedException:

The requested tagging operation did not succeed. This may be due to invalid tag format or the maximum tag limit may have been exceeded. Resolve the issue before retrying.

InvalidRequestException:

One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

UnsupportedRegionException:

The requested operation is not supported in the Region specified.

DeleteFleet

$result = $client->deleteFleet([/* ... */]);
$promise = $client->deleteFleetAsync([/* ... */]);

Deletes all resources and information related to a fleet and shuts down any currently running fleet instances, including those in remote locations.

If the fleet being deleted has a VPC peering connection, you first need to get a valid authorization (good for 24 hours) by calling CreateVpcPeeringAuthorization. You don't need to explicitly delete the VPC peering connection.

To delete a fleet, specify the fleet ID to be terminated. During the deletion process, the fleet status is changed to DELETING. When completed, the status switches to TERMINATED and the fleet event FLEET_DELETED is emitted.

Learn more

Setting up Amazon GameLift Fleets

Parameter Syntax

$result = $client->deleteFleet([
    'FleetId' => '<string>', // REQUIRED
]);

Parameter Details

Members
FleetId
Required: Yes
Type: string

A unique identifier for the fleet to be deleted. You can use either the fleet ID or ARN value.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

NotFoundException:

THe requested resources was not found. The resource was either not created yet or deleted.

InternalServiceException:

The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

InvalidFleetStatusException:

The requested operation would cause a conflict with the current state of a resource associated with the request and/or the fleet. Resolve the conflict before retrying.

UnauthorizedException:

The client failed authentication. Clients should not retry such requests.

InvalidRequestException:

One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

TaggingFailedException:

The requested tagging operation did not succeed. This may be due to invalid tag format or the maximum tag limit may have been exceeded. Resolve the issue before retrying.

DeleteFleetLocations

$result = $client->deleteFleetLocations([/* ... */]);
$promise = $client->deleteFleetLocationsAsync([/* ... */]);

Removes locations from a multi-location fleet. When deleting a location, all game server process and all instances that are still active in the location are shut down.

To delete fleet locations, identify the fleet ID and provide a list of the locations to be deleted.

If successful, GameLift sets the location status to DELETING, and begins to shut down existing server processes and terminate instances in each location being deleted. When completed, the location status changes to TERMINATED.

Learn more

Setting up Amazon GameLift fleets

Parameter Syntax

$result = $client->deleteFleetLocations([
    'FleetId' => '<string>', // REQUIRED
    'Locations' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members
FleetId
Required: Yes
Type: string

A unique identifier for the fleet to delete locations for. You can use either the fleet ID or ARN value.

Locations
Required: Yes
Type: Array of strings

The list of fleet locations to delete. Specify locations in the form of an Amazon Web Services Region code, such as us-west-2.

Result Syntax

[
    'FleetArn' => '<string>',
    'FleetId' => '<string>',
    'LocationStates' => [
        [
            'Location' => '<string>',
            'Status' => 'NEW|DOWNLOADING|VALIDATING|BUILDING|ACTIVATING|ACTIVE|DELETING|ERROR|TERMINATED|NOT_FOUND',
        ],
        // ...
    ],
]

Result Details

Members
FleetArn
Type: string

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.

FleetId
Type: string

A unique identifier for the fleet that location attributes are being deleted for.

LocationStates
Type: Array of LocationState structures

The remote locations that are being deleted, with each location status set to DELETING.

Errors

InternalServiceException:

The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

InvalidRequestException:

One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

UnauthorizedException:

The client failed authentication. Clients should not retry such requests.

NotFoundException:

THe requested resources was not found. The resource was either not created yet or deleted.

UnsupportedRegionException:

The requested operation is not supported in the Region specified.

DeleteGameServerGroup

$result = $client->deleteGameServerGroup([/* ... */]);
$promise = $client->deleteGameServerGroupAsync([/* ... */]);

This operation is used with the Amazon GameLift FleetIQ solution and game server groups.

Terminates a game server group and permanently deletes the game server group record. You have several options for how these resources are impacted when deleting the game server group. Depending on the type of delete operation selected, this operation might affect these resources:

  • The game server group

  • The corresponding Auto Scaling group

  • All game servers that are currently running in the group

To delete a game server group, identify the game server group to delete and specify the type of delete operation to initiate. Game server groups can only be deleted if they are in ACTIVE or ERROR status.

If the delete request is successful, a series of operations are kicked off. The game server group status is changed to DELETE_SCHEDULED, which prevents new game servers from being registered and stops automatic scaling activity. Once all game servers in the game server group are deregistered, Amazon GameLift FleetIQ can begin deleting resources. If any of the delete operations fail, the game server group is placed in ERROR status.

Amazon GameLift FleetIQ emits delete events to Amazon CloudWatch.

Learn more

Amazon GameLift FleetIQ Guide

Parameter Syntax

$result = $client->deleteGameServerGroup([
    'DeleteOption' => 'SAFE_DELETE|FORCE_DELETE|RETAIN',
    'GameServerGroupName' => '<string>', // REQUIRED
]);

Parameter Details

Members
DeleteOption
Type: string

The type of delete to perform. Options include the following:

  • SAFE_DELETE – (default) Terminates the game server group and Amazon EC2 Auto Scaling group only when it has no game servers that are in UTILIZED status.

  • FORCE_DELETE – Terminates the game server group, including all active game servers regardless of their utilization status, and the Amazon EC2 Auto Scaling group.

  • RETAIN – Does a safe delete of the game server group but retains the Amazon EC2 Auto Scaling group as is.

GameServerGroupName
Required: Yes
Type: string

A unique identifier for the game server group. Use either the name or ARN value.

Result Syntax

[
    'GameServerGroup' => [
        'AutoScalingGroupArn' => '<string>',
        'BalancingStrategy' => 'SPOT_ONLY|SPOT_PREFERRED|ON_DEMAND_ONLY',
        'CreationTime' => <DateTime>,
        'GameServerGroupArn' => '<string>',
        'GameServerGroupName' => '<string>',
        'GameServerProtectionPolicy' => 'NO_PROTECTION|FULL_PROTECTION',
        'InstanceDefinitions' => [
            [
                'InstanceType' => 'c4.large|c4.xlarge|c4.2xlarge|c4.4xlarge|c4.8xlarge|c5.large|c5.xlarge|c5.2xlarge|c5.4xlarge|c5.9xlarge|c5.12xlarge|c5.18xlarge|c5.24xlarge|c5a.large|c5a.xlarge|c5a.2xlarge|c5a.4xlarge|c5a.8xlarge|c5a.12xlarge|c5a.16xlarge|c5a.24xlarge|c6g.medium|c6g.large|c6g.xlarge|c6g.2xlarge|c6g.4xlarge|c6g.8xlarge|c6g.12xlarge|c6g.16xlarge|r4.large|r4.xlarge|r4.2xlarge|r4.4xlarge|r4.8xlarge|r4.16xlarge|r5.large|r5.xlarge|r5.2xlarge|r5.4xlarge|r5.8xlarge|r5.12xlarge|r5.16xlarge|r5.24xlarge|r5a.large|r5a.xlarge|r5a.2xlarge|r5a.4xlarge|r5a.8xlarge|r5a.12xlarge|r5a.16xlarge|r5a.24xlarge|r6g.medium|r6g.large|r6g.xlarge|r6g.2xlarge|r6g.4xlarge|r6g.8xlarge|r6g.12xlarge|r6g.16xlarge|m4.large|m4.xlarge|m4.2xlarge|m4.4xlarge|m4.10xlarge|m5.large|m5.xlarge|m5.2xlarge|m5.4xlarge|m5.8xlarge|m5.12xlarge|m5.16xlarge|m5.24xlarge|m5a.large|m5a.xlarge|m5a.2xlarge|m5a.4xlarge|m5a.8xlarge|m5a.12xlarge|m5a.16xlarge|m5a.24xlarge|m6g.medium|m6g.large|m6g.xlarge|m6g.2xlarge|m6g.4xlarge|m6g.8xlarge|m6g.12xlarge|m6g.16xlarge',
                'WeightedCapacity' => '<string>',
            ],
            // ...
        ],
        'LastUpdatedTime' => <DateTime>,
        'RoleArn' => '<string>',
        'Status' => 'NEW|ACTIVATING|ACTIVE|DELETE_SCHEDULED|DELETING|DELETED|ERROR',
        'StatusReason' => '<string>',
        'SuspendedActions' => ['<string>', ...],
    ],
]

Result Details

Members
GameServerGroup
Type: GameServerGroup structure

An object that describes the deleted game server group resource, with status updated to DELETE_SCHEDULED.

Errors

InvalidRequestException:

One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

NotFoundException:

THe requested resources was not found. The resource was either not created yet or deleted.

UnauthorizedException:

The client failed authentication. Clients should not retry such requests.

InternalServiceException:

The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

DeleteGameSessionQueue

$result = $client->deleteGameSessionQueue([/* ... */]);
$promise = $client->deleteGameSessionQueueAsync([/* ... */]);

Deletes a game session queue. Once a queue is successfully deleted, unfulfilled StartGameSessionPlacement requests that reference the queue will fail. To delete a queue, specify the queue name.

Parameter Syntax

$result = $client->deleteGameSessionQueue([
    'Name' => '<string>', // REQUIRED
]);

Parameter Details

Members
Name
Required: Yes
Type: string

A descriptive label that is associated with game session queue. Queue names must be unique within each Region. You can use either the queue ID or ARN value.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InternalServiceException:

The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

InvalidRequestException:

One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

NotFoundException:

THe requested resources was not found. The resource was either not created yet or deleted.

UnauthorizedException:

The client failed authentication. Clients should not retry such requests.

TaggingFailedException:

The requested tagging operation did not succeed. This may be due to invalid tag format or the maximum tag limit may have been exceeded. Resolve the issue before retrying.

DeleteLocation

$result = $client->deleteLocation([/* ... */]);
$promise = $client->deleteLocationAsync([/* ... */]);

Deletes a custom location.

Before deleting a custom location, review any fleets currently using the custom location and deregister the location if it is in use. For more information, see DeregisterCompute.

Parameter Syntax

$result = $client->deleteLocation([
    'LocationName' => '<string>', // REQUIRED
]);

Parameter Details

Members
LocationName
Required: Yes
Type: string

The location name of the custom location to be deleted.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

UnauthorizedException:

The client failed authentication. Clients should not retry such requests.

InvalidRequestException:

One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

NotFoundException:

THe requested resources was not found. The resource was either not created yet or deleted.

InternalServiceException:

The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

DeleteMatchmakingConfiguration

$result = $client->deleteMatchmakingConfiguration([/* ... */]);
$promise = $client->deleteMatchmakingConfigurationAsync([/* ... */]);

Permanently removes a FlexMatch matchmaking configuration. To delete, specify the configuration name. A matchmaking configuration cannot be deleted if it is being used in any active matchmaking tickets.

Parameter Syntax

$result = $client->deleteMatchmakingConfiguration([
    'Name' => '<string>', // REQUIRED
]);

Parameter Details

Members
Name
Required: Yes
Type: string

A unique identifier for the matchmaking configuration. You can use either the configuration name or ARN value.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InvalidRequestException:

One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

NotFoundException:

THe requested resources was not found. The resource was either not created yet or deleted.

InternalServiceException:

The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

UnsupportedRegionException:

The requested operation is not supported in the Region specified.

TaggingFailedException:

The requested tagging operation did not succeed. This may be due to invalid tag format or the maximum tag limit may have been exceeded. Resolve the issue before retrying.

DeleteMatchmakingRuleSet

$result = $client->deleteMatchmakingRuleSet([/* ... */]);
$promise = $client->deleteMatchmakingRuleSetAsync([/* ... */]);

Deletes an existing matchmaking rule set. To delete the rule set, provide the rule set name. Rule sets cannot be deleted if they are currently being used by a matchmaking configuration.

Learn more

Parameter Syntax

$result = $client->deleteMatchmakingRuleSet([
    'Name' => '<string>', // REQUIRED
]);

Parameter Details

Members
Name
Required: Yes
Type: string

A unique identifier for the matchmaking rule set to be deleted. (Note: The rule set name is different from the optional "name" field in the rule set body.) You can use either the rule set name or ARN value.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InvalidRequestException:

One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

InternalServiceException:

The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

UnsupportedRegionException:

The requested operation is not supported in the Region specified.

NotFoundException:

THe requested resources was not found. The resource was either not created yet or deleted.

TaggingFailedException:

The requested tagging operation did not succeed. This may be due to invalid tag format or the maximum tag limit may have been exceeded. Resolve the issue before retrying.

DeleteScalingPolicy

$result = $client->deleteScalingPolicy([/* ... */]);
$promise = $client->deleteScalingPolicyAsync([/* ... */]);

Deletes a fleet scaling policy. Once deleted, the policy is no longer in force and Amazon GameLift removes all record of it. To delete a scaling policy, specify both the scaling policy name and the fleet ID it is associated with.

To temporarily suspend scaling policies, use StopFleetActions. This operation suspends all policies for the fleet.

Parameter Syntax

$result = $client->deleteScalingPolicy([
    'FleetId' => '<string>', // REQUIRED
    'Name' => '<string>', // REQUIRED
]);

Parameter Details

Members
FleetId
Required: Yes
Type: string

A unique identifier for the fleet to be deleted. You can use either the fleet ID or ARN value.

Name
Required: Yes
Type: string

A descriptive label that is associated with a fleet's scaling policy. Policy names do not need to be unique.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InternalServiceException:

The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

InvalidRequestException:

One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

UnauthorizedException:

The client failed authentication. Clients should not retry such requests.

NotFoundException:

THe requested resources was not found. The resource was either not created yet or deleted.

DeleteScript

$result = $client->deleteScript([/* ... */]);
$promise = $client->deleteScriptAsync([/* ... */]);

Deletes a Realtime script. This operation permanently deletes the script record. If script files were uploaded, they are also deleted (files stored in an S3 bucket are not deleted).

To delete a script, specify the script ID. Before deleting a script, be sure to terminate all fleets that are deployed with the script being deleted. Fleet instances periodically check for script updates, and if the script record no longer exists, the instance will go into an error state and be unable to host game sessions.

Learn more

Amazon GameLift Realtime Servers

Related actions

All APIs by task

Parameter Syntax

$result = $client->deleteScript([
    'ScriptId' => '<string>', // REQUIRED
]);

Parameter Details

Members
ScriptId
Required: Yes
Type: string

A unique identifier for the Realtime script to delete. You can use either the script ID or ARN value.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InvalidRequestException:

One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

UnauthorizedException:

The client failed authentication. Clients should not retry such requests.

NotFoundException:

THe requested resources was not found. The resource was either not created yet or deleted.

TaggingFailedException:

The requested tagging operation did not succeed. This may be due to invalid tag format or the maximum tag limit may have been exceeded. Resolve the issue before retrying.

InternalServiceException:

The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

DeleteVpcPeeringAuthorization

$result = $client->deleteVpcPeeringAuthorization([/* ... */]);
$promise = $client->deleteVpcPeeringAuthorizationAsync([/* ... */]);

Cancels a pending VPC peering authorization for the specified VPC. If you need to delete an existing VPC peering connection, use DeleteVpcPeeringConnection.

Related actions

All APIs by task

Parameter Syntax

$result = $client->deleteVpcPeeringAuthorization([
    'GameLiftAwsAccountId' => '<string>', // REQUIRED
    'PeerVpcId' => '<string>', // REQUIRED
]);

Parameter Details

Members
GameLiftAwsAccountId
Required: Yes
Type: string

A unique identifier for the Amazon Web Services account that you use to manage your Amazon GameLift fleet. You can find your Account ID in the Amazon Web Services Management Console under account settings.

PeerVpcId
Required: Yes
Type: string

A unique identifier for a VPC with resources to be accessed by your Amazon GameLift fleet. The VPC must be in the same Region as your fleet. To look up a VPC ID, use the VPC Dashboard in the Amazon Web Services Management Console. Learn more about VPC peering in VPC Peering with Amazon GameLift Fleets.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

UnauthorizedException:

The client failed authentication. Clients should not retry such requests.

InvalidRequestException:

One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

NotFoundException:

THe requested resources was not found. The resource was either not created yet or deleted.

InternalServiceException:

The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

DeleteVpcPeeringConnection

$result = $client->deleteVpcPeeringConnection([/* ... */]);
$promise = $client->deleteVpcPeeringConnectionAsync([/* ... */]);

Removes a VPC peering connection. To delete the connection, you must have a valid authorization for the VPC peering connection that you want to delete..

Once a valid authorization exists, call this operation from the Amazon Web Services account that is used to manage the Amazon GameLift fleets. Identify the connection to delete by the connection ID and fleet ID. If successful, the connection is removed.

Related actions

All APIs by task

Parameter Syntax

$result = $client->deleteVpcPeeringConnection([
    'FleetId' => '<string>', // REQUIRED
    'VpcPeeringConnectionId' => '<string>', // REQUIRED
]);

Parameter Details

Members
FleetId
Required: Yes
Type: string

A unique identifier for the fleet. This fleet specified must match the fleet referenced in the VPC peering connection record. You can use either the fleet ID or ARN value.

VpcPeeringConnectionId
Required: Yes
Type: string

A unique identifier for a VPC peering connection.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

UnauthorizedException:

The client failed authentication. Clients should not retry such requests.

InvalidRequestException:

One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

NotFoundException:

THe requested resources was not found. The resource was either not created yet or deleted.

InternalServiceException:

The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

DeregisterCompute

$result = $client->deregisterCompute([/* ... */]);
$promise = $client->deregisterComputeAsync([/* ... */]);

This operation has been expanded to use with the Amazon GameLift containers feature, which is currently in public preview.

Removes a compute resource from an Amazon GameLift Anywhere fleet or container fleet. Deregistered computes can no longer host game sessions through Amazon GameLift.

For an Anywhere fleet or a container fleet that's running the Amazon GameLift Agent, the Agent handles all compute registry tasks for you. For an Anywhere fleet that doesn't use the Agent, call this operation to deregister fleet computes.

To deregister a compute, call this operation from the compute that's being deregistered and specify the compute name and the fleet ID.

Parameter Syntax

$result = $client->deregisterCompute([
    'ComputeName' => '<string>', // REQUIRED
    'FleetId' => '<string>', // REQUIRED
]);

Parameter Details

Members
ComputeName
Required: Yes
Type: string

The unique identifier of the compute resource to deregister. For an Anywhere fleet compute, use the registered compute name. For a container fleet, use the compute name (for example, a123b456c789012d3e4567f8a901b23c/1a234b56-7cd8-9e0f-a1b2-c34d567ef8a9) or the compute ARN.

FleetId
Required: Yes
Type: string

A unique identifier for the fleet the compute resource is currently registered to.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

UnauthorizedException:

The client failed authentication. Clients should not retry such requests.

InvalidRequestException:

One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

NotFoundException:

THe requested resources was not found. The resource was either not created yet or deleted.

InternalServiceException:

The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

DeregisterGameServer

$result = $client->deregisterGameServer([/* ... */]);
$promise = $client->deregisterGameServerAsync([/* ... */]);

This operation is used with the Amazon GameLift FleetIQ solution and game server groups.

Removes the game server from a game server group. As a result of this operation, the deregistered game server can no longer be claimed and will not be returned in a list of active game servers.

To deregister a game server, specify the game server group and game server ID. If successful, this operation emits a CloudWatch event with termination timestamp and reason.

Learn more

Amazon GameLift FleetIQ Guide

Parameter Syntax

$result = $client->deregisterGameServer([
    'GameServerGroupName' => '<string>', // REQUIRED
    'GameServerId' => '<string>', // REQUIRED
]);

Parameter Details

Members
GameServerGroupName
Required: Yes
Type: string

A unique identifier for the game server group where the game server is running.

GameServerId
Required: Yes
Type: string

A custom string that uniquely identifies the game server to deregister.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InvalidRequestException:

One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

NotFoundException:

THe requested resources was not found. The resource was either not created yet or deleted.

UnauthorizedException:

The client failed authentication. Clients should not retry such requests.

InternalServiceException:

The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

DescribeAlias

$result = $client->describeAlias([/* ... */]);
$promise = $client->describeAliasAsync([/* ... */]);

Retrieves properties for an alias. This operation returns all alias metadata and settings. To get an alias's target fleet ID only, use ResolveAlias.

To get alias properties, specify the alias ID. If successful, the requested alias record is returned.

Related actions

All APIs by task

Parameter Syntax

$result = $client->describeAlias([
    'AliasId' => '<string>', // REQUIRED
]);

Parameter Details

Members
AliasId
Required: Yes
Type: string

The unique identifier for the fleet alias that you want to retrieve. You can use either the alias ID or ARN value.

Result Syntax

[
    'Alias' => [
        'AliasArn' => '<string>',
        'AliasId' => '<string>',
        'CreationTime' => <DateTime>,
        'Description' => '<string>',
        'LastUpdatedTime' => <DateTime>,
        'Name' => '<string>',
        'RoutingStrategy' => [
            'FleetId' => '<string>',
            'Message' => '<string>',
            'Type' => 'SIMPLE|TERMINAL',
        ],
    ],
]

Result Details

Members
Alias
Type: Alias structure

The requested alias resource.

Errors

UnauthorizedException:

The client failed authentication. Clients should not retry such requests.

InvalidRequestException:

One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

NotFoundException:

THe requested resources was not found. The resource was either not created yet or deleted.

InternalServiceException:

The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

DescribeBuild

$result = $client->describeBuild([/* ... */]);
$promise = $client->describeBuildAsync([/* ... */]);

Retrieves properties for a custom game build. To request a build resource, specify a build ID. If successful, an object containing the build properties is returned.

Learn more

Upload a Custom Server Build

All APIs by task

Parameter Syntax

$result = $client->describeBuild([
    'BuildId' => '<string>', // REQUIRED
]);

Parameter Details

Members
BuildId
Required: Yes
Type: string

A unique identifier for the build to retrieve properties for. You can use either the build ID or ARN value.

Result Syntax

[
    'Build' => [
        'BuildArn' => '<string>',
        'BuildId' => '<string>',
        'CreationTime' => <DateTime>,
        'Name' => '<string>',
        'OperatingSystem' => 'WINDOWS_2012|AMAZON_LINUX|AMAZON_LINUX_2|WINDOWS_2016|AMAZON_LINUX_2023',
        'ServerSdkVersion' => '<string>',
        'SizeOnDisk' => <integer>,
        'Status' => 'INITIALIZED|READY|FAILED',
        'Version' => '<string>',
    ],
]

Result Details

Members
Build
Type: Build structure

Set of properties describing the requested build.

Errors

UnauthorizedException:

The client failed authentication. Clients should not retry such requests.

InvalidRequestException:

One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

NotFoundException:

THe requested resources was not found. The resource was either not created yet or deleted.

InternalServiceException:

The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

DescribeCompute

$result = $client->describeCompute([/* ... */]);
$promise = $client->describeComputeAsync([/* ... */]);

This operation has been expanded to use with the Amazon GameLift containers feature, which is currently in public preview.

Retrieves properties for a compute resource in an Amazon GameLift fleet. To get a list of all computes in a fleet, call ListCompute.

To request information on a specific compute, provide the fleet ID and compute name.

If successful, this operation returns details for the requested compute resource. Depending on the fleet's compute type, the result includes the following information:

  • For EC2 fleets, this operation returns information about the EC2 instance.

  • For ANYWHERE fleets, this operation returns information about the registered compute.

  • For CONTAINER fleets, this operation returns information about the container that's registered as a compute, and the instance it's running on. The compute name is the container name.

Parameter Syntax

$result = $client->describeCompute([
    'ComputeName' => '<string>', // REQUIRED
    'FleetId' => '<string>', // REQUIRED
]);

Parameter Details

Members
ComputeName
Required: Yes
Type: string

The unique identifier of the compute resource to retrieve properties for. For an Anywhere fleet compute, use the registered compute name. For an EC2 fleet instance, use the instance ID. For a container fleet, use the compute name (for example, a123b456c789012d3e4567f8a901b23c/1a234b56-7cd8-9e0f-a1b2-c34d567ef8a9) or the compute ARN.

FleetId
Required: Yes
Type: string

A unique identifier for the fleet that the compute belongs to. You can use either the fleet ID or ARN value.

Result Syntax

[
    'Compute' => [
        'ComputeArn' => '<string>',
        'ComputeName' => '<string>',
        'ComputeStatus' => 'PENDING|ACTIVE|TERMINATING',
        'ContainerAttributes' => [
            'ContainerPortMappings' => [
                [
                    'ConnectionPort' => <integer>,
                    'ContainerPort' => <integer>,
                    'Protocol' => 'TCP|UDP',
                ],
                // ...
            ],
        ],
        'CreationTime' => <DateTime>,
        'DnsName' => '<string>',
        'FleetArn' => '<string>',
        'FleetId' => '<string>',
        'GameLiftAgentEndpoint' => '<string>',
        'GameLiftServiceSdkEndpoint' => '<string>',
        'InstanceId' => '<string>',
        'IpAddress' => '<string>',
        'Location' => '<string>',
        'OperatingSystem' => 'WINDOWS_2012|AMAZON_LINUX|AMAZON_LINUX_2|WINDOWS_2016|AMAZON_LINUX_2023',
        'Type' => 't2.micro|t2.small|t2.medium|t2.large|c3.large|c3.xlarge|c3.2xlarge|c3.4xlarge|c3.8xlarge|c4.large|c4.xlarge|c4.2xlarge|c4.4xlarge|c4.8xlarge|c5.large|c5.xlarge|c5.2xlarge|c5.4xlarge|c5.9xlarge|c5.12xlarge|c5.18xlarge|c5.24xlarge|c5a.large|c5a.xlarge|c5a.2xlarge|c5a.4xlarge|c5a.8xlarge|c5a.12xlarge|c5a.16xlarge|c5a.24xlarge|r3.large|r3.xlarge|r3.2xlarge|r3.4xlarge|r3.8xlarge|r4.large|r4.xlarge|r4.2xlarge|r4.4xlarge|r4.8xlarge|r4.16xlarge|r5.large|r5.xlarge|r5.2xlarge|r5.4xlarge|r5.8xlarge|r5.12xlarge|r5.16xlarge|r5.24xlarge|r5a.large|r5a.xlarge|r5a.2xlarge|r5a.4xlarge|r5a.8xlarge|r5a.12xlarge|r5a.16xlarge|r5a.24xlarge|m3.medium|m3.large|m3.xlarge|m3.2xlarge|m4.large|m4.xlarge|m4.2xlarge|m4.4xlarge|m4.10xlarge|m5.large|m5.xlarge|m5.2xlarge|m5.4xlarge|m5.8xlarge|m5.12xlarge|m5.16xlarge|m5.24xlarge|m5a.large|m5a.xlarge|m5a.2xlarge|m5a.4xlarge|m5a.8xlarge|m5a.12xlarge|m5a.16xlarge|m5a.24xlarge|c5d.large|c5d.xlarge|c5d.2xlarge|c5d.4xlarge|c5d.9xlarge|c5d.12xlarge|c5d.18xlarge|c5d.24xlarge|c6a.large|c6a.xlarge|c6a.2xlarge|c6a.4xlarge|c6a.8xlarge|c6a.12xlarge|c6a.16xlarge|c6a.24xlarge|c6i.large|c6i.xlarge|c6i.2xlarge|c6i.4xlarge|c6i.8xlarge|c6i.12xlarge|c6i.16xlarge|c6i.24xlarge|r5d.large|r5d.xlarge|r5d.2xlarge|r5d.4xlarge|r5d.8xlarge|r5d.12xlarge|r5d.16xlarge|r5d.24xlarge|m6g.medium|m6g.large|m6g.xlarge|m6g.2xlarge|m6g.4xlarge|m6g.8xlarge|m6g.12xlarge|m6g.16xlarge|c6g.medium|c6g.large|c6g.xlarge|c6g.2xlarge|c6g.4xlarge|c6g.8xlarge|c6g.12xlarge|c6g.16xlarge|r6g.medium|r6g.large|r6g.xlarge|r6g.2xlarge|r6g.4xlarge|r6g.8xlarge|r6g.12xlarge|r6g.16xlarge|c6gn.medium|c6gn.large|c6gn.xlarge|c6gn.2xlarge|c6gn.4xlarge|c6gn.8xlarge|c6gn.12xlarge|c6gn.16xlarge|c7g.medium|c7g.large|c7g.xlarge|c7g.2xlarge|c7g.4xlarge|c7g.8xlarge|c7g.12xlarge|c7g.16xlarge|r7g.medium|r7g.large|r7g.xlarge|r7g.2xlarge|r7g.4xlarge|r7g.8xlarge|r7g.12xlarge|r7g.16xlarge|m7g.medium|m7g.large|m7g.xlarge|m7g.2xlarge|m7g.4xlarge|m7g.8xlarge|m7g.12xlarge|m7g.16xlarge|g5g.xlarge|g5g.2xlarge|g5g.4xlarge|g5g.8xlarge|g5g.16xlarge',
    ],
]

Result Details

Members
Compute
Type: Compute structure

The set of properties for the requested compute resource.

Errors

UnauthorizedException:

The client failed authentication. Clients should not retry such requests.

InvalidRequestException:

One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

NotFoundException:

THe requested resources was not found. The resource was either not created yet or deleted.

InternalServiceException:

The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

DescribeContainerGroupDefinition

$result = $client->describeContainerGroupDefinition([/* ... */]);
$promise = $client->describeContainerGroupDefinitionAsync([/* ... */]);

This operation is used with the Amazon GameLift containers feature, which is currently in public preview.

Retrieves the properties of a container group definition, including all container definitions in the group.

To retrieve a container group definition, provide a resource identifier. If successful, this operation returns the complete properties of the container group definition.

Learn more

Parameter Syntax

$result = $client->describeContainerGroupDefinition([
    'Name' => '<string>', // REQUIRED
]);

Parameter Details

Members
Name
Required: Yes
Type: string

The unique identifier for the container group definition to retrieve properties for. You can use either the Name or ARN value.

Result Syntax

[
    'ContainerGroupDefinition' => [
        'ContainerDefinitions' => [
            [
                'Command' => ['<string>', ...],
                'ContainerName' => '<string>',
                'Cpu' => <integer>,
                'DependsOn' => [
                    [
                        'Condition' => 'START|COMPLETE|SUCCESS|HEALTHY',
                        'ContainerName' => '<string>',
                    ],
                    // ...
                ],
                'EntryPoint' => ['<string>', ...],
                'Environment' => [
                    [
                        'Name' => '<string>',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
                'Essential' => true || false,
                'HealthCheck' => [
                    'Command' => ['<string>', ...],
                    'Interval' => <integer>,
                    'Retries' => <integer>,
                    'StartPeriod' => <integer>,
                    'Timeout' => <integer>,
                ],
                'ImageUri' => '<string>',
                'MemoryLimits' => [
                    'HardLimit' => <integer>,
                    'SoftLimit' => <integer>,
                ],
                'PortConfiguration' => [
                    'ContainerPortRanges' => [
                        [
                            'FromPort' => <integer>,
                            'Protocol' => 'TCP|UDP',
                            'ToPort' => <integer>,
                        ],
                        // ...
                    ],
                ],
                'ResolvedImageDigest' => '<string>',
                'WorkingDirectory' => '<string>',
            ],
            // ...
        ],
        'ContainerGroupDefinitionArn' => '<string>',
        'CreationTime' => <DateTime>,
        'Name' => '<string>',
        'OperatingSystem' => 'AMAZON_LINUX_2023',
        'SchedulingStrategy' => 'REPLICA|DAEMON',
        'Status' => 'READY|COPYING|FAILED',
        'StatusReason' => '<string>',
        'TotalCpuLimit' => <integer>,
        'TotalMemoryLimit' => <integer>,
    ],
]

Result Details

Members
ContainerGroupDefinition
Type: ContainerGroupDefinition structure

The properties of the requested container group definition resource.

Errors

UnauthorizedException:

The client failed authentication. Clients should not retry such requests.

InvalidRequestException:

One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

NotFoundException:

THe requested resources was not found. The resource was either not created yet or deleted.

InternalServiceException:

The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

UnsupportedRegionException:

The requested operation is not supported in the Region specified.

DescribeEC2InstanceLimits

$result = $client->describeEC2InstanceLimits([/* ... */]);
$promise = $client->describeEC2InstanceLimitsAsync([/* ... */]);

Retrieves the instance limits and current utilization for an Amazon Web Services Region or location. Instance limits control the number of instances, per instance type, per location, that your Amazon Web Services account can use. Learn more at Amazon EC2 Instance Types. The information returned includes the maximum number of instances allowed and your account's current usage across all fleets. This information can affect your ability to scale your Amazon GameLift fleets. You can request a limit increase for your account by using the Service limits page in the Amazon GameLift console.

Instance limits differ based on whether the instances are deployed in a fleet's home Region or in a remote location. For remote locations, limits also differ based on the combination of home Region and remote location. All requests must specify an Amazon Web Services Region (either explicitly or as your default settings). To get the limit for a remote location, you must also specify the location. For example, the following requests all return different results:

  • Request specifies the Region ap-northeast-1 with no location. The result is limits and usage data on all instance types that are deployed in us-east-2, by all of the fleets that reside in ap-northeast-1.

  • Request specifies the Region us-east-1 with location ca-central-1. The result is limits and usage data on all instance types that are deployed in ca-central-1, by all of the fleets that reside in us-east-2. These limits do not affect fleets in any other Regions that deploy instances to ca-central-1.

  • Request specifies the Region eu-west-1 with location ca-central-1. The result is limits and usage data on all instance types that are deployed in ca-central-1, by all of the fleets that reside in eu-west-1.

This operation can be used in the following ways:

  • To get limit and usage data for all instance types that are deployed in an Amazon Web Services Region by fleets that reside in the same Region: Specify the Region only. Optionally, specify a single instance type to retrieve information for.

  • To get limit and usage data for all instance types that are deployed to a remote location by fleets that reside in different Amazon Web Services Region: Provide both the Amazon Web Services Region and the remote location. Optionally, specify a single instance type to retrieve information for.

If successful, an EC2InstanceLimits object is returned with limits and usage data for each requested instance type.

Learn more

Setting up Amazon GameLift fleets

Parameter Syntax

$result = $client->describeEC2InstanceLimits([
    'EC2InstanceType' => 't2.micro|t2.small|t2.medium|t2.large|c3.large|c3.xlarge|c3.2xlarge|c3.4xlarge|c3.8xlarge|c4.large|c4.xlarge|c4.2xlarge|c4.4xlarge|c4.8xlarge|c5.large|c5.xlarge|c5.2xlarge|c5.4xlarge|c5.9xlarge|c5.12xlarge|c5.18xlarge|c5.24xlarge|c5a.large|c5a.xlarge|c5a.2xlarge|c5a.4xlarge|c5a.8xlarge|c5a.12xlarge|c5a.16xlarge|c5a.24xlarge|r3.large|r3.xlarge|r3.2xlarge|r3.4xlarge|r3.8xlarge|r4.large|r4.xlarge|r4.2xlarge|r4.4xlarge|r4.8xlarge|r4.16xlarge|r5.large|r5.xlarge|r5.2xlarge|r5.4xlarge|r5.8xlarge|r5.12xlarge|r5.16xlarge|r5.24xlarge|r5a.large|r5a.xlarge|r5a.2xlarge|r5a.4xlarge|r5a.8xlarge|r5a.12xlarge|r5a.16xlarge|r5a.24xlarge|m3.medium|m3.large|m3.xlarge|m3.2xlarge|m4.large|m4.xlarge|m4.2xlarge|m4.4xlarge|m4.10xlarge|m5.large|m5.xlarge|m5.2xlarge|m5.4xlarge|m5.8xlarge|m5.12xlarge|m5.16xlarge|m5.24xlarge|m5a.large|m5a.xlarge|m5a.2xlarge|m5a.4xlarge|m5a.8xlarge|m5a.12xlarge|m5a.16xlarge|m5a.24xlarge|c5d.large|c5d.xlarge|c5d.2xlarge|c5d.4xlarge|c5d.9xlarge|c5d.12xlarge|c5d.18xlarge|c5d.24xlarge|c6a.large|c6a.xlarge|c6a.2xlarge|c6a.4xlarge|c6a.8xlarge|c6a.12xlarge|c6a.16xlarge|c6a.24xlarge|c6i.large|c6i.xlarge|c6i.2xlarge|c6i.4xlarge|c6i.8xlarge|c6i.12xlarge|c6i.16xlarge|c6i.24xlarge|r5d.large|r5d.xlarge|r5d.2xlarge|r5d.4xlarge|r5d.8xlarge|r5d.12xlarge|r5d.16xlarge|r5d.24xlarge|m6g.medium|m6g.large|m6g.xlarge|m6g.2xlarge|m6g.4xlarge|m6g.8xlarge|m6g.12xlarge|m6g.16xlarge|c6g.medium|c6g.large|c6g.xlarge|c6g.2xlarge|c6g.4xlarge|c6g.8xlarge|c6g.12xlarge|c6g.16xlarge|r6g.medium|r6g.large|r6g.xlarge|r6g.2xlarge|r6g.4xlarge|r6g.8xlarge|r6g.12xlarge|r6g.16xlarge|c6gn.medium|c6gn.large|c6gn.xlarge|c6gn.2xlarge|c6gn.4xlarge|c6gn.8xlarge|c6gn.12xlarge|c6gn.16xlarge|c7g.medium|c7g.large|c7g.xlarge|c7g.2xlarge|c7g.4xlarge|c7g.8xlarge|c7g.12xlarge|c7g.16xlarge|r7g.medium|r7g.large|r7g.xlarge|r7g.2xlarge|r7g.4xlarge|r7g.8xlarge|r7g.12xlarge|r7g.16xlarge|m7g.medium|m7g.large|m7g.xlarge|m7g.2xlarge|m7g.4xlarge|m7g.8xlarge|m7g.12xlarge|m7g.16xlarge|g5g.xlarge|g5g.2xlarge|g5g.4xlarge|g5g.8xlarge|g5g.16xlarge',
    'Location' => '<string>',
]);

Parameter Details

Members
EC2InstanceType
Type: string

Name of an Amazon EC2 instance type that is supported in Amazon GameLift. A fleet instance type determines the computing resources of each instance in the fleet, including CPU, memory, storage, and networking capacity. Do not specify a value for this parameter to retrieve limits for all instance types.

Location
Type: string

The name of a remote location to request instance limits for, in the form of an Amazon Web Services Region code such as us-west-2.

Result Syntax

[
    'EC2InstanceLimits' => [
        [
            'CurrentInstances' => <integer>,
            'EC2InstanceType' => 't2.micro|t2.small|t2.medium|t2.large|c3.large|c3.xlarge|c3.2xlarge|c3.4xlarge|c3.8xlarge|c4.large|c4.xlarge|c4.2xlarge|c4.4xlarge|c4.8xlarge|c5.large|c5.xlarge|c5.2xlarge|c5.4xlarge|c5.9xlarge|c5.12xlarge|c5.18xlarge|c5.24xlarge|c5a.large|c5a.xlarge|c5a.2xlarge|c5a.4xlarge|c5a.8xlarge|c5a.12xlarge|c5a.16xlarge|c5a.24xlarge|r3.large|r3.xlarge|r3.2xlarge|r3.4xlarge|r3.8xlarge|r4.large|r4.xlarge|r4.2xlarge|r4.4xlarge|r4.8xlarge|r4.16xlarge|r5.large|r5.xlarge|r5.2xlarge|r5.4xlarge|r5.8xlarge|r5.12xlarge|r5.16xlarge|r5.24xlarge|r5a.large|r5a.xlarge|r5a.2xlarge|r5a.4xlarge|r5a.8xlarge|r5a.12xlarge|r5a.16xlarge|r5a.24xlarge|m3.medium|m3.large|m3.xlarge|m3.2xlarge|m4.large|m4.xlarge|m4.2xlarge|m4.4xlarge|m4.10xlarge|m5.large|m5.xlarge|m5.2xlarge|m5.4xlarge|m5.8xlarge|m5.12xlarge|m5.16xlarge|m5.24xlarge|m5a.large|m5a.xlarge|m5a.2xlarge|m5a.4xlarge|m5a.8xlarge|m5a.12xlarge|m5a.16xlarge|m5a.24xlarge|c5d.large|c5d.xlarge|c5d.2xlarge|c5d.4xlarge|c5d.9xlarge|c5d.12xlarge|c5d.18xlarge|c5d.24xlarge|c6a.large|c6a.xlarge|c6a.2xlarge|c6a.4xlarge|c6a.8xlarge|c6a.12xlarge|c6a.16xlarge|c6a.24xlarge|c6i.large|c6i.xlarge|c6i.2xlarge|c6i.4xlarge|c6i.8xlarge|c6i.12xlarge|c6i.16xlarge|c6i.24xlarge|r5d.large|r5d.xlarge|r5d.2xlarge|r5d.4xlarge|r5d.8xlarge|r5d.12xlarge|r5d.16xlarge|r5d.24xlarge|m6g.medium|m6g.large|m6g.xlarge|m6g.2xlarge|m6g.4xlarge|m6g.8xlarge|m6g.12xlarge|m6g.16xlarge|c6g.medium|c6g.large|c6g.xlarge|c6g.2xlarge|c6g.4xlarge|c6g.8xlarge|c6g.12xlarge|c6g.16xlarge|r6g.medium|r6g.large|r6g.xlarge|r6g.2xlarge|r6g.4xlarge|r6g.8xlarge|r6g.12xlarge|r6g.16xlarge|c6gn.medium|c6gn.large|c6gn.xlarge|c6gn.2xlarge|c6gn.4xlarge|c6gn.8xlarge|c6gn.12xlarge|c6gn.16xlarge|c7g.medium|c7g.large|c7g.xlarge|c7g.2xlarge|c7g.4xlarge|c7g.8xlarge|c7g.12xlarge|c7g.16xlarge|r7g.medium|r7g.large|r7g.xlarge|r7g.2xlarge|r7g.4xlarge|r7g.8xlarge|r7g.12xlarge|r7g.16xlarge|m7g.medium|m7g.large|m7g.xlarge|m7g.2xlarge|m7g.4xlarge|m7g.8xlarge|m7g.12xlarge|m7g.16xlarge|g5g.xlarge|g5g.2xlarge|g5g.4xlarge|g5g.8xlarge|g5g.16xlarge',
            'InstanceLimit' => <integer>,
            'Location' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
EC2InstanceLimits
Type: Array of EC2InstanceLimit structures

The maximum number of instances for the specified instance type.

Errors

InvalidRequestException:

One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

InternalServiceException:

The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

UnauthorizedException:

The client failed authentication. Clients should not retry such requests.

UnsupportedRegionException:

The requested operation is not supported in the Region specified.

DescribeFleetAttributes

$result = $client->describeFleetAttributes([/* ... */]);
$promise = $client->describeFleetAttributesAsync([/* ... */]);

This operation has been expanded to use with the Amazon GameLift containers feature, which is currently in public preview.

Retrieves core fleet-wide properties for fleets in an Amazon Web Services Region. Properties include the computing hardware and deployment configuration for instances in the fleet.

You can use this operation in the following ways:

  • To get attributes for 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

Parameter Syntax

$result = $client->describeFleetAttributes([
    'FleetIds' => ['<string>', ...],
    'Limit' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members
FleetIds
Type: Array of strings

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
Type: int

The maximum number of results to return. Use this parameter with NextToken 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
Type: string

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.

Result Syntax

[
    'FleetAttributes' => [
        [
            'AnywhereConfiguration' => [
                'Cost' => '<string>',
            ],
            'BuildArn' => '<string>',
            'BuildId' => '<string>',
            'CertificateConfiguration' => [
                'CertificateType' => 'DISABLED|GENERATED',
            ],
            'ComputeType' => 'EC2|ANYWHERE|CONTAINER',
            'ContainerGroupsAttributes' => [
                'ConnectionPortRange' => [
                    'FromPort' => <integer>,
                    'ToPort' => <integer>,
                ],
                'ContainerGroupDefinitionProperties' => [
                    [
                        'ContainerGroupDefinitionName' => '<string>',
                        'SchedulingStrategy' => 'REPLICA|DAEMON',
                    ],
                    // ...
                ],
                'ContainerGroupsPerInstance' => [
                    'DesiredReplicaContainerGroupsPerInstance' => <integer>,
                    'MaxReplicaContainerGroupsPerInstance' => <integer>,
                ],
            ],
            'CreationTime' => <DateTime>,
            'Description' => '<string>',
            'FleetArn' => '<string>',
            'FleetId' => '<string>',
            'FleetType' => 'ON_DEMAND|SPOT',
            'InstanceRoleArn' => '<string>',
            'InstanceRoleCredentialsProvider' => 'SHARED_CREDENTIAL_FILE',
            'InstanceType' => 't2.micro|t2.small|t2.medium|t2.large|c3.large|c3.xlarge|c3.2xlarge|c3.4xlarge|c3.8xlarge|c4.large|c4.xlarge|c4.2xlarge|c4.4xlarge|c4.8xlarge|c5.large|c5.xlarge|c5.2xlarge|c5.4xlarge|c5.9xlarge|c5.12xlarge|c5.18xlarge|c5.24xlarge|c5a.large|c5a.xlarge|c5a.2xlarge|c5a.4xlarge|c5a.8xlarge|c5a.12xlarge|c5a.16xlarge|c5a.24xlarge|r3.large|r3.xlarge|r3.2xlarge|r3.4xlarge|r3.8xlarge|r4.large|r4.xlarge|r4.2xlarge|r4.4xlarge|r4.8xlarge|r4.16xlarge|r5.large|r5.xlarge|r5.2xlarge|r5.4xlarge|r5.8xlarge|r5.12xlarge|r5.16xlarge|r5.24xlarge|r5a.large|r5a.xlarge|r5a.2xlarge|r5a.4xlarge|r5a.8xlarge|r5a.12xlarge|r5a.16xlarge|r5a.24xlarge|m3.medium|m3.large|m3.xlarge|m3.2xlarge|m4.large|m4.xlarge|m4.2xlarge|m4.4xlarge|m4.10xlarge|m5.large|m5.xlarge|m5.2xlarge|m5.4xlarge|m5.8xlarge|m5.12xlarge|m5.16xlarge|m5.24xlarge|m5a.large|m5a.xlarge|m5a.2xlarge|m5a.4xlarge|m5a.8xlarge|m5a.12xlarge|m5a.16xlarge|m5a.24xlarge|c5d.large|c5d.xlarge|c5d.2xlarge|c5d.4xlarge|c5d.9xlarge|c5d.12xlarge|c5d.18xlarge|c5d.24xlarge|c6a.large|c6a.xlarge|c6a.2xlarge|c6a.4xlarge|c6a.8xlarge|c6a.12xlarge|c6a.16xlarge|c6a.24xlarge|c6i.large|c6i.xlarge|c6i.2xlarge|c6i.4xlarge|c6i.8xlarge|c6i.12xlarge|c6i.16xlarge|c6i.24xlarge|r5d.large|r5d.xlarge|r5d.2xlarge|r5d.4xlarge|r5d.8xlarge|r5d.12xlarge|r5d.16xlarge|r5d.24xlarge|m6g.medium|m6g.large|m6g.xlarge|m6g.2xlarge|m6g.4xlarge|m6g.8xlarge|m6g.12xlarge|m6g.16xlarge|c6g.medium|c6g.large|c6g.xlarge|c6g.2xlarge|c6g.4xlarge|c6g.8xlarge|c6g.12xlarge|c6g.16xlarge|r6g.medium|r6g.large|r6g.xlarge|r6g.2xlarge|r6g.4xlarge|r6g.8xlarge|r6g.12xlarge|r6g.16xlarge|c6gn.medium|c6gn.large|c6gn.xlarge|c6gn.2xlarge|c6gn.4xlarge|c6gn.8xlarge|c6gn.12xlarge|c6gn.16xlarge|c7g.medium|c7g.large|c7g.xlarge|c7g.2xlarge|c7g.4xlarge|c7g.8xlarge|c7g.12xlarge|c7g.16xlarge|r7g.medium|r7g.large|r7g.xlarge|r7g.2xlarge|r7g.4xlarge|r7g.8xlarge|r7g.12xlarge|r7g.16xlarge|m7g.medium|m7g.large|m7g.xlarge|m7g.2xlarge|m7g.4xlarge|m7g.8xlarge|m7g.12xlarge|m7g.16xlarge|g5g.xlarge|g5g.2xlarge|g5g.4xlarge|g5g.8xlarge|g5g.16xlarge',
            'LogPaths' => ['<string>', ...],
            'MetricGroups' => ['<string>', ...],
            'Name' => '<string>',
            'NewGameSessionProtectionPolicy' => 'NoProtection|FullProtection',
            'OperatingSystem' => 'WINDOWS_2012|AMAZON_LINUX|AMAZON_LINUX_2|WINDOWS_2016|AMAZON_LINUX_2023',
            'ResourceCreationLimitPolicy' => [
                'NewGameSessionsPerCreator' => <integer>,
                'PolicyPeriodInMinutes' => <integer>,
            ],
            'ScriptArn' => '<string>',
            'ScriptId' => '<string>',
            'ServerLaunchParameters' => '<string>',
            'ServerLaunchPath' => '<string>',
            'Status' => 'NEW|DOWNLOADING|VALIDATING|BUILDING|ACTIVATING|ACTIVE|DELETING|ERROR|TERMINATED|NOT_FOUND',
            'StoppedActions' => ['<string>', ...],
            'TerminationTime' => <DateTime>,
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members
FleetAttributes
Type: Array of FleetAttributes structures

A collection of objects containing attribute metadata for each requested fleet ID. Attribute objects are returned only for fleets that currently exist.

NextToken
Type: string

A token that indicates where to resume retrieving results on the next call to this operation. If no token is returned, these results represent the end of the list.

Errors

InternalServiceException:

The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

NotFoundException:

THe requested resources was not found. The resource was either not created yet or deleted.

InvalidRequestException:

One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

UnauthorizedException:

The client failed authentication. Clients should not retry such requests.

DescribeFleetCapacity

$result = $client->describeFleetCapacity([/* ... */]);
$promise = $client->describeFleetCapacityAsync([/* ... */]);

This operation has been expanded to use with the Amazon GameLift containers feature, which is currently in public preview.

Retrieves the resource capacity settings for one or more fleets. For a container fleet, this operation also returns counts for replica container groups.

With multi-location fleets, this operation retrieves data for the fleet's home Region only. To retrieve capacity for remote locations, see DescribeFleetLocationCapacity.

This operation can be used in the following ways:

  • To get capacity data for one or more specific fleets, provide a list of fleet IDs or fleet ARNs.

  • To get capacity data for all fleets, do not provide a fleet identifier.

When requesting multiple fleets, use the pagination parameters to retrieve results as a set of sequential pages.

If successful, a FleetCapacity object is returned for each requested fleet ID. Each FleetCapacity object includes a Location property, which is set to the fleet's home Region. Capacity values are returned only for fleets that currently exist.

Some API operations may limit the number of fleet IDs that are allowed in one request. If a request exceeds this limit, the request fails and the error message includes the maximum allowed.

Learn more

Setting up Amazon GameLift fleets

GameLift metrics for fleets

Parameter Syntax

$result = $client->describeFleetCapacity([
    'FleetIds' => ['<string>', ...],
    'Limit' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members
FleetIds
Type: Array of strings

A unique identifier for the fleet to retrieve capacity information for. You can use either the fleet ID or ARN value. Leave this parameter empty to retrieve capacity information for all fleets.

Limit
Type: int

The maximum number of results to return. Use this parameter with NextToken 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
Type: string

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.

Result Syntax

[
    'FleetCapacity' => [
        [
            'FleetArn' => '<string>',
            'FleetId' => '<string>',
            'InstanceCounts' => [
                'ACTIVE' => <integer>,
                'DESIRED' => <integer>,
                'IDLE' => <integer>,
                'MAXIMUM' => <integer>,
                'MINIMUM' => <integer>,
                'PENDING' => <integer>,
                'TERMINATING' => <integer>,
            ],
            'InstanceType' => 't2.micro|t2.small|t2.medium|t2.large|c3.large|c3.xlarge|c3.2xlarge|c3.4xlarge|c3.8xlarge|c4.large|c4.xlarge|c4.2xlarge|c4.4xlarge|c4.8xlarge|c5.large|c5.xlarge|c5.2xlarge|c5.4xlarge|c5.9xlarge|c5.12xlarge|c5.18xlarge|c5.24xlarge|c5a.large|c5a.xlarge|c5a.2xlarge|c5a.4xlarge|c5a.8xlarge|c5a.12xlarge|c5a.16xlarge|c5a.24xlarge|r3.large|r3.xlarge|r3.2xlarge|r3.4xlarge|r3.8xlarge|r4.large|r4.xlarge|r4.2xlarge|r4.4xlarge|r4.8xlarge|r4.16xlarge|r5.large|r5.xlarge|r5.2xlarge|r5.4xlarge|r5.8xlarge|r5.12xlarge|r5.16xlarge|r5.24xlarge|r5a.large|r5a.xlarge|r5a.2xlarge|r5a.4xlarge|r5a.8xlarge|r5a.12xlarge|r5a.16xlarge|r5a.24xlarge|m3.medium|m3.large|m3.xlarge|m3.2xlarge|m4.large|m4.xlarge|m4.2xlarge|m4.4xlarge|m4.10xlarge|m5.large|m5.xlarge|m5.2xlarge|m5.4xlarge|m5.8xlarge|m5.12xlarge|m5.16xlarge|m5.24xlarge|m5a.large|m5a.xlarge|m5a.2xlarge|m5a.4xlarge|m5a.8xlarge|m5a.12xlarge|m5a.16xlarge|m5a.24xlarge|c5d.large|c5d.xlarge|c5d.2xlarge|c5d.4xlarge|c5d.9xlarge|c5d.12xlarge|c5d.18xlarge|c5d.24xlarge|c6a.large|c6a.xlarge|c6a.2xlarge|c6a.4xlarge|c6a.8xlarge|c6a.12xlarge|c6a.16xlarge|c6a.24xlarge|c6i.large|c6i.xlarge|c6i.2xlarge|c6i.4xlarge|c6i.8xlarge|c6i.12xlarge|c6i.16xlarge|c6i.24xlarge|r5d.large|r5d.xlarge|r5d.2xlarge|r5d.4xlarge|r5d.8xlarge|r5d.12xlarge|r5d.16xlarge|r5d.24xlarge|m6g.medium|m6g.large|m6g.xlarge|m6g.2xlarge|m6g.4xlarge|m6g.8xlarge|m6g.12xlarge|m6g.16xlarge|c6g.medium|c6g.large|c6g.xlarge|c6g.2xlarge|c6g.4xlarge|c6g.8xlarge|c6g.12xlarge|c6g.16xlarge|r6g.medium|r6g.large|r6g.xlarge|r6g.2xlarge|r6g.4xlarge|r6g.8xlarge|r6g.12xlarge|r6g.16xlarge|c6gn.medium|c6gn.large|c6gn.xlarge|c6gn.2xlarge|c6gn.4xlarge|c6gn.8xlarge|c6gn.12xlarge|c6gn.16xlarge|c7g.medium|c7g.large|c7g.xlarge|c7g.2xlarge|c7g.4xlarge|c7g.8xlarge|c7g.12xlarge|c7g.16xlarge|r7g.medium|r7g.large|r7g.xlarge|r7g.2xlarge|r7g.4xlarge|r7g.8xlarge|r7g.12xlarge|r7g.16xlarge|m7g.medium|m7g.large|m7g.xlarge|m7g.2xlarge|m7g.4xlarge|m7g.8xlarge|m7g.12xlarge|m7g.16xlarge|g5g.xlarge|g5g.2xlarge|g5g.4xlarge|g5g.8xlarge|g5g.16xlarge',
            'Location' => '<string>',
            'ReplicaContainerGroupCounts' => [
                'ACTIVE' => <integer>,
                'IDLE' => <integer>,
                'PENDING' => <integer>,
                'TERMINATING' => <integer>,
            ],
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members
FleetCapacity
Type: Array of FleetCapacity structures

A collection of objects that contains capacity information for each requested fleet ID. Capacity objects are returned only for fleets that currently exist. Changes in desired instance value can take up to 1 minute to be reflected.

NextToken
Type: string

A token that indicates where to resume retrieving results on the next call to this operation. If no token is returned, these results represent the end of the list.

Errors

InternalServiceException:

The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

NotFoundException:

THe requested resources was not found. The resource was either not created yet or deleted.

InvalidRequestException:

One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

UnauthorizedException:

The client failed authentication. Clients should not retry such requests.

DescribeFleetEvents

$result = $client->describeFleetEvents([/* ... */]);
$promise = $client->describeFleetEventsAsync([/* ... */]);

Retrieves entries from a fleet's event log. Fleet events are initiated by changes in status, such as during fleet creation and termination, changes in capacity, etc. If a fleet has multiple locations, events are also initiated by changes to status and capacity in remote locations.

You can specify a time range to limit the result set. Use the pagination parameters to retrieve results as a set of sequential pages.

If successful, a collection of event log entries matching the request are returned.

Learn more

Setting up Amazon GameLift fleets

Parameter Syntax

$result = $client->describeFleetEvents([
    'EndTime' => <integer || string || DateTime>,
    'FleetId' => '<string>', // REQUIRED
    'Limit' => <integer>,
    'NextToken' => '<string>',
    'StartTime' => <integer || string || DateTime>,
]);

Parameter Details

Members
EndTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The most recent date to retrieve event logs for. If no end time is specified, this call returns entries from the specified start time up to the present. Format is a number expressed in Unix time as milliseconds (ex: "1469498468.057").

FleetId
Required: Yes
Type: string

A unique identifier for the fleet to get event logs for. You can use either the fleet ID or ARN value.

Limit
Type: int

The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

NextToken
Type: string

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.

StartTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The earliest date to retrieve event logs for. If no start time is specified, this call returns entries starting from when the fleet was created to the specified end time. Format is a number expressed in Unix time as milliseconds (ex: "1469498468.057").

Result Syntax

[
    'Events' => [
        [
            'Count' => <integer>,
            'EventCode' => 'GENERIC_EVENT|FLEET_CREATED|FLEET_DELETED|FLEET_SCALING_EVENT|FLEET_STATE_DOWNLOADING|FLEET_STATE_VALIDATING|FLEET_STATE_BUILDING|FLEET_STATE_ACTIVATING|FLEET_STATE_ACTIVE|FLEET_STATE_ERROR|FLEET_INITIALIZATION_FAILED|FLEET_BINARY_DOWNLOAD_FAILED|FLEET_VALIDATION_LAUNCH_PATH_NOT_FOUND|FLEET_VALIDATION_EXECUTABLE_RUNTIME_FAILURE|FLEET_VALIDATION_TIMED_OUT|FLEET_ACTIVATION_FAILED|FLEET_ACTIVATION_FAILED_NO_INSTANCES|FLEET_NEW_GAME_SESSION_PROTECTION_POLICY_UPDATED|SERVER_PROCESS_INVALID_PATH|SERVER_PROCESS_SDK_INITIALIZATION_TIMEOUT|SERVER_PROCESS_PROCESS_READY_TIMEOUT|SERVER_PROCESS_CRASHED|SERVER_PROCESS_TERMINATED_UNHEALTHY|SERVER_PROCESS_FORCE_TERMINATED|SERVER_PROCESS_PROCESS_EXIT_TIMEOUT|GAME_SESSION_ACTIVATION_TIMEOUT|FLEET_CREATION_EXTRACTING_BUILD|FLEET_CREATION_RUNNING_INSTALLER|FLEET_CREATION_VALIDATING_RUNTIME_CONFIG|FLEET_VPC_PEERING_SUCCEEDED|FLEET_VPC_PEERING_FAILED|FLEET_VPC_PEERING_DELETED|INSTANCE_INTERRUPTED|INSTANCE_RECYCLED',
            'EventId' => '<string>',
            'EventTime' => <DateTime>,
            'Message' => '<string>',
            'PreSignedLogUrl' => '<string>',
            'ResourceId' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members
Events
Type: Array of Event structures

A collection of objects containing event log entries for the specified fleet.

NextToken
Type: string

A token that indicates where to resume retrieving results on the next call to this operation. If no token is returned, these results represent the end of the list.

Errors

NotFoundException:

THe requested resources was not found. The resource was either not created yet or deleted.

InternalServiceException:

The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

UnauthorizedException:

The client failed authentication. Clients should not retry such requests.

InvalidRequestException:

One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

DescribeFleetLocationAttributes

$result = $client->describeFleetLocationAttributes([/* ... */]);
$promise = $client->describeFleetLocationAttributesAsync([/* ... */]);

Retrieves information on a fleet's remote locations, including life-cycle status and any suspended fleet activity.

This operation can be used in the following ways:

  • To get data for specific locations, provide a fleet identifier and a list of locations. Location data is returned in the order that it is requested.

  • To get data for all locations, provide a fleet identifier only. Location data is returned in no particular order.

When requesting attributes for multiple locations, use the pagination parameters to retrieve results as a set of sequential pages.

If successful, a LocationAttributes object is returned for each requested location. If the fleet does not have a requested location, no information is returned. This operation does not return the home Region. To get information on a fleet's home Region, call DescribeFleetAttributes.

Learn more

Setting up Amazon GameLift fleets

Parameter Syntax

$result = $client->describeFleetLocationAttributes([
    'FleetId' => '<string>', // REQUIRED
    'Limit' => <integer>,
    'Locations' => ['<string>', ...],
    'NextToken' => '<string>',
]);

Parameter Details

Members
FleetId
Required: Yes
Type: string

A unique identifier for the fleet to retrieve remote locations for. You can use either the fleet ID or ARN value.

Limit
Type: int

The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages. This limit is not currently enforced.

Locations
Type: Array of strings

A list of fleet locations to retrieve information for. Specify locations in the form of an Amazon Web Services Region code, such as us-west-2.

NextToken
Type: string

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.

Result Syntax

[
    'FleetArn' => '<string>',
    'FleetId' => '<string>',
    'LocationAttributes' => [
        [
            'LocationState' => [
                'Location' => '<string>',
                'Status' => 'NEW|DOWNLOADING|VALIDATING|BUILDING|ACTIVATING|ACTIVE|DELETING|ERROR|TERMINATED|NOT_FOUND',
            ],
            'StoppedActions' => ['<string>', ...],
            'UpdateStatus' => 'PENDING_UPDATE',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members
FleetArn
Type: string

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.

FleetId
Type: string

A unique identifier for the fleet that location attributes were requested for.

LocationAttributes
Type: Array of LocationAttributes structures

Location-specific information on the requested fleet's remote locations.

NextToken
Type: string

A token that indicates where to resume retrieving results on the next call to this operation. If no token is returned, these results represent the end of the list.

Errors

InternalServiceException:

The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

InvalidRequestException:

One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

UnauthorizedException:

The client failed authentication. Clients should not retry such requests.

NotFoundException:

THe requested resources was not found. The resource was either not created yet or deleted.

UnsupportedRegionException:

The requested operation is not supported in the Region specified.

DescribeFleetLocationCapacity

$result = $client->describeFleetLocationCapacity([/* ... */]);
$promise = $client->describeFleetLocationCapacityAsync([/* ... */]);

Retrieves the resource capacity settings for a fleet location. The data returned includes the current capacity (number of EC2 instances) and some scaling settings for the requested fleet location. For a container fleet, this operation also returns counts for replica container groups.

Use this operation to retrieve capacity information for a fleet's remote location or home Region (you can also retrieve home Region capacity by calling DescribeFleetCapacity).

To retrieve capacity data, identify a fleet and location.

If successful, a FleetCapacity object is returned for the requested fleet location.

Learn more

Setting up Amazon GameLift fleets

GameLift metrics for fleets

Parameter Syntax

$result = $client->describeFleetLocationCapacity([
    'FleetId' => '<string>', // REQUIRED
    'Location' => '<string>', // REQUIRED
]);

Parameter Details

Members
FleetId
Required: Yes
Type: string

A unique identifier for the fleet to request location capacity for. You can use either the fleet ID or ARN value.

Location
Required: Yes
Type: string

The fleet location to retrieve capacity information for. Specify a location in the form of an Amazon Web Services Region code, such as us-west-2.

Result Syntax

[
    'FleetCapacity' => [
        'FleetArn' => '<string>',
        'FleetId' => '<string>',
        'InstanceCounts' => [
            'ACTIVE' => <integer>,
            'DESIRED' => <integer>,
            'IDLE' => <integer>,
            'MAXIMUM' => <integer>,
            'MINIMUM' => <integer>,
            'PENDING' => <integer>,
            'TERMINATING' => <integer>,
        ],
        'InstanceType' => 't2.micro|t2.small|t2.medium|t2.large|c3.large|c3.xlarge|c3.2xlarge|c3.4xlarge|c3.8xlarge|c4.large|c4.xlarge|c4.2xlarge|c4.4xlarge|c4.8xlarge|c5.large|c5.xlarge|c5.2xlarge|c5.4xlarge|c5.9xlarge|c5.12xlarge|c5.18xlarge|c5.24xlarge|c5a.large|c5a.xlarge|c5a.2xlarge|c5a.4xlarge|c5a.8xlarge|c5a.12xlarge|c5a.16xlarge|c5a.24xlarge|r3.large|r3.xlarge|r3.2xlarge|r3.4xlarge|r3.8xlarge|r4.large|r4.xlarge|r4.2xlarge|r4.4xlarge|r4.8xlarge|r4.16xlarge|r5.large|r5.xlarge|r5.2xlarge|r5.4xlarge|r5.8xlarge|r5.12xlarge|r5.16xlarge|r5.24xlarge|r5a.large|r5a.xlarge|r5a.2xlarge|r5a.4xlarge|r5a.8xlarge|r5a.12xlarge|r5a.16xlarge|r5a.24xlarge|m3.medium|m3.large|m3.xlarge|m3.2xlarge|m4.large|m4.xlarge|m4.2xlarge|m4.4xlarge|m4.10xlarge|m5.large|m5.xlarge|m5.2xlarge|m5.4xlarge|m5.8xlarge|m5.12xlarge|m5.16xlarge|m5.24xlarge|m5a.large|m5a.xlarge|m5a.2xlarge|m5a.4xlarge|m5a.8xlarge|m5a.12xlarge|m5a.16xlarge|m5a.24xlarge|c5d.large|c5d.xlarge|c5d.2xlarge|c5d.4xlarge|c5d.9xlarge|c5d.12xlarge|c5d.18xlarge|c5d.24xlarge|c6a.large|c6a.xlarge|c6a.2xlarge|c6a.4xlarge|c6a.8xlarge|c6a.12xlarge|c6a.16xlarge|c6a.24xlarge|c6i.large|c6i.xlarge|c6i.2xlarge|c6i.4xlarge|c6i.8xlarge|c6i.12xlarge|c6i.16xlarge|c6i.24xlarge|r5d.large|r5d.xlarge|r5d.2xlarge|r5d.4xlarge|r5d.8xlarge|r5d.12xlarge|r5d.16xlarge|r5d.24xlarge|m6g.medium|m6g.large|m6g.xlarge|m6g.2xlarge|m6g.4xlarge|m6g.8xlarge|m6g.12xlarge|m6g.16xlarge|c6g.medium|c6g.large|c6g.xlarge|c6g.2xlarge|c6g.4xlarge|c6g.8xlarge|c6g.12xlarge|c6g.16xlarge|r6g.medium|r6g.large|r6g.xlarge|r6g.2xlarge|r6g.4xlarge|r6g.8xlarge|r6g.12xlarge|r6g.16xlarge|c6gn.medium|c6gn.large|c6gn.xlarge|c6gn.2xlarge|c6gn.4xlarge|c6gn.8xlarge|c6gn.12xlarge|c6gn.16xlarge|c7g.medium|c7g.large|c7g.xlarge|c7g.2xlarge|c7g.4xlarge|c7g.8xlarge|c7g.12xlarge|c7g.16xlarge|r7g.medium|r7g.large|r7g.xlarge|r7g.2xlarge|r7g.4xlarge|r7g.8xlarge|r7g.12xlarge|r7g.16xlarge|m7g.medium|m7g.large|m7g.xlarge|m7g.2xlarge|m7g.4xlarge|m7g.8xlarge|m7g.12xlarge|m7g.16xlarge|g5g.xlarge|g5g.2xlarge|g5g.4xlarge|g5g.8xlarge|g5g.16xlarge',
        'Location' => '<string>',
        'ReplicaContainerGroupCounts' => [
            'ACTIVE' => <integer>,
            'IDLE' => <integer>,
            'PENDING' => <integer>,
            'TERMINATING' => <integer>,
        ],
    ],
]

Result Details

Members
FleetCapacity
Type: FleetCapacity structure

Resource capacity information for the requested fleet location. Capacity objects are returned only for fleets and locations that currently exist. Changes in desired instance value can take up to 1 minute to be reflected.

Errors

InternalServiceException:

The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

InvalidRequestException:

One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

UnauthorizedException:

The client failed authentication. Clients should not retry such requests.

NotFoundException:

THe requested resources was not found. The resource was either not created yet or deleted.

UnsupportedRegionException:

The requested operation is not supported in the Region specified.

DescribeFleetLocationUtilization

$result = $client->describeFleetLocationUtilization([/* ... */]);
$promise = $client->describeFleetLocationUtilizationAsync([/* ... */]);

Retrieves current usage data for a fleet location. Utilization data provides a snapshot of current game hosting activity at the requested location. Use this operation to retrieve utilization information for a fleet's remote location or home Region (you can also retrieve home Region utilization by calling DescribeFleetUtilization).

To retrieve utilization data, identify a fleet and location.

If successful, a FleetUtilization object is returned for the requested fleet location.

Learn more

Setting up Amazon GameLift fleets

GameLift metrics for fleets

Parameter Syntax

$result = $client->describeFleetLocationUtilization([
    'FleetId' => '<string>', // REQUIRED
    'Location' => '<string>', // REQUIRED
]);

Parameter Details

Members
FleetId
Required: Yes
Type: string

A unique identifier for the fleet to request location utilization for. You can use either the fleet ID or ARN value.

Location
Required: Yes
Type: string

The fleet location to retrieve utilization information for. Specify a location in the form of an Amazon Web Services Region code, such as us-west-2.

Result Syntax

[
    'FleetUtilization' => [
        'ActiveGameSessionCount' => <integer>,
        'ActiveServerProcessCount' => <integer>,
        'CurrentPlayerSessionCount' => <integer>,
        'FleetArn' => '<string>',
        'FleetId' => '<string>',
        'Location' => '<string>',
        'MaximumPlayerSessionCount' => <integer>,
    ],
]

Result Details

Members
FleetUtilization
Type: FleetUtilization structure

Utilization information for the requested fleet location. Utilization objects are returned only for fleets and locations that currently exist.

Errors

InternalServiceException:

The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

InvalidRequestException:

One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

UnauthorizedException:

The client failed authentication. Clients should not retry such requests.

NotFoundException:

THe requested resources was not found. The resource was either not created yet or deleted.

UnsupportedRegionException:

The requested operation is not supported in the Region specified.

DescribeFleetPortSettings

$result = $client->describeFleetPortSettings([/* ... */]);
$promise = $client->describeFleetPortSettingsAsync([/* ... */]);

Retrieves a fleet's inbound connection permissions. Connection permissions specify IP addresses and port settings that incoming traffic can use to access server processes in the fleet. Game server processes that are running in the fleet must use a port that falls within this range. To connect to game server processes on a container fleet, the port settings should include one or more of the fleet's connection ports.

Use this operation in the following ways:

  • To retrieve the port settings for a fleet, identify the fleet's unique identifier.

  • To check the status of recent updates to a fleet remote location, specify the fleet ID and a location. Port setting updates can take time to propagate across all locations.

If successful, a set of IpPermission objects is returned for the requested fleet ID. When specifying a location, this operation returns a pending status. If the requested fleet has been deleted, the result set is empty.

Learn more

Setting up Amazon GameLift fleets

Parameter Syntax

$result = $client->describeFleetPortSettings([
    'FleetId' => '<string>', // REQUIRED
    'Location' => '<string>',
]);

Parameter Details

Members
FleetId
Required: Yes
Type: string

A unique identifier for the fleet to retrieve port settings for. You can use either the fleet ID or ARN value.

Location
Type: string

A remote location to check for status of port setting updates. Use the Amazon Web Services Region code format, such as us-west-2.

Result Syntax

[
    'FleetArn' => '<string>',
    'FleetId' => '<string>',
    'InboundPermissions' => [
        [
            'FromPort' => <integer>,
            'IpRange' => '<string>',
            'Protocol' => 'TCP|UDP',
            'ToPort' => <integer>,
        ],
        // ...
    ],
    'Location' => '<string>',
    'UpdateStatus' => 'PENDING_UPDATE',
]

Result Details

Members
FleetArn
Type: string

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.

FleetId
Type: string

A unique identifier for the fleet that was requested.

InboundPermissions
Type: Array of IpPermission structures

The port settings for the requested fleet ID.

Location
Type: string

The requested fleet location, expressed as an Amazon Web Services Region code, such as us-west-2.

UpdateStatus
Type: string

The current status of updates to the fleet's port settings in the requested fleet location. A status of PENDING_UPDATE indicates that an update was requested for the fleet but has not yet been completed for the location.

Errors

InternalServiceException:

The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

NotFoundException:

THe requested resources was not found. The resource was either not created yet or deleted.

InvalidRequestException:

One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

UnauthorizedException:

The client failed authentication. Clients should not retry such requests.

UnsupportedRegionException:

The requested operation is not supported in the Region specified.

DescribeFleetUtilization

$result = $client->describeFleetUtilization([/* ... */]);
$promise = $client->describeFleetUtilizationAsync([/* ... */]);

Retrieves utilization statistics for one or more fleets. Utilization data provides a snapshot of how the fleet's hosting resources are currently being used. For fleets with remote locations, this operation retrieves data for the fleet's home Region only. See DescribeFleetLocationUtilization to get utilization statistics for a fleet's remote locations.

This operation can be used in the following ways:

  • To get utilization data for one or more specific fleets, provide a list of fleet IDs or fleet ARNs.

  • To get utilization data for all fleets, do not provide a fleet identifier.

When requesting multiple fleets, use the pagination parameters to retrieve results as a set of sequential pages.

If successful, a FleetUtilization object is returned for each requested fleet ID, unless the fleet identifier is not found. Each fleet utilization object includes a Location property, which is set to the fleet's home Region.

Some API operations may limit the number of fleet IDs allowed in one request. If a request exceeds this limit, the request fails and the error message includes the maximum allowed.

Learn more

Setting up Amazon GameLift Fleets

GameLift Metrics for Fleets

Parameter Syntax

$result = $client->describeFleetUtilization([
    'FleetIds' => ['<string>', ...],
    'Limit' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members
FleetIds
Type: Array of strings

A unique identifier for the fleet to retrieve utilization data for. You can use either the fleet ID or ARN value. To retrieve attributes for all current fleets, do not include this parameter.

Limit
Type: int

The maximum number of results to return. Use this parameter with NextToken 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
Type: string

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.

Result Syntax

[
    'FleetUtilization' => [
        [
            'ActiveGameSessionCount' => <integer>,
            'ActiveServerProcessCount' => <integer>,
            'CurrentPlayerSessionCount' => <integer>,
            'FleetArn' => '<string>',
            'FleetId' => '<string>',
            'Location' => '<string>',
            'MaximumPlayerSessionCount' => <integer>,
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members
FleetUtilization
Type: Array of FleetUtilization structures

A collection of objects containing utilization information for each requested fleet ID. Utilization objects are returned only for fleets that currently exist.

NextToken
Type: string

A token that indicates where to resume retrieving results on the next call to this operation. If no token is returned, these results represent the end of the list.

Errors

InternalServiceException:

The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

NotFoundException:

THe requested resources was not found. The resource was either not created yet or deleted.

InvalidRequestException:

One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

UnauthorizedException:

The client failed authentication. Clients should not retry such requests.

DescribeGameServer

$result = $client->describeGameServer([/* ... */]);
$promise = $client->describeGameServerAsync([/* ... */]);

This operation is used with the Amazon GameLift FleetIQ solution and game server groups.

Retrieves information for a registered game server. Information includes game server status, health check info, and the instance that the game server is running on.

To retrieve game server information, specify the game server ID. If successful, the requested game server object is returned.

Learn more

Amazon GameLift FleetIQ Guide

Parameter Syntax

$result = $client->describeGameServer([
    'GameServerGroupName' => '<string>', // REQUIRED
    'GameServerId' => '<string>', // REQUIRED
]);

Parameter Details

Members
GameServerGroupName
Required: Yes
Type: string

A unique identifier for the game server group where the game server is running.

GameServerId
Required: Yes
Type: string

A custom string that uniquely identifies the game server information to be retrieved.

Result Syntax

[
    'GameServer' => [
        'ClaimStatus' => 'CLAIMED',
        'ConnectionInfo' => '<string>',
        'GameServerData' => '<string>',
        'GameServerGroupArn' => '<string>',
        'GameServerGroupName' => '<string>',
        'GameServerId' => '<string>',
        'InstanceId' => '<string>',
        'LastClaimTime' => <DateTime>,
        'LastHealthCheckTime' => <DateTime>,
        'RegistrationTime' => <DateTime>,
        'UtilizationStatus' => 'AVAILABLE|UTILIZED',
    ],
]

Result Details

Members
GameServer
Type: GameServer structure

Object that describes the requested game server.

Errors

InvalidRequestException:

One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

NotFoundException:

THe requested resources was not found. The resource was either not created yet or deleted.

UnauthorizedException:

The client failed authentication. Clients should not retry such requests.

InternalServiceException:

The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

DescribeGameServerGroup

$result = $client->describeGameServerGroup([/* ... */]);
$promise = $client->describeGameServerGroupAsync([/* ... */]);

This operation is used with the Amazon GameLift FleetIQ solution and game server groups.

Retrieves information on a game server group. This operation returns only properties related to Amazon GameLift FleetIQ. To view or update properties for the corresponding Auto Scaling group, such as launch template, auto scaling policies, and maximum/minimum group size, access the Auto Scaling group directly.

To get attributes for a game server group, provide a group name or ARN value. If successful, a GameServerGroup object is returned.

Learn more

Amazon GameLift FleetIQ Guide

Parameter Syntax

$result = $client->describeGameServerGroup([
    'GameServerGroupName' => '<string>', // REQUIRED
]);

Parameter Details

Members
GameServerGroupName
Required: Yes
Type: string

A unique identifier for the game server group. Use either the name or ARN value.

Result Syntax

[
    'GameServerGroup' => [
        'AutoScalingGroupArn' => '<string>',
        'BalancingStrategy' => 'SPOT_ONLY|SPOT_PREFERRED|ON_DEMAND_ONLY',
        'CreationTime' => <DateTime>,
        'GameServerGroupArn' => '<string>',
        'GameServerGroupName' => '<string>',
        'GameServerProtectionPolicy' => 'NO_PROTECTION|FULL_PROTECTION',
        'InstanceDefinitions' => [
            [
                'InstanceType' => 'c4.large|c4.xlarge|c4.2xlarge|c4.4xlarge|c4.8xlarge|c5.large|c5.xlarge|c5.2xlarge|c5.4xlarge|c5.9xlarge|c5.12xlarge|c5.18xlarge|c5.24xlarge|c5a.large|c5a.xlarge|c5a.2xlarge|c5a.4xlarge|c5a.8xlarge|c5a.12xlarge|c5a.16xlarge|c5a.24xlarge|c6g.medium|c6g.large|c6g.xlarge|c6g.2xlarge|c6g.4xlarge|c6g.8xlarge|c6g.12xlarge|c6g.16xlarge|r4.large|r4.xlarge|r4.2xlarge|r4.4xlarge|r4.8xlarge|r4.16xlarge|r5.large|r5.xlarge|r5.2xlarge|r5.4xlarge|r5.8xlarge|r5.12xlarge|r5.16xlarge|r5.24xlarge|r5a.large|r5a.xlarge|r5a.2xlarge|r5a.4xlarge|r5a.8xlarge|r5a.12xlarge|r5a.16xlarge|r5a.24xlarge|r6g.medium|r6g.large|r6g.xlarge|r6g.2xlarge|r6g.4xlarge|r6g.8xlarge|r6g.12xlarge|r6g.16xlarge|m4.large|m4.xlarge|m4.2xlarge|m4.4xlarge|m4.10xlarge|m5.large|m5.xlarge|m5.2xlarge|m5.4xlarge|m5.8xlarge|m5.12xlarge|m5.16xlarge|m5.24xlarge|m5a.large|m5a.xlarge|m5a.2xlarge|m5a.4xlarge|m5a.8xlarge|m5a.12xlarge|m5a.16xlarge|m5a.24xlarge|m6g.medium|m6g.large|m6g.xlarge|m6g.2xlarge|m6g.4xlarge|m6g.8xlarge|m6g.12xlarge|m6g.16xlarge',
                'WeightedCapacity' => '<string>',
            ],
            // ...
        ],
        'LastUpdatedTime' => <DateTime>,
        'RoleArn' => '<string>',
        'Status' => 'NEW|ACTIVATING|ACTIVE|DELETE_SCHEDULED|DELETING|DELETED|ERROR',
        'StatusReason' => '<string>',
        'SuspendedActions' => ['<string>', ...],
    ],
]

Result Details

Members
GameServerGroup
Type: GameServerGroup structure

An object with the property settings for the requested game server group resource.

Errors

InvalidRequestException:

One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

NotFoundException:

THe requested resources was not found. The resource was either not created yet or deleted.

UnauthorizedException:

The client failed authentication. Clients should not retry such requests.

InternalServiceException:

The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

DescribeGameServerInstances

$result = $client->describeGameServerInstances([/* ... */]);
$promise = $client->describeGameServerInstancesAsync([/* ... */]);

This operation is used with the Amazon GameLift FleetIQ solution and game server groups.

Retrieves status information about the Amazon EC2 instances associated with a Amazon GameLift FleetIQ game server group. Use this operation to detect when instances are active or not available to host new game servers.

To request status for all instances in the game server group, provide a game server group ID only. To request status for specific instances, provide the game server group ID and one or more instance IDs. Use the pagination parameters to retrieve results in sequential segments. If successful, a collection of GameServerInstance objects is returned.

This operation is not designed to be called with every game server claim request; this practice can cause you to exceed your API limit, which results in errors. Instead, as a best practice, cache the results and refresh your cache no more than once every 10 seconds.

Learn more

Amazon GameLift FleetIQ Guide

Parameter Syntax

$result = $client->describeGameServerInstances([
    'GameServerGroupName' => '<string>', // REQUIRED
    'InstanceIds' => ['<string>', ...],
    'Limit' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members
GameServerGroupName
Required: Yes
Type: string

A unique identifier for the game server group. Use either the name or ARN value.

InstanceIds
Type: Array of strings

The Amazon EC2 instance IDs that you want to retrieve status on. Amazon EC2 instance IDs use a 17-character format, for example: i-1234567890abcdef0. To retrieve all instances in the game server group, leave this parameter empty.

Limit
Type: int

The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

NextToken
Type: string

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.

Result Syntax

[
    'GameServerInstances' => [
        [
            'GameServerGroupArn' => '<string>',
            'GameServerGroupName' => '<string>',
            'InstanceId' => '<string>',
            'InstanceStatus' => 'ACTIVE|DRAINING|SPOT_TERMINATING',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members
GameServerInstances
Type: Array of GameServerInstance structures

The collection of requested game server instances.

NextToken
Type: string

A token that indicates where to resume retrieving results on the next call to this operation. If no token is returned, these results represent the end of the list.

Errors

InvalidRequestException:

One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

NotFoundException:

THe requested resources was not found. The resource was either not created yet or deleted.

UnauthorizedException:

The client failed authentication. Clients should not retry such requests.

InternalServiceException:

The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

DescribeGameSessionDetails

$result = $client->describeGameSessionDetails([/* ... */]);
$promise = $client->describeGameSessionDetailsAsync([/* ... */]);

Retrieves additional game session properties, including the game session protection policy in force, a set of one or more game sessions in a specific fleet location. You can optionally filter the results by current game session status.

This operation can be used in the following ways:

  • To retrieve details for all game sessions that are currently running on all locations in a fleet, provide a fleet or alias ID, with an optional status filter. This approach returns details from the fleet's home Region and all remote locations.

  • To retrieve details for all game sessions that are currently running on a specific fleet location, provide a fleet or alias ID and a location name, with optional status filter. The location can be the fleet's home Region or any remote location.

  • To retrieve details for a specific game session, provide the game session ID. This approach looks for the game session ID in all fleets that reside in the Amazon Web Services Region defined in the request.

Use the pagination parameters to retrieve results as a set of sequential pages.

If successful, a GameSessionDetail object is returned for each game session that matches the request.

Learn more

Find a game session

All APIs by task

Parameter Syntax

$result = $client->describeGameSessionDetails([
    'AliasId' => '<string>',
    'FleetId' => '<string>',
    'GameSessionId' => '<string>',
    'Limit' => <integer>,
    'Location' => '<string>',
    'NextToken' => '<string>',
    'StatusFilter' => '<string>',
]);

Parameter Details

Members
AliasId
Type: string

A unique identifier for the alias associated with the fleet to retrieve all game sessions for. You can use either the alias ID or ARN value.

FleetId
Type: string

A unique identifier for the fleet to retrieve all game sessions active on the fleet. You can use either the fleet ID or ARN value.

GameSessionId
Type: string

A unique identifier for the game session to retrieve.

Limit
Type: int

The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

Location
Type: string

A fleet location to get game session details for. You can specify a fleet's home Region or a remote location. Use the Amazon Web Services Region code format, such as us-west-2.

NextToken
Type: string

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.

StatusFilter
Type: string

Game session status to filter results on. Possible game session statuses include ACTIVE, TERMINATED, ACTIVATING and TERMINATING (the last two are transitory).

Result Syntax

[
    'GameSessionDetails' => [
        [
            'GameSession' => [
                'CreationTime' => <DateTime>,
                'CreatorId' => '<string>',
                'CurrentPlayerSessionCount' => <integer>,
                'DnsName' => '<string>',
                'FleetArn' => '<string>',
                'FleetId' => '<string>',
                'GameProperties' => [
                    [
                        'Key' => '<string>',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
                'GameSessionData' => '<string>',
                'GameSessionId' => '<string>',
                'IpAddress' => '<string>',
                'Location' => '<string>',
                'MatchmakerData' => '<string>',
                'MaximumPlayerSessionCount' => <integer>,
                'Name' => '<string>',
                'PlayerSessionCreationPolicy' => 'ACCEPT_ALL|DENY_ALL',
                'Port' => <integer>,
                'Status' => 'ACTIVE|ACTIVATING|TERMINATED|TERMINATING|ERROR',
                'StatusReason' => 'INTERRUPTED',
                'TerminationTime' => <DateTime>,
            ],
            'ProtectionPolicy' => 'NoProtection|FullProtection',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members
GameSessionDetails
Type: Array of GameSessionDetail structures

A collection of properties for each game session that matches the request.

NextToken
Type: string

A token that indicates where to resume retrieving results on the next call to this operation. If no token is returned, these results represent the end of the list.

Errors

InternalServiceException:

The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

NotFoundException:

THe requested resources was not found. The resource was either not created yet or deleted.

InvalidRequestException:

One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

UnauthorizedException:

The client failed authentication. Clients should not retry such requests.

TerminalRoutingStrategyException:

The service is unable to resolve the routing for a particular alias because it has a terminal RoutingStrategy associated with it. The message returned in this exception is the message defined in the routing strategy itself. Such requests should only be retried if the routing strategy for the specified alias is modified.

UnsupportedRegionException:

The requested operation is not supported in the Region specified.

DescribeGameSessionPlacement

$result = $client->describeGameSessionPlacement([/* ... */]);
$promise = $client->describeGameSessionPlacementAsync([/* ... */]);

Retrieves information, including current status, about a game session placement request.

To get game session placement details, specify the placement ID.

This operation is not designed to be continually called to track game session status. This practice can cause you to exceed your API limit, which results in errors. Instead, you must configure configure an Amazon Simple Notification Service (SNS) topic to receive notifications from FlexMatch or queues. Continuously polling with DescribeGameSessionPlacement should only be used for games in development with low game session usage.

Parameter Syntax

$result = $client->describeGameSessionPlacement([
    'PlacementId' => '<string>', // REQUIRED
]);

Parameter Details

Members
PlacementId
Required: Yes
Type: string

A unique identifier for a game session placement to retrieve.

Result Syntax

[
    'GameSessionPlacement' => [
        'DnsName' => '<string>',
        'EndTime' => <DateTime>,
        'GameProperties' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
        'GameSessionArn' => '<string>',
        'GameSessionData' => '<string>',
        'GameSessionId' => '<string>',
        'GameSessionName' => '<string>',
        'GameSessionQueueName' => '<string>',
        'GameSessionRegion' => '<string>',
        'IpAddress' => '<string>',
        'MatchmakerData' => '<string>',
        'MaximumPlayerSessionCount' => <integer>,
        'PlacedPlayerSessions' => [
            [
                'PlayerId' => '<string>',
                'PlayerSessionId' => '<string>',
            ],
            // ...
        ],
        'PlacementId' => '<string>',
        'PlayerLatencies' => [
            [
                'LatencyInMilliseconds' => <float>,
                'PlayerId' => '<string>',
                'RegionIdentifier' => '<string>',
            ],
            // ...
        ],
        'Port' => <integer>,
        'StartTime' => <DateTime>,
        'Status' => 'PENDING|FULFILLED|CANCELLED|TIMED_OUT|FAILED',
    ],
]

Result Details

Members
GameSessionPlacement
Type: GameSessionPlacement structure

Object that describes the requested game session placement.

Errors

InternalServiceException:

The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

InvalidRequestException:

One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

NotFoundException:

THe requested resources was not found. The resource was either not created yet or deleted.

UnauthorizedException:

The client failed authentication. Clients should not retry such requests.

DescribeGameSessionQueues

$result = $client->describeGameSessionQueues([/* ... */]);
$promise = $client->describeGameSessionQueuesAsync([/* ... */]);

Retrieves the properties for one or more game session queues. When requesting multiple queues, use the pagination parameters to retrieve results as a set of sequential pages. When specifying a list of queues, objects are returned only for queues that currently exist in the Region.

Learn more

View Your Queues

Parameter Syntax

$result = $client->describeGameSessionQueues([
    'Limit' => <integer>,
    'Names' => ['<string>', ...],
    'NextToken' => '<string>',
]);

Parameter Details

Members
Limit
Type: int

The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages. You can request up to 50 results.

Names
Type: Array of strings

A list of queue names to retrieve information for. You can use either the queue ID or ARN value. To request settings for all queues, leave this parameter empty.

NextToken
Type: string

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.

Result Syntax

[
    'GameSessionQueues' => [
        [
            'CustomEventData' => '<string>',
            'Destinations' => [
                [
                    'DestinationArn' => '<string>',
                ],
                // ...
            ],
            'FilterConfiguration' => [
                'AllowedLocations' => ['<string>', ...],
            ],
            'GameSessionQueueArn' => '<string>',
            'Name' => '<string>',
            'NotificationTarget' => '<string>',
            'PlayerLatencyPolicies' => [
                [
                    'MaximumIndividualPlayerLatencyMilliseconds' => <integer>,
                    'PolicyDurationSeconds' => <integer>,
                ],
                // ...
            ],
            'PriorityConfiguration' => [
                'LocationOrder' => ['<string>', ...],
                'PriorityOrder' => ['<string>', ...],
            ],
            'TimeoutInSeconds' => <integer>,
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members
GameSessionQueues
Type: Array of GameSessionQueue structures

A collection of objects that describe the requested game session queues.

NextToken
Type: string

A token that indicates where to resume retrieving results on the next call to this operation. If no token is returned, these results represent the end of the list.

Errors

InternalServiceException:

The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

InvalidRequestException:

One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

NotFoundException:

THe requested resources was not found. The resource was either not created yet or deleted.

UnauthorizedException:

The client failed authentication. Clients should not retry such requests.

DescribeGameSessions

$result = $client->describeGameSessions([/* ... */]);
$promise = $client->describeGameSessionsAsync([/* ... */]);

Retrieves a set of one or more game sessions in a specific fleet location. You can optionally filter the results by current game session status.

This operation can be used in the following ways:

  • To retrieve all game sessions that are currently running on all locations in a fleet, provide a fleet or alias ID, with an optional status filter. This approach returns all game sessions in the fleet's home Region and all remote locations.

  • To retrieve all game sessions that are currently running on a specific fleet location, provide a fleet or alias ID and a location name, with optional status filter. The location can be the fleet's home Region or any remote location.

  • To retrieve a specific game session, provide the game session ID. This approach looks for the game session ID in all fleets that reside in the Amazon Web Services Region defined in the request.

Use the pagination parameters to retrieve results as a set of sequential pages.

If successful, a GameSession object is returned for each game session that matches the request.

This operation is not designed to be continually called to track game session status. This practice can cause you to exceed your API limit, which results in errors. Instead, you must configure an Amazon Simple Notification Service (SNS) topic to receive notifications from FlexMatch or queues. Continuously polling with DescribeGameSessions should only be used for games in development with low game session usage.

Available in Amazon GameLift Local.

Learn more

Find a game session

All APIs by task

Parameter Syntax

$result = $client->describeGameSessions([
    'AliasId' => '<string>',
    'FleetId' => '<string>',
    'GameSessionId' => '<string>',
    'Limit' => <integer>,
    'Location' => '<string>',
    'NextToken' => '<string>',
    'StatusFilter' => '<string>',
]);

Parameter Details

Members
AliasId
Type: string

A unique identifier for the alias associated with the fleet to retrieve game sessions for. You can use either the alias ID or ARN value.

FleetId
Type: string

A unique identifier for the fleet to retrieve game sessions for. You can use either the fleet ID or ARN value.

GameSessionId
Type: string

A unique identifier for the game session to retrieve.

Limit
Type: int

The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

Location
Type: string

A fleet location to get game sessions for. You can specify a fleet's home Region or a remote location. Use the Amazon Web Services Region code format, such as us-west-2.

NextToken
Type: string

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.

StatusFilter
Type: string

Game session status to filter results on. You can filter on the following states: ACTIVE, TERMINATED, ACTIVATING, and TERMINATING. The last two are transitory and used for only very brief periods of time.

Result Syntax

[
    'GameSessions' => [
        [
            'CreationTime' => <DateTime>,
            'CreatorId' => '<string>',
            'CurrentPlayerSessionCount' => <integer>,
            'DnsName' => '<string>',
            'FleetArn' => '<string>',
            'FleetId' => '<string>',
            'GameProperties' => [
                [
                    'Key' => '<string>',
                    'Value' => '<string>',
                ],
                // ...
            ],
            'GameSessionData' => '<string>',
            'GameSessionId' => '<string>',
            'IpAddress' => '<string>',
            'Location' => '<string>',
            'MatchmakerData' => '<string>',
            'MaximumPlayerSessionCount' => <integer>,
            'Name' => '<string>',
            'PlayerSessionCreationPolicy' => 'ACCEPT_ALL|DENY_ALL',
            'Port' => <integer>,
            'Status' => 'ACTIVE|ACTIVATING|TERMINATED|TERMINATING|ERROR',
            'StatusReason' => 'INTERRUPTED',
            'TerminationTime' => <DateTime>,
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members
GameSessions
Type: Array of GameSession structures

A collection of properties for each game session that matches the request.

NextToken
Type: string

A token that indicates where to resume retrieving results on the next call to this operation. If no token is returned, these results represent the end of the list.

Errors

InternalServiceException:

The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

NotFoundException:

THe requested resources was not found. The resource was either not created yet or deleted.

InvalidRequestException:

One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

UnauthorizedException:

The client failed authentication. Clients should not retry such requests.

TerminalRoutingStrategyException:

The service is unable to resolve the routing for a particular alias because it has a terminal RoutingStrategy associated with it. The message returned in this exception is the message defined in the routing strategy itself. Such requests should only be retried if the routing strategy for the specified alias is modified.

UnsupportedRegionException:

The requested operation is not supported in the Region specified.

DescribeInstances

$result = $client->describeInstances([/* ... */]);
$promise = $client->describeInstancesAsync([/* ... */]);

Retrieves information about the EC2 instances in an Amazon GameLift managed fleet, including instance ID, connection data, and status. You can use this operation with a multi-location fleet to get location-specific instance information. As an alternative, use the operations ListCompute and DescribeCompute to retrieve information for compute resources, including EC2 and Anywhere fleets.

You can call this operation in the following ways:

  • To get information on all instances in a fleet's home Region, specify the fleet ID.

  • To get information on all instances in a fleet's remote location, specify the fleet ID and location name.

  • To get information on a specific instance in a fleet, specify the fleet ID and instance ID.

Use the pagination parameters to retrieve results as a set of sequential pages.

If successful, this operation returns Instance objects for each requested instance, listed in no particular order. If you call this operation for an Anywhere fleet, you receive an InvalidRequestException.

Learn more

Remotely connect to fleet instances

Debug fleet issues

Related actions

All APIs by task

Parameter Syntax

$result = $client->describeInstances([
    'FleetId' => '<string>', // REQUIRED
    'InstanceId' => '<string>',
    'Limit' => <integer>,
    'Location' => '<string>',
    'NextToken' => '<string>',
]);

Parameter Details

Members
FleetId
Required: Yes
Type: string

A unique identifier for the fleet to retrieve instance information for. You can use either the fleet ID or ARN value.

InstanceId
Type: string

A unique identifier for an instance to retrieve. Specify an instance ID or leave blank to retrieve all instances in the fleet.

Limit
Type: int

The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

Location
Type: string

The name of a location to retrieve instance information for, in the form of an Amazon Web Services Region code such as us-west-2.

NextToken
Type: string

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.

Result Syntax

[
    'Instances' => [
        [
            'CreationTime' => <DateTime>,
            'DnsName' => '<string>',
            'FleetArn' => '<string>',
            'FleetId' => '<string>',
            'InstanceId' => '<string>',
            'IpAddress' => '<string>',
            'Location' => '<string>',
            'OperatingSystem' => 'WINDOWS_2012|AMAZON_LINUX|AMAZON_LINUX_2|WINDOWS_2016|AMAZON_LINUX_2023',
            'Status' => 'PENDING|ACTIVE|TERMINATING',
            'Type' => 't2.micro|t2.small|t2.medium|t2.large|c3.large|c3.xlarge|c3.2xlarge|c3.4xlarge|c3.8xlarge|c4.large|c4.xlarge|c4.2xlarge|c4.4xlarge|c4.8xlarge|c5.large|c5.xlarge|c5.2xlarge|c5.4xlarge|c5.9xlarge|c5.12xlarge|c5.18xlarge|c5.24xlarge|c5a.large|c5a.xlarge|c5a.2xlarge|c5a.4xlarge|c5a.8xlarge|c5a.12xlarge|c5a.16xlarge|c5a.24xlarge|r3.large|r3.xlarge|r3.2xlarge|r3.4xlarge|r3.8xlarge|r4.large|r4.xlarge|r4.2xlarge|r4.4xlarge|r4.8xlarge|r4.16xlarge|r5.large|r5.xlarge|r5.2xlarge|r5.4xlarge|r5.8xlarge|r5.12xlarge|r5.16xlarge|r5.24xlarge|r5a.large|r5a.xlarge|r5a.2xlarge|r5a.4xlarge|r5a.8xlarge|r5a.12xlarge|r5a.16xlarge|r5a.24xlarge|m3.medium|m3.large|m3.xlarge|m3.2xlarge|m4.large|m4.xlarge|m4.2xlarge|m4.4xlarge|m4.10xlarge|m5.large|m5.xlarge|m5.2xlarge|m5.4xlarge|m5.8xlarge|m5.12xlarge|m5.16xlarge|m5.24xlarge|m5a.large|m5a.xlarge|m5a.2xlarge|m5a.4xlarge|m5a.8xlarge|m5a.12xlarge|m5a.16xlarge|m5a.24xlarge|c5d.large|c5d.xlarge|c5d.2xlarge|c5d.4xlarge|c5d.9xlarge|c5d.12xlarge|c5d.18xlarge|c5d.24xlarge|c6a.large|c6a.xlarge|c6a.2xlarge|c6a.4xlarge|c6a.8xlarge|c6a.12xlarge|c6a.16xlarge|c6a.24xlarge|c6i.large|c6i.xlarge|c6i.2xlarge|c6i.4xlarge|c6i.8xlarge|c6i.12xlarge|c6i.16xlarge|c6i.24xlarge|r5d.large|r5d.xlarge|r5d.2xlarge|r5d.4xlarge|r5d.8xlarge|r5d.12xlarge|r5d.16xlarge|r5d.24xlarge|m6g.medium|m6g.large|m6g.xlarge|m6g.2xlarge|m6g.4xlarge|m6g.8xlarge|m6g.12xlarge|m6g.16xlarge|c6g.medium|c6g.large|c6g.xlarge|c6g.2xlarge|c6g.4xlarge|c6g.8xlarge|c6g.12xlarge|c6g.16xlarge|r6g.medium|r6g.large|r6g.xlarge|r6g.2xlarge|r6g.4xlarge|r6g.8xlarge|r6g.12xlarge|r6g.16xlarge|c6gn.medium|c6gn.large|c6gn.xlarge|c6gn.2xlarge|c6gn.4xlarge|c6gn.8xlarge|c6gn.12xlarge|c6gn.16xlarge|c7g.medium|c7g.large|c7g.xlarge|c7g.2xlarge|c7g.4xlarge|c7g.8xlarge|c7g.12xlarge|c7g.16xlarge|r7g.medium|r7g.large|r7g.xlarge|r7g.2xlarge|r7g.4xlarge|r7g.8xlarge|r7g.12xlarge|r7g.16xlarge|m7g.medium|m7g.large|m7g.xlarge|m7g.2xlarge|m7g.4xlarge|m7g.8xlarge|m7g.12xlarge|m7g.16xlarge|g5g.xlarge|g5g.2xlarge|g5g.4xlarge|g5g.8xlarge|g5g.16xlarge',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members
Instances
Type: Array of Instance structures

A collection of objects containing properties for each instance returned.

NextToken
Type: string

A token that indicates where to resume retrieving results on the next call to this operation. If no token is returned, these results represent the end of the list.

Errors

UnauthorizedException:

The client failed authentication. Clients should not retry such requests.

InvalidRequestException:

One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

NotFoundException:

THe requested resources was not found. The resource was either not created yet or deleted.

InternalServiceException:

The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

UnsupportedRegionException:

The requested operation is not supported in the Region specified.

DescribeMatchmaking

$result = $client->describeMatchmaking([/* ... */]);
$promise = $client->describeMatchmakingAsync([/* ... */]);

Retrieves one or more matchmaking tickets. Use this operation to retrieve ticket information, including--after a successful match is made--connection information for the resulting new game session.

To request matchmaking tickets, provide a list of up to 10 ticket IDs. If the request is successful, a ticket object is returned for each requested ID that currently exists.

This operation is not designed to be continually called to track matchmaking ticket status. This practice can cause you to exceed your API limit, which results in errors. Instead, as a best practice, set up an Amazon Simple Notification Service to receive notifications, and provide the topic ARN in the matchmaking configuration.

Learn more

Add FlexMatch to a game client

Set Up FlexMatch event notification

Parameter Syntax

$result = $client->describeMatchmaking([
    'TicketIds' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members
TicketIds
Required: Yes
Type: Array of strings

A unique identifier for a matchmaking ticket. You can include up to 10 ID values.

Result Syntax

[
    'TicketList' => [
        [
            'ConfigurationArn' => '<string>',
            'ConfigurationName' => '<string>',
            'EndTime' => <DateTime>,
            'EstimatedWaitTime' => <integer>,
            'GameSessionConnectionInfo' => [
                'DnsName' => '<string>',
                'GameSessionArn' => '<string>',
                'IpAddress' => '<string>',
                'MatchedPlayerSessions' => [
                    [
                        'PlayerId' => '<string>',
                        'PlayerSessionId' => '<string>',
                    ],
                    // ...
                ],
                'Port' => <integer>,
            ],
            'Players' => [
                [
                    'LatencyInMs' => [<integer>, ...],
                    'PlayerAttributes' => [
                        '<NonZeroAndMaxString>' => [
                            'N' => <float>,
                            'S' => '<string>',
                            'SDM' => [<float>, ...],
                            'SL' => ['<string>', ...],
                        ],
                        // ...
                    ],
                    'PlayerId' => '<string>',
                    'Team' => '<string>',
                ],
                // ...
            ],
            'StartTime' => <DateTime>,
            'Status' => 'CANCELLED|COMPLETED|FAILED|PLACING|QUEUED|REQUIRES_ACCEPTANCE|SEARCHING|TIMED_OUT',
            'StatusMessage' => '<string>',
            'StatusReason' => '<string>',
            'TicketId' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
TicketList
Type: Array of MatchmakingTicket structures

A collection of existing matchmaking ticket objects matching the request.

Errors

InvalidRequestException:

One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

InternalServiceException:

The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

UnsupportedRegionException:

The requested operation is not supported in the Region specified.

DescribeMatchmakingConfigurations

$result = $client->describeMatchmakingConfigurations([/* ... */]);
$promise = $client->describeMatchmakingConfigurationsAsync([/* ... */]);

Retrieves the details of FlexMatch matchmaking configurations.

This operation offers the following options: (1) retrieve all matchmaking configurations, (2) retrieve configurations for a specified list, or (3) retrieve all configurations that use a specified rule set name. When requesting multiple items, use the pagination parameters to retrieve results as a set of sequential pages.

If successful, a configuration is returned for each requested name. When specifying a list of names, only configurations that currently exist are returned.

Learn more

Setting up FlexMatch matchmakers

Parameter Syntax

$result = $client->describeMatchmakingConfigurations([
    'Limit' => <integer>,
    'Names' => ['<string>', ...],
    'NextToken' => '<string>',
    'RuleSetName' => '<string>',
]);

Parameter Details

Members
Limit
Type: int

The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages. This parameter is limited to 10.

Names
Type: Array of strings

A unique identifier for the matchmaking configuration(s) to retrieve. You can use either the configuration name or ARN value. To request all existing configurations, leave this parameter empty.

NextToken
Type: string

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.

RuleSetName
Type: string

A unique identifier for the matchmaking rule set. You can use either the rule set name or ARN value. Use this parameter to retrieve all matchmaking configurations that use this rule set.

Result Syntax

[
    'Configurations' => [
        [
            'AcceptanceRequired' => true || false,
            'AcceptanceTimeoutSeconds' => <integer>,
            'AdditionalPlayerCount' => <integer>,
            'BackfillMode' => 'AUTOMATIC|MANUAL',
            'ConfigurationArn' => '<string>',
            'CreationTime' => <DateTime>,
            'CustomEventData' => '<string>',
            'Description' => '<string>',
            'FlexMatchMode' => 'STANDALONE|WITH_QUEUE',
            'GameProperties' => [
                [
                    'Key' => '<string>',
                    'Value' => '<string>',
                ],
                // ...
            ],
            'GameSessionData' => '<string>',
            'GameSessionQueueArns' => ['<string>', ...],
            'Name' => '<string>',
            'NotificationTarget' => '<string>',
            'RequestTimeoutSeconds' => <integer>,
            'RuleSetArn' => '<string>',
            'RuleSetName' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members
Configurations
Type: Array of MatchmakingConfiguration structures

A collection of requested matchmaking configurations.

NextToken
Type: string

A token that indicates where to resume retrieving results on the next call to this operation. If no token is returned, these results represent the end of the list.

Errors

InvalidRequestException:

One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

InternalServiceException:

The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

UnsupportedRegionException:

The requested operation is not supported in the Region specified.

DescribeMatchmakingRuleSets

$result = $client->describeMatchmakingRuleSets([/* ... */]);
$promise = $client->describeMatchmakingRuleSetsAsync([/* ... */]);

Retrieves the details for FlexMatch matchmaking rule sets. You can request all existing rule sets for the Region, or provide a list of one or more rule set names. When requesting multiple items, use the pagination parameters to retrieve results as a set of sequential pages. If successful, a rule set is returned for each requested name.

Learn more

Parameter Syntax

$result = $client->describeMatchmakingRuleSets([
    'Limit' => <integer>,
    'Names' => ['<string>', ...],
    'NextToken' => '<string>',
]);

Parameter Details

Members
Limit
Type: int

The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

Names
Type: Array of strings

A list of one or more matchmaking rule set names to retrieve details for. (Note: The rule set name is different from the optional "name" field in the rule set body.) You can use either the rule set name or ARN value.

NextToken
Type: string

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.

Result Syntax

[
    'NextToken' => '<string>',
    'RuleSets' => [
        [
            'CreationTime' => <DateTime>,
            'RuleSetArn' => '<string>',
            'RuleSetBody' => '<string>',
            'RuleSetName' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
NextToken
Type: string

A token that indicates where to resume retrieving results on the next call to this operation. If no token is returned, these results represent the end of the list.

RuleSets
Required: Yes
Type: Array of MatchmakingRuleSet structures

A collection of requested matchmaking rule set objects.

Errors

InvalidRequestException:

One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

InternalServiceException:

The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

NotFoundException:

THe requested resources was not found. The resource was either not created yet or deleted.

UnsupportedRegionException:

The requested operation is not supported in the Region specified.

DescribePlayerSessions

$result = $client->describePlayerSessions([/* ... */]);
$promise = $client->describePlayerSessionsAsync([/* ... */]);

Retrieves properties for one or more player sessions.

This action can be used in the following ways:

  • To retrieve a specific player session, provide the player session ID only.

  • To retrieve all player sessions in a game session, provide the game session ID only.

  • To retrieve all player sessions for a specific player, provide a player ID only.

To request player sessions, specify either a player session ID, game session ID, or player ID. You can filter this request by player session status. If you provide a specific PlayerSessionId or PlayerId, Amazon GameLift ignores the filter criteria. Use the pagination parameters to retrieve results as a set of sequential pages.

If successful, a PlayerSession object is returned for each session that matches the request.

Related actions

All APIs by task

Parameter Syntax

$result = $client->describePlayerSessions([
    'GameSessionId' => '<string>',
    'Limit' => <integer>,
    'NextToken' => '<string>',
    'PlayerId' => '<string>',
    'PlayerSessionId' => '<string>',
    'PlayerSessionStatusFilter' => '<string>',
]);

Parameter Details

Members
GameSessionId
Type: string

A unique identifier for the game session to retrieve player sessions for.

Limit
Type: int

The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages. If a player session ID is specified, this parameter is ignored.

NextToken
Type: string

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. If a player session ID is specified, this parameter is ignored.

PlayerId
Type: string

A unique identifier for a player to retrieve player sessions for.

PlayerSessionId
Type: string

A unique identifier for a player session to retrieve.

PlayerSessionStatusFilter
Type: string

Player session status to filter results on. Note that when a PlayerSessionId or PlayerId is provided in a DescribePlayerSessions request, then the PlayerSessionStatusFilter has no effect on the response.

Possible player session statuses include the following:

  • RESERVED -- The player session request has been received, but the player has not yet connected to the server process and/or been validated.

  • ACTIVE -- The player has been validated by the server process and is currently connected.

  • COMPLETED -- The player connection has been dropped.

  • TIMEDOUT -- A player session request was received, but the player did not connect and/or was not validated within the timeout limit (60 seconds).

Result Syntax

[
    'NextToken' => '<string>',
    'PlayerSessions' => [
        [
            'CreationTime' => <DateTime>,
            'DnsName' => '<string>',
            'FleetArn' => '<string>',
            'FleetId' => '<string>',
            'GameSessionId' => '<string>',
            'IpAddress' => '<string>',
            'PlayerData' => '<string>',
            'PlayerId' => '<string>',
            'PlayerSessionId' => '<string>',
            'Port' => <integer>,
            'Status' => 'RESERVED|ACTIVE|COMPLETED|TIMEDOUT',
            'TerminationTime' => <DateTime>,
        ],
        // ...
    ],
]

Result Details

Members
NextToken
Type: string

A token that indicates where to resume retrieving results on the next call to this operation. If no token is returned, these results represent the end of the list.

PlayerSessions
Type: Array of PlayerSession structures

A collection of objects containing properties for each player session that matches the request.

Errors

InternalServiceException:

The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

NotFoundException:

THe requested resources was not found. The resource was either not created yet or deleted.

InvalidRequestException:

One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

UnauthorizedException:

The client failed authentication. Clients should not retry such requests.

DescribeRuntimeConfiguration

$result = $client->describeRuntimeConfiguration([/* ... */]);
$promise = $client->describeRuntimeConfigurationAsync([/* ... */]);

Retrieves a fleet's runtime configuration settings. The runtime configuration determines which server processes run, and how, on computes in the fleet. For managed EC2 fleets, the runtime configuration describes server processes that run on each fleet instance. For container fleets, the runtime configuration describes server processes that run in each replica container group. You can update a fleet's runtime configuration at any time using UpdateRuntimeConfiguration.

To get the current runtime configuration for a fleet, provide the fleet ID.

If successful, a RuntimeConfiguration object is returned for the requested fleet. If the requested fleet has been deleted, the result set is empty.

Learn more

Setting up Amazon GameLift fleets

Running multiple processes on a fleet

Parameter Syntax

$result = $client->describeRuntimeConfiguration([
    'FleetId' => '<string>', // REQUIRED
]);

Parameter Details

Members
FleetId
Required: Yes
Type: string

A unique identifier for the fleet to get the runtime configuration for. You can use either the fleet ID or ARN value.

Result Syntax

[
    'RuntimeConfiguration' => [
        'GameSessionActivationTimeoutSeconds' => <integer>,
        'MaxConcurrentGameSessionActivations' => <integer>,
        'ServerProcesses' => [
            [
                'ConcurrentExecutions' => <integer>,
                'LaunchPath' => '<string>',
                'Parameters' => '<string>',
            ],
            // ...
        ],
    ],
]

Result Details

Members
RuntimeConfiguration
Type: RuntimeConfiguration structure

Instructions that describe how server processes are launched and maintained on computes in the fleet.

Errors

UnauthorizedException:

The client failed authentication. Clients should not retry such requests.

NotFoundException:

THe requested resources was not found. The resource was either not created yet or deleted.

InternalServiceException:

The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

InvalidRequestException:

One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

DescribeScalingPolicies

$result = $client->describeScalingPolicies([/* ... */]);
$promise = $client->describeScalingPoliciesAsync([/* ... */]);

Retrieves all scaling policies applied to a fleet.

To get a fleet's scaling policies, specify the fleet ID. You can filter this request by policy status, such as to retrieve only active scaling policies. Use the pagination parameters to retrieve results as a set of sequential pages. If successful, set of ScalingPolicy objects is returned for the fleet.

A fleet may have all of its scaling policies suspended. This operation does not affect the status of the scaling policies, which remains ACTIVE.

Parameter Syntax

$result = $client->describeScalingPolicies([
    'FleetId' => '<string>', // REQUIRED
    'Limit' => <integer>,
    'Location' => '<string>',
    'NextToken' => '<string>',
    'StatusFilter' => 'ACTIVE|UPDATE_REQUESTED|UPDATING|DELETE_REQUESTED|DELETING|DELETED|ERROR',
]);

Parameter Details

Members
FleetId
Required: Yes
Type: string

A unique identifier for the fleet for which to retrieve scaling policies. You can use either the fleet ID or ARN value.

Limit
Type: int

The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

Location
Type: string

The fleet location. If you don't specify this value, the response contains the scaling policies of every location in the fleet.

NextToken
Type: string

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.

StatusFilter
Type: string

Scaling policy status to filter results on. A scaling policy is only in force when in an ACTIVE status.

  • ACTIVE -- The scaling policy is currently in force.

  • UPDATEREQUESTED -- A request to update the scaling policy has been received.

  • UPDATING -- A change is being made to the scaling policy.

  • DELETEREQUESTED -- A request to delete the scaling policy has been received.

  • DELETING -- The scaling policy is being deleted.

  • DELETED -- The scaling policy has been deleted.

  • ERROR -- An error occurred in creating the policy. It should be removed and recreated.

Result Syntax

[
    'NextToken' => '<string>',
    'ScalingPolicies' => [
        [
            'ComparisonOperator' => 'GreaterThanOrEqualToThreshold|GreaterThanThreshold|LessThanThreshold|LessThanOrEqualToThreshold',
            'EvaluationPeriods' => <integer>,
            'FleetArn' => '<string>',
            'FleetId' => '<string>',
            'Location' => '<string>',
            'MetricName' => 'ActivatingGameSessions|ActiveGameSessions|ActiveInstances|AvailableGameSessions|AvailablePlayerSessions|CurrentPlayerSessions|IdleInstances|PercentAvailableGameSessions|PercentIdleInstances|QueueDepth|WaitTime|ConcurrentActivatableGameSessions',
            'Name' => '<string>',
            'PolicyType' => 'RuleBased|TargetBased',
            'ScalingAdjustment' => <integer>,
            'ScalingAdjustmentType' => 'ChangeInCapacity|ExactCapacity|PercentChangeInCapacity',
            'Status' => 'ACTIVE|UPDATE_REQUESTED|UPDATING|DELETE_REQUESTED|DELETING|DELETED|ERROR',
            'TargetConfiguration' => [
                'TargetValue' => <float>,
            ],
            'Threshold' => <float>,
            'UpdateStatus' => 'PENDING_UPDATE',
        ],
        // ...
    ],
]

Result Details

Members
NextToken
Type: string

A token that indicates where to resume retrieving results on the next call to this operation. If no token is returned, these results represent the end of the list.

ScalingPolicies
Type: Array of ScalingPolicy structures

A collection of objects containing the scaling policies matching the request.

Errors

InternalServiceException:

The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

InvalidRequestException:

One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

UnauthorizedException:

The client failed authentication. Clients should not retry such requests.

NotFoundException:

THe requested resources was not found. The resource was either not created yet or deleted.

UnsupportedRegionException:

The requested operation is not supported in the Region specified.

DescribeScript

$result = $client->describeScript([/* ... */]);
$promise = $client->describeScriptAsync([/* ... */]);

Retrieves properties for a Realtime script.

To request a script record, specify the script ID. If successful, an object containing the script properties is returned.

Learn more

Amazon GameLift Realtime Servers

Related actions

All APIs by task

Parameter Syntax

$result = $client->describeScript([
    'ScriptId' => '<string>', // REQUIRED
]);

Parameter Details

Members
ScriptId
Required: Yes
Type: string

A unique identifier for the Realtime script to retrieve properties for. You can use either the script ID or ARN value.

Result Syntax

[
    'Script' => [
        'CreationTime' => <DateTime>,
        'Name' => '<string>',
        'ScriptArn' => '<string>',
        'ScriptId' => '<string>',
        'SizeOnDisk' => <integer>,
        'StorageLocation' => [
            'Bucket' => '<string>',
            'Key' => '<string>',
            'ObjectVersion' => '<string>',
            'RoleArn' => '<string>',
        ],
        'Version' => '<string>',
    ],
]

Result Details

Members
Script
Type: Script structure

A set of properties describing the requested script.

Errors

UnauthorizedException:

The client failed authentication. Clients should not retry such requests.

InvalidRequestException:

One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

InternalServiceException:

The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

NotFoundException:

THe requested resources was not found. The resource was either not created yet or deleted.

DescribeVpcPeeringAuthorizations

$result = $client->describeVpcPeeringAuthorizations([/* ... */]);
$promise = $client->describeVpcPeeringAuthorizationsAsync([/* ... */]);

Retrieves valid VPC peering authorizations that are pending for the Amazon Web Services account. This operation returns all VPC peering authorizations and requests for peering. This includes those initiated and received by this account.

Related actions

All APIs by task

Parameter Syntax

$result = $client->describeVpcPeeringAuthorizations([
]);

Parameter Details

Members

Result Syntax

[
    'VpcPeeringAuthorizations' => [
        [
            'CreationTime' => <DateTime>,
            'ExpirationTime' => <DateTime>,
            'GameLiftAwsAccountId' => '<string>',
            'PeerVpcAwsAccountId' => '<string>',
            'PeerVpcId' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
VpcPeeringAuthorizations
Type: Array of VpcPeeringAuthorization structures

A collection of objects that describe all valid VPC peering operations for the current Amazon Web Services account.

Errors

UnauthorizedException:

The client failed authentication. Clients should not retry such requests.

InvalidRequestException:

One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

InternalServiceException:

The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

DescribeVpcPeeringConnections

$result = $client->describeVpcPeeringConnections([/* ... */]);
$promise = $client->describeVpcPeeringConnectionsAsync([/* ... */]);

Retrieves information on VPC peering connections. Use this operation to get peering information for all fleets or for one specific fleet ID.

To retrieve connection information, call this operation from the Amazon Web Services account that is used to manage the Amazon GameLift fleets. Specify a fleet ID or leave the parameter empty to retrieve all connection records. If successful, the retrieved information includes both active and pending connections. Active connections identify the IpV4 CIDR block that the VPC uses to connect.

Related actions

All APIs by task

Parameter Syntax

$result = $client->describeVpcPeeringConnections([
    'FleetId' => '<string>',
]);

Parameter Details

Members
FleetId
Type: string

A unique identifier for the fleet. You can use either the fleet ID or ARN value.

Result Syntax

[
    'VpcPeeringConnections' => [
        [
            'FleetArn' => '<string>',
            'FleetId' => '<string>',
            'GameLiftVpcId' => '<string>',
            'IpV4CidrBlock' => '<string>',
            'PeerVpcId' => '<string>',
            'Status' => [
                'Code' => '<string>',
                'Message' => '<string>',
            ],
            'VpcPeeringConnectionId' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
VpcPeeringConnections
Type: Array of VpcPeeringConnection structures

A collection of VPC peering connection records that match the request.

Errors

UnauthorizedException:

The client failed authentication. Clients should not retry such requests.

InvalidRequestException:

One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

NotFoundException:

THe requested resources was not found. The resource was either not created yet or deleted.

InternalServiceException:

The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

GetComputeAccess

$result = $client->getComputeAccess([/* ... */]);
$promise = $client->getComputeAccessAsync([/* ... */]);

This operation has been expanded to use with the Amazon GameLift containers feature, which is currently in public preview.

Requests authorization to remotely connect to a hosting resource in a Amazon GameLift managed fleet. This operation is not used with Amazon GameLift Anywhere fleets

To request access, specify the compute name and the fleet ID. If successful, this operation returns a set of temporary Amazon Web Services credentials, including a two-part access key and a session token.

EC2 fleets

With an EC2 fleet (where compute type is EC2), use these credentials with Amazon EC2 Systems Manager (SSM) to start a session with the compute. For more details, see Starting a session (CLI) in the Amazon EC2 Systems Manager User Guide.

Container fleets

With a container fleet (where compute type is CONTAINER), use these credentials and the target value with SSM to connect to the fleet instance where the container is running. After you're connected to the instance, use Docker commands to interact with the container.

Learn more

Parameter Syntax

$result = $client->getComputeAccess([
    'ComputeName' => '<string>', // REQUIRED
    'FleetId' => '<string>', // REQUIRED
]);

Parameter Details

Members
ComputeName
Required: Yes
Type: string

A unique identifier for the compute resource that you want to connect to. For an EC2 fleet compute, use the instance ID. For a container fleet, use the compute name (for example, a123b456c789012d3e4567f8a901b23c/1a234b56-7cd8-9e0f-a1b2-c34d567ef8a9) or the compute ARN.

FleetId
Required: Yes
Type: string

A unique identifier for the fleet that holds the compute resource that you want to connect to. You can use either the fleet ID or ARN value.

Result Syntax

[
    'ComputeArn' => '<string>',
    'ComputeName' => '<string>',
    'Credentials' => [
        'AccessKeyId' => '<string>',
        'SecretAccessKey' => '<string>',
        'SessionToken' => '<string>',
    ],
    'FleetArn' => '<string>',
    'FleetId' => '<string>',
    'Target' => '<string>',
]

Result Details

Members
ComputeArn
Type: string

The Amazon Resource Name (ARN) that is assigned to an Amazon GameLift compute resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::compute/compute-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912.

ComputeName
Type: string

The identifier of the compute resource to be accessed. This value might be either a compute name or an instance ID.

Credentials
Type: AwsCredentials structure

A set of temporary Amazon Web Services credentials for use when connecting to the compute resource with Amazon EC2 Systems Manager (SSM).

FleetArn
Type: string

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.

FleetId
Type: string

The ID of the fleet that holds the compute resource to be accessed.

Target
Type: string

(For container fleets only) The instance ID where the compute resource is running.

Errors

UnauthorizedException:

The client failed authentication. Clients should not retry such requests.

InvalidRequestException:

One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

NotFoundException:

THe requested resources was not found. The resource was either not created yet or deleted.

InternalServiceException:

The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

GetComputeAuthToken

$result = $client->getComputeAuthToken([/* ... */]);
$promise = $client->getComputeAuthTokenAsync([/* ... */]);

Requests an authentication token from Amazon GameLift for a compute resource in an Amazon GameLift Anywhere fleet or container fleet. Game servers that are running on the compute use this token to communicate with the Amazon GameLift service, such as when calling the Amazon GameLift server SDK action InitSDK(). Authentication tokens are valid for a limited time span, so you need to request a fresh token before the current token expires.

Use this operation based on the fleet compute type:

  • For EC2 fleets, auth token retrieval and refresh is handled automatically. All game servers that are running on all fleet instances have access to a valid auth token.

  • For ANYWHERE and CONTAINER fleets, if you're using the Amazon GameLift Agent, auth token retrieval and refresh is handled automatically for any container or Anywhere compute where the Agent is running. If you're not using the Agent, create a mechanism to retrieve and refresh auth tokens for computes that are running game server processes.

Learn more

Parameter Syntax

$result = $client->getComputeAuthToken([
    'ComputeName' => '<string>', // REQUIRED
    'FleetId' => '<string>', // REQUIRED
]);

Parameter Details

Members
ComputeName
Required: Yes
Type: string

The name of the compute resource you are requesting the authentication token for. For an Anywhere fleet compute, use the registered compute name. For an EC2 fleet instance, use the instance ID. For a container fleet, use the compute name (for example, a123b456c789012d3e4567f8a901b23c/1a234b56-7cd8-9e0f-a1b2-c34d567ef8a9) or the compute ARN.

FleetId
Required: Yes
Type: string

A unique identifier for the fleet that the compute is registered to.

Result Syntax

[
    'AuthToken' => '<string>',
    'ComputeArn' => '<string>',
    'ComputeName' => '<string>',
    'ExpirationTimestamp' => <DateTime>,
    'FleetArn' => '<string>',
    'FleetId' => '<string>',
]

Result Details

Members
AuthToken
Type: string

A valid temporary authentication token.

ComputeArn
Type: string

The Amazon Resource Name (ARN) that is assigned to an Amazon GameLift compute resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::compute/compute-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912.

ComputeName
Type: string

The name of the compute resource that the authentication token is issued to.

ExpirationTimestamp
Type: timestamp (string|DateTime or anything parsable by strtotime)

The amount of time until the authentication token is no longer valid.

FleetArn
Type: string

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.

FleetId
Type: string

A unique identifier for the fleet that the compute is registered to.

Errors

UnauthorizedException:

The client failed authentication. Clients should not retry such requests.

InvalidRequestException:

One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

NotFoundException:

THe requested resources was not found. The resource was either not created yet or deleted.

InternalServiceException:

The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

GetGameSessionLogUrl

$result = $client->getGameSessionLogUrl([/* ... */]);
$promise = $client->getGameSessionLogUrlAsync([/* ... */]);

Retrieves the location of stored game session logs for a specified game session on Amazon GameLift managed fleets. When a game session is terminated, Amazon GameLift automatically stores the logs in Amazon S3 and retains them for 14 days. Use this URL to download the logs.

See the Amazon Web Services Service Limits page for maximum log file sizes. Log files that exceed this limit are not saved.

All APIs by task

Parameter Syntax

$result = $client->getGameSessionLogUrl([
    'GameSessionId' => '<string>', // REQUIRED
]);

Parameter Details

Members
GameSessionId
Required: Yes
Type: string

A unique identifier for the game session to get logs for.

Result Syntax

[
    'PreSignedUrl' => '<string>',
]

Result Details

Members
PreSignedUrl
Type: string

Location of the requested game session logs, available for download. This URL is valid for 15 minutes, after which S3 will reject any download request using this URL. You can request a new URL any time within the 14-day period that the logs are retained.

Errors

InternalServiceException:

The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

NotFoundException:

THe requested resources was not found. The resource was either not created yet or deleted.

UnauthorizedException:

The client failed authentication. Clients should not retry such requests.

InvalidRequestException:

One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

GetInstanceAccess

$result = $client->getInstanceAccess([/* ... */]);
$promise = $client->getInstanceAccessAsync([/* ... */]);

Requests authorization to remotely connect to an instance in an Amazon GameLift managed fleet. Use this operation to connect to instances with game servers that use Amazon GameLift server SDK 4.x or earlier. To connect to instances with game servers that use server SDK 5.x or later, call GetComputeAccess.

To request access to an instance, specify IDs for the instance and the fleet it belongs to. You can retrieve instance IDs for a fleet by calling DescribeInstances with the fleet ID.

If successful, this operation returns an IP address and credentials. The returned credentials match the operating system of the instance, as follows:

  • For a Windows instance: returns a user name and secret (password) for use with a Windows Remote Desktop client.

  • For a Linux instance: returns a user name and secret (RSA private key) for use with an SSH client. You must save the secret to a .pem file. If you're using the CLI, see the example Get credentials for a Linux instance for tips on automatically saving the secret to a .pem file.

Learn more

Remotely connect to fleet instances

Debug fleet issues

Related actions

All APIs by task

Parameter Syntax

$result = $client->getInstanceAccess([
    'FleetId' => '<string>', // REQUIRED
    'InstanceId' => '<string>', // REQUIRED
]);

Parameter Details

Members
FleetId
Required: Yes
Type: string

A unique identifier for the fleet that contains the instance you want to access. You can request access to instances in EC2 fleets with the following statuses: ACTIVATING, ACTIVE, or ERROR. Use either a fleet ID or an ARN value.

You can access fleets in ERROR status for a short period of time before Amazon GameLift deletes them.

InstanceId
Required: Yes
Type: string

A unique identifier for the instance you want to access. You can access an instance in any status.

Result Syntax

[
    'InstanceAccess' => [
        'Credentials' => [
            'Secret' => '<string>',
            'UserName' => '<string>',
        ],
        'FleetId' => '<string>',
        'InstanceId' => '<string>',
        'IpAddress' => '<string>',
        'OperatingSystem' => 'WINDOWS_2012|AMAZON_LINUX|AMAZON_LINUX_2|WINDOWS_2016|AMAZON_LINUX_2023',
    ],
]

Result Details

Members
InstanceAccess
Type: InstanceAccess structure

The connection information for a fleet instance, including IP address and access credentials.

Errors

UnauthorizedException:

The client failed authentication. Clients should not retry such requests.

InvalidRequestException:

One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

NotFoundException:

THe requested resources was not found. The resource was either not created yet or deleted.

InternalServiceException:

The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

ListAliases

$result = $client->listAliases([/* ... */]);
$promise = $client->listAliasesAsync([/* ... */]);

Retrieves all aliases for this Amazon Web Services account. You can filter the result set by alias name and/or routing strategy type. Use the pagination parameters to retrieve results in sequential pages.

Returned aliases are not listed in any particular order.

Related actions

All APIs by task

Parameter Syntax

$result = $client->listAliases([
    'Limit' => <integer>,
    'Name' => '<string>',
    'NextToken' => '<string>',
    'RoutingStrategyType' => 'SIMPLE|TERMINAL',
]);

Parameter Details

Members
Limit
Type: int

The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

Name
Type: string

A descriptive label that is associated with an alias. Alias names do not need to be unique.

NextToken
Type: string

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.

RoutingStrategyType
Type: string

The routing type to filter results on. Use this parameter to retrieve only aliases with a certain routing type. To retrieve all aliases, leave this parameter empty.

Possible routing types include the following:

  • SIMPLE -- The alias resolves to one specific fleet. Use this type when routing to active fleets.

  • TERMINAL -- The alias does not resolve to a fleet but instead can be used to display a message to the user. A terminal alias throws a TerminalRoutingStrategyException with the RoutingStrategy message embedded.

Result Syntax

[
    'Aliases' => [
        [
            'AliasArn' => '<string>',
            'AliasId' => '<string>',
            'CreationTime' => <DateTime>,
            'Description' => '<string>',
            'LastUpdatedTime' => <DateTime>,
            'Name' => '<string>',
            'RoutingStrategy' => [
                'FleetId' => '<string>',
                'Message' => '<string>',
                'Type' => 'SIMPLE|TERMINAL',
            ],
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members
Aliases
Type: Array of Alias structures

A collection of alias resources that match the request parameters.

NextToken
Type: string

A token that indicates where to resume retrieving results on the next call to this operation. If no token is returned, these results represent the end of the list.

Errors

UnauthorizedException:

The client failed authentication. Clients should not retry such requests.

InvalidRequestException:

One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

InternalServiceException:

The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

ListBuilds

$result = $client->listBuilds([/* ... */]);
$promise = $client->listBuildsAsync([/* ... */]);

Retrieves build resources for all builds associated with the Amazon Web Services account in use. You can limit results to builds that are in a specific status by using the Status parameter. Use the pagination parameters to retrieve results in a set of sequential pages.

Build resources are not listed in any particular order.

Learn more

Upload a Custom Server Build

All APIs by task

Parameter Syntax

$result = $client->listBuilds([
    'Limit' => <integer>,
    'NextToken' => '<string>',
    'Status' => 'INITIALIZED|READY|FAILED',
]);

Parameter Details

Members
Limit
Type: int

The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

NextToken
Type: string

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, don't specify a value.

Status
Type: string

Build status to filter results by. To retrieve all builds, leave this parameter empty.

Possible build statuses include the following:

  • INITIALIZED -- A new build has been defined, but no files have been uploaded. You cannot create fleets for builds that are in this status. When a build is successfully created, the build status is set to this value.

  • READY -- The game build has been successfully uploaded. You can now create new fleets for this build.

  • FAILED -- The game build upload failed. You cannot create new fleets for this build.

Result Syntax

[
    'Builds' => [
        [
            'BuildArn' => '<string>',
            'BuildId' => '<string>',
            'CreationTime' => <DateTime>,
            'Name' => '<string>',
            'OperatingSystem' => 'WINDOWS_2012|AMAZON_LINUX|AMAZON_LINUX_2|WINDOWS_2016|AMAZON_LINUX_2023',
            'ServerSdkVersion' => '<string>',
            'SizeOnDisk' => <integer>,
            'Status' => 'INITIALIZED|READY|FAILED',
            'Version' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members
Builds
Type: Array of Build structures

A collection of build resources that match the request.

NextToken
Type: string

A token that indicates where to resume retrieving results on the next call to this operation. If no token is returned, these results represent the end of the list.

Errors

UnauthorizedException:

The client failed authentication. Clients should not retry such requests.

InvalidRequestException:

One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

InternalServiceException:

The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

ListCompute

$result = $client->listCompute([/* ... */]);
$promise = $client->listComputeAsync([/* ... */]);

This operation has been expanded to use with the Amazon GameLift containers feature, which is currently in public preview.

Retrieves information on the compute resources in an Amazon GameLift fleet.

To request a list of computes, specify the fleet ID. Use the pagination parameters to retrieve results in a set of sequential pages.

You can filter the result set by location.

If successful, this operation returns information on all computes in the requested fleet. Depending on the fleet's compute type, the result includes the following information:

  • For EC2 fleets, this operation returns information about the EC2 instance. Compute names are instance IDs.

  • For ANYWHERE fleets, this operation returns the compute names and details provided when the compute was registered with RegisterCompute. The GameLiftServiceSdkEndpoint or GameLiftAgentEndpoint is included.

  • For CONTAINER fleets, this operation returns information about containers that are registered as computes, and the instances they're running on. Compute names are container names.

Parameter Syntax

$result = $client->listCompute([
    'FleetId' => '<string>', // REQUIRED
    'Limit' => <integer>,
    'Location' => '<string>',
    'NextToken' => '<string>',
]);

Parameter Details

Members
FleetId
Required: Yes
Type: string

A unique identifier for the fleet to retrieve compute resources for.

Limit
Type: int

The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

Location
Type: string

The name of a location to retrieve compute resources for. For an Amazon GameLift Anywhere fleet, use a custom location. For a multi-location EC2 or container fleet, provide a Amazon Web Services Region or Local Zone code (for example: us-west-2 or us-west-2-lax-1).

NextToken
Type: string

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.

Result Syntax

[
    'ComputeList' => [
        [
            'ComputeArn' => '<string>',
            'ComputeName' => '<string>',
            'ComputeStatus' => 'PENDING|ACTIVE|TERMINATING',
            'ContainerAttributes' => [
                'ContainerPortMappings' => [
                    [
                        'ConnectionPort' => <integer>,
                        'ContainerPort' => <integer>,
                        'Protocol' => 'TCP|UDP',
                    ],
                    // ...
                ],
            ],
            'CreationTime' => <DateTime>,
            'DnsName' => '<string>',
            'FleetArn' => '<string>',
            'FleetId' => '<string>',
            'GameLiftAgentEndpoint' => '<string>',
            'GameLiftServiceSdkEndpoint' => '<string>',
            'InstanceId' => '<string>',
            'IpAddress' => '<string>',
            'Location' => '<string>',
            'OperatingSystem' => 'WINDOWS_2012|AMAZON_LINUX|AMAZON_LINUX_2|WINDOWS_2016|AMAZON_LINUX_2023',
            'Type' => 't2.micro|t2.small|t2.medium|t2.large|c3.large|c3.xlarge|c3.2xlarge|c3.4xlarge|c3.8xlarge|c4.large|c4.xlarge|c4.2xlarge|c4.4xlarge|c4.8xlarge|c5.large|c5.xlarge|c5.2xlarge|c5.4xlarge|c5.9xlarge|c5.12xlarge|c5.18xlarge|c5.24xlarge|c5a.large|c5a.xlarge|c5a.2xlarge|c5a.4xlarge|c5a.8xlarge|c5a.12xlarge|c5a.16xlarge|c5a.24xlarge|r3.large|r3.xlarge|r3.2xlarge|r3.4xlarge|r3.8xlarge|r4.large|r4.xlarge|r4.2xlarge|r4.4xlarge|r4.8xlarge|r4.16xlarge|r5.large|r5.xlarge|r5.2xlarge|r5.4xlarge|r5.8xlarge|r5.12xlarge|r5.16xlarge|r5.24xlarge|r5a.large|r5a.xlarge|r5a.2xlarge|r5a.4xlarge|r5a.8xlarge|r5a.12xlarge|r5a.16xlarge|r5a.24xlarge|m3.medium|m3.large|m3.xlarge|m3.2xlarge|m4.large|m4.xlarge|m4.2xlarge|m4.4xlarge|m4.10xlarge|m5.large|m5.xlarge|m5.2xlarge|m5.4xlarge|m5.8xlarge|m5.12xlarge|m5.16xlarge|m5.24xlarge|m5a.large|m5a.xlarge|m5a.2xlarge|m5a.4xlarge|m5a.8xlarge|m5a.12xlarge|m5a.16xlarge|m5a.24xlarge|c5d.large|c5d.xlarge|c5d.2xlarge|c5d.4xlarge|c5d.9xlarge|c5d.12xlarge|c5d.18xlarge|c5d.24xlarge|c6a.large|c6a.xlarge|c6a.2xlarge|c6a.4xlarge|c6a.8xlarge|c6a.12xlarge|c6a.16xlarge|c6a.24xlarge|c6i.large|c6i.xlarge|c6i.2xlarge|c6i.4xlarge|c6i.8xlarge|c6i.12xlarge|c6i.16xlarge|c6i.24xlarge|r5d.large|r5d.xlarge|r5d.2xlarge|r5d.4xlarge|r5d.8xlarge|r5d.12xlarge|r5d.16xlarge|r5d.24xlarge|m6g.medium|m6g.large|m6g.xlarge|m6g.2xlarge|m6g.4xlarge|m6g.8xlarge|m6g.12xlarge|m6g.16xlarge|c6g.medium|c6g.large|c6g.xlarge|c6g.2xlarge|c6g.4xlarge|c6g.8xlarge|c6g.12xlarge|c6g.16xlarge|r6g.medium|r6g.large|r6g.xlarge|r6g.2xlarge|r6g.4xlarge|r6g.8xlarge|r6g.12xlarge|r6g.16xlarge|c6gn.medium|c6gn.large|c6gn.xlarge|c6gn.2xlarge|c6gn.4xlarge|c6gn.8xlarge|c6gn.12xlarge|c6gn.16xlarge|c7g.medium|c7g.large|c7g.xlarge|c7g.2xlarge|c7g.4xlarge|c7g.8xlarge|c7g.12xlarge|c7g.16xlarge|r7g.medium|r7g.large|r7g.xlarge|r7g.2xlarge|r7g.4xlarge|r7g.8xlarge|r7g.12xlarge|r7g.16xlarge|m7g.medium|m7g.large|m7g.xlarge|m7g.2xlarge|m7g.4xlarge|m7g.8xlarge|m7g.12xlarge|m7g.16xlarge|g5g.xlarge|g5g.2xlarge|g5g.4xlarge|g5g.8xlarge|g5g.16xlarge',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members
ComputeList
Type: Array of Compute structures

A list of compute resources in the specified fleet.

NextToken
Type: string

A token that indicates where to resume retrieving results on the next call to this operation. If no token is returned, these results represent the end of the list.

Errors

UnauthorizedException:

The client failed authentication. Clients should not retry such requests.

InvalidRequestException:

One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

InternalServiceException:

The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

ListContainerGroupDefinitions

$result = $client->listContainerGroupDefinitions([/* ... */]);
$promise = $client->listContainerGroupDefinitionsAsync([/* ... */]);

This operation is used with the Amazon GameLift containers feature, which is currently in public preview.

Retrieves all container group definitions for the Amazon Web Services account and Amazon Web Services Region that are currently in use. You can filter the result set by the container groups' scheduling strategy. Use the pagination parameters to retrieve results in a set of sequential pages.

This operation returns the list of container group definitions in no particular order.

Learn more

Parameter Syntax

$result = $client->listContainerGroupDefinitions([
    'Limit' => <integer>,
    'NextToken' => '<string>',
    'SchedulingStrategy' => 'REPLICA|DAEMON',
]);

Parameter Details

Members
Limit
Type: int

The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

NextToken
Type: string

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.

SchedulingStrategy
Type: string

The type of container group definitions to retrieve.

  • DAEMON -- Daemon container groups run background processes and are deployed once per fleet instance.

  • REPLICA -- Replica container groups run your game server application and supporting software. Replica groups might be deployed multiple times per fleet instance.

Result Syntax

[
    'ContainerGroupDefinitions' => [
        [
            'ContainerDefinitions' => [
                [
                    'Command' => ['<string>', ...],
                    'ContainerName' => '<string>',
                    'Cpu' => <integer>,
                    'DependsOn' => [
                        [
                            'Condition' => 'START|COMPLETE|SUCCESS|HEALTHY',
                            'ContainerName' => '<string>',
                        ],
                        // ...
                    ],
                    'EntryPoint' => ['<string>', ...],
                    'Environment' => [
                        [
                            'Name' => '<string>',
                            'Value' => '<string>',
                        ],
                        // ...
                    ],
                    'Essential' => true || false,
                    'HealthCheck' => [
                        'Command' => ['<string>', ...],
                        'Interval' => <integer>,
                        'Retries' => <integer>,
                        'StartPeriod' => <integer>,
                        'Timeout' => <integer>,
                    ],
                    'ImageUri' => '<string>',
                    'MemoryLimits' => [
                        'HardLimit' => <integer>,
                        'SoftLimit' => <integer>,
                    ],
                    'PortConfiguration' => [
                        'ContainerPortRanges' => [
                            [
                                'FromPort' => <integer>,
                                'Protocol' => 'TCP|UDP',
                                'ToPort' => <integer>,
                            ],
                            // ...
                        ],
                    ],
                    'ResolvedImageDigest' => '<string>',
                    'WorkingDirectory' => '<string>',
                ],
                // ...
            ],
            'ContainerGroupDefinitionArn' => '<string>',
            'CreationTime' => <DateTime>,
            'Name' => '<string>',
            'OperatingSystem' => 'AMAZON_LINUX_2023',
            'SchedulingStrategy' => 'REPLICA|DAEMON',
            'Status' => 'READY|COPYING|FAILED',
            'StatusReason' => '<string>',
            'TotalCpuLimit' => <integer>,
            'TotalMemoryLimit' => <integer>,
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members
ContainerGroupDefinitions
Type: Array of ContainerGroupDefinition structures

A result set of container group definitions that match the request.

NextToken
Type: string

A token that indicates where to resume retrieving results on the next call to this operation. If no token is returned, these results represent the end of the list.

Errors

UnauthorizedException:

The client failed authentication. Clients should not retry such requests.

InvalidRequestException:

One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

InternalServiceException:

The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

UnsupportedRegionException:

The requested operation is not supported in the Region specified.

ListFleets

$result = $client->listFleets([/* ... */]);
$promise = $client->listFleetsAsync([/* ... */]);

This operation has been expanded to use with the Amazon GameLift containers feature, which is currently in public preview.

Retrieves a collection of fleet resources in an Amazon Web Services Region. You can filter the result set to find only those fleets that are deployed with a specific build or script. For fleets that have multiple locations, this operation retrieves fleets based on their home Region only.

You can use operation in the following ways:

  • To get a list of all fleets in a Region, don't provide a build or script identifier.

  • To get a list of all fleets where a specific game build is deployed, provide the build ID.

  • To get a list of all Realtime Servers fleets with a specific configuration script, provide the script ID.

  • To get a list of all fleets with a specific container group definition, provide the ContainerGroupDefinition ID.

Use the pagination parameters to retrieve results as a set of sequential pages.

If successful, this operation returns a list of fleet IDs that match the request parameters. A NextToken value is also returned if there are more result pages to retrieve.

Fleet IDs are returned in no particular order.

Parameter Syntax

$result = $client->listFleets([
    'BuildId' => '<string>',
    'ContainerGroupDefinitionName' => '<string>',
    'Limit' => <integer>,
    'NextToken' => '<string>',
    'ScriptId' => '<string>',
]);

Parameter Details

Members
BuildId
Type: string

A unique identifier for the build to request fleets for. Use this parameter to return only fleets using a specified build. Use either the build ID or ARN value.

ContainerGroupDefinitionName
Type: string

The container group definition name to request fleets for. Use this parameter to return only fleets that are deployed with the specified container group definition.

Limit
Type: int

The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

NextToken
Type: string

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.

ScriptId
Type: string

A unique identifier for the Realtime script to request fleets for. Use this parameter to return only fleets using a specified script. Use either the script ID or ARN value.

Result Syntax

[
    'FleetIds' => ['<string>', ...],
    'NextToken' => '<string>',
]

Result Details

Members
FleetIds
Type: Array of strings

A set of fleet IDs that match the list request.

NextToken
Type: string

A token that indicates where to resume retrieving results on the next call to this operation. If no token is returned, these results represent the end of the list.

Errors

InternalServiceException:

The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

NotFoundException:

THe requested resources was not found. The resource was either not created yet or deleted.

InvalidRequestException:

One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

UnauthorizedException:

The client failed authentication. Clients should not retry such requests.

ListGameServerGroups

$result = $client->listGameServerGroups([/* ... */]);
$promise = $client->listGameServerGroupsAsync([/* ... */]);

Lists a game server groups.

Parameter Syntax

$result = $client->listGameServerGroups([
    'Limit' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members
Limit
Type: int

The game server groups' limit.

NextToken
Type: string

Specify the pagination token from a previous request to retrieve the next page of results.

Result Syntax

[
    'GameServerGroups' => [
        [
            'AutoScalingGroupArn' => '<string>',
            'BalancingStrategy' => 'SPOT_ONLY|SPOT_PREFERRED|ON_DEMAND_ONLY',
            'CreationTime' => <DateTime>,
            'GameServerGroupArn' => '<string>',
            'GameServerGroupName' => '<string>',
            'GameServerProtectionPolicy' => 'NO_PROTECTION|FULL_PROTECTION',
            'InstanceDefinitions' => [
                [
                    'InstanceType' => 'c4.large|c4.xlarge|c4.2xlarge|c4.4xlarge|c4.8xlarge|c5.large|c5.xlarge|c5.2xlarge|c5.4xlarge|c5.9xlarge|c5.12xlarge|c5.18xlarge|c5.24xlarge|c5a.large|c5a.xlarge|c5a.2xlarge|c5a.4xlarge|c5a.8xlarge|c5a.12xlarge|c5a.16xlarge|c5a.24xlarge|c6g.medium|c6g.large|c6g.xlarge|c6g.2xlarge|c6g.4xlarge|c6g.8xlarge|c6g.12xlarge|c6g.16xlarge|r4.large|r4.xlarge|r4.2xlarge|r4.4xlarge|r4.8xlarge|r4.16xlarge|r5.large|r5.xlarge|r5.2xlarge|r5.4xlarge|r5.8xlarge|r5.12xlarge|r5.16xlarge|r5.24xlarge|r5a.large|r5a.xlarge|r5a.2xlarge|r5a.4xlarge|r5a.8xlarge|r5a.12xlarge|r5a.16xlarge|r5a.24xlarge|r6g.medium|r6g.large|r6g.xlarge|r6g.2xlarge|r6g.4xlarge|r6g.8xlarge|r6g.12xlarge|r6g.16xlarge|m4.large|m4.xlarge|m4.2xlarge|m4.4xlarge|m4.10xlarge|m5.large|m5.xlarge|m5.2xlarge|m5.4xlarge|m5.8xlarge|m5.12xlarge|m5.16xlarge|m5.24xlarge|m5a.large|m5a.xlarge|m5a.2xlarge|m5a.4xlarge|m5a.8xlarge|m5a.12xlarge|m5a.16xlarge|m5a.24xlarge|m6g.medium|m6g.large|m6g.xlarge|m6g.2xlarge|m6g.4xlarge|m6g.8xlarge|m6g.12xlarge|m6g.16xlarge',
                    'WeightedCapacity' => '<string>',
                ],
                // ...
            ],
            'LastUpdatedTime' => <DateTime>,
            'RoleArn' => '<string>',
            'Status' => 'NEW|ACTIVATING|ACTIVE|DELETE_SCHEDULED|DELETING|DELETED|ERROR',
            'StatusReason' => '<string>',
            'SuspendedActions' => ['<string>', ...],
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members
GameServerGroups
Type: Array of GameServerGroup structures

The game server groups' game server groups.

NextToken
Type: string

Specify the pagination token from a previous request to retrieve the next page of results.

Errors

InvalidRequestException:

One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

UnauthorizedException:

The client failed authentication. Clients should not retry such requests.

InternalServiceException:

The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

ListGameServers

$result = $client->listGameServers([/* ... */]);
$promise = $client->listGameServersAsync([/* ... */]);

This operation is used with the Amazon GameLift FleetIQ solution and game server groups.

Retrieves information on all game servers that are currently active in a specified game server group. You can opt to sort the list by game server age. Use the pagination parameters to retrieve results in a set of sequential segments.

Learn more

Amazon GameLift FleetIQ Guide

Parameter Syntax

$result = $client->listGameServers([
    'GameServerGroupName' => '<string>', // REQUIRED
    'Limit' => <integer>,
    'NextToken' => '<string>',
    'SortOrder' => 'ASCENDING|DESCENDING',
]);

Parameter Details

Members
GameServerGroupName
Required: Yes
Type: string

An identifier for the game server group to retrieve a list of game servers from. Use either the name or ARN value.

Limit
Type: int

The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

NextToken
Type: string

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.

SortOrder
Type: string

Indicates how to sort the returned data based on game server registration timestamp. Use ASCENDING to retrieve oldest game servers first, or use DESCENDING to retrieve newest game servers first. If this parameter is left empty, game servers are returned in no particular order.

Result Syntax

[
    'GameServers' => [
        [
            'ClaimStatus' => 'CLAIMED',
            'ConnectionInfo' => '<string>',
            'GameServerData' => '<string>',
            'GameServerGroupArn' => '<string>',
            'GameServerGroupName' => '<string>',
            'GameServerId' => '<string>',
            'InstanceId' => '<string>',
            'LastClaimTime' => <DateTime>,
            'LastHealthCheckTime' => <DateTime>,
            'RegistrationTime' => <DateTime>,
            'UtilizationStatus' => 'AVAILABLE|UTILIZED',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members
GameServers
Type: Array of GameServer structures

A collection of game server objects that match the request.

NextToken
Type: string

A token that indicates where to resume retrieving results on the next call to this operation. If no token is returned, these results represent the end of the list.

Errors

InvalidRequestException:

One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

UnauthorizedException:

The client failed authentication. Clients should not retry such requests.

InternalServiceException:

The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

ListLocations

$result = $client->listLocations([/* ... */]);
$promise = $client->listLocationsAsync([/* ... */]);

Lists all custom and Amazon Web Services locations.

Parameter Syntax

$result = $client->listLocations([
    'Filters' => ['<string>', ...],
    'Limit' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members
Filters
Type: Array of strings

Filters the list for AWS or CUSTOM locations.

Limit
Type: int

The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

NextToken
Type: string

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.

Result Syntax

[
    'Locations' => [
        [
            'LocationArn' => '<string>',
            'LocationName' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members
Locations
Type: Array of LocationModel structures

A collection of locations.

NextToken
Type: string

A token that indicates where to resume retrieving results on the next call to this operation. If no token is returned, these results represent the end of the list.

Errors

UnauthorizedException:

The client failed authentication. Clients should not retry such requests.

InvalidRequestException:

One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

InternalServiceException:

The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

ListScripts

$result = $client->listScripts([/* ... */]);
$promise = $client->listScriptsAsync([/* ... */]);

Retrieves script records for all Realtime scripts that are associated with the Amazon Web Services account in use.

Learn more

Amazon GameLift Realtime Servers

Related actions

All APIs by task

Parameter Syntax

$result = $client->listScripts([
    'Limit' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members
Limit
Type: int

The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

NextToken
Type: string

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, don't specify a value.

Result Syntax

[
    'NextToken' => '<string>',
    'Scripts' => [
        [
            'CreationTime' => <DateTime>,
            'Name' => '<string>',
            'ScriptArn' => '<string>',
            'ScriptId' => '<string>',
            'SizeOnDisk' => <integer>,
            'StorageLocation' => [
                'Bucket' => '<string>',
                'Key' => '<string>',
                'ObjectVersion' => '<string>',
                'RoleArn' => '<string>',
            ],
            'Version' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
NextToken
Type: string

A token that indicates where to resume retrieving results on the next call to this operation. If no token is returned, these results represent the end of the list.

Scripts
Type: Array of Script structures

A set of properties describing the requested script.

Errors

UnauthorizedException:

The client failed authentication. Clients should not retry such requests.

InvalidRequestException:

One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

InternalServiceException:

The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

ListTagsForResource

$result = $client->listTagsForResource([/* ... */]);
$promise = $client->listTagsForResourceAsync([/* ... */]);

Retrieves all tags assigned to a Amazon GameLift resource. Use resource tags to organize Amazon Web Services resources for a range of purposes. This operation handles the permissions necessary to manage tags for Amazon GameLift resources that support tagging.

To list tags for a resource, specify the unique ARN value for the resource.

Learn more

Tagging Amazon Web Services Resources in the Amazon Web Services General Reference

Amazon Web Services Tagging Strategies

Related actions

All APIs by task

Parameter Syntax

$result = $client->listTagsForResource([
    'ResourceARN' => '<string>', // REQUIRED
]);

Parameter Details

Members
ResourceARN
Required: Yes
Type: string

The Amazon Resource Name (ARN) that uniquely identifies the Amazon GameLift resource that you want to retrieve tags for. Amazon GameLift includes resource ARNs in the data object for the resource. You can retrieve the ARN by calling a List or Describe operation for the resource type.

Result Syntax

[
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
Tags
Type: Array of Tag structures

The collection of tags assigned to the resource.

Errors

NotFoundException:

THe requested resources was not found. The resource was either not created yet or deleted.

InvalidRequestException:

One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

TaggingFailedException:

The requested tagging operation did not succeed. This may be due to invalid tag format or the maximum tag limit may have been exceeded. Resolve the issue before retrying.

InternalServiceException:

The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

PutScalingPolicy

$result = $client->putScalingPolicy([/* ... */]);
$promise = $client->putScalingPolicyAsync([/* ... */]);

Creates or updates a scaling policy for a fleet. Scaling policies are used to automatically scale a fleet's hosting capacity to meet player demand. An active scaling policy instructs Amazon GameLift to track a fleet metric and automatically change the fleet's capacity when a certain threshold is reached. There are two types of scaling policies: target-based and rule-based. Use a target-based policy to quickly and efficiently manage fleet scaling; this option is the most commonly used. Use rule-based policies when you need to exert fine-grained control over auto-scaling.

Fleets can have multiple scaling policies of each type in force at the same time; you can have one target-based policy, one or multiple rule-based scaling policies, or both. We recommend caution, however, because multiple auto-scaling policies can have unintended consequences.

Learn more about how to work with auto-scaling in Set Up Fleet Automatic Scaling.

Target-based policy

A target-based policy tracks a single metric: PercentAvailableGameSessions. This metric tells us how much of a fleet's hosting capacity is ready to host game sessions but is not currently in use. This is the fleet's buffer; it measures the additional player demand that the fleet could handle at current capacity. With a target-based policy, you set your ideal buffer size and leave it to Amazon GameLift to take whatever action is needed to maintain that target.

For example, you might choose to maintain a 10% buffer for a fleet that has the capacity to host 100 simultaneous game sessions. This policy tells Amazon GameLift to take action whenever the fleet's available capacity falls below or rises above 10 game sessions. Amazon GameLift will start new instances or stop unused instances in order to return to the 10% buffer.

To create or update a target-based policy, specify a fleet ID and name, and set the policy type to "TargetBased". Specify the metric to track (PercentAvailableGameSessions) and reference a TargetConfiguration object with your desired buffer value. Exclude all other parameters. On a successful request, the policy name is returned. The scaling policy is automatically in force as soon as it's successfully created. If the fleet's auto-scaling actions are temporarily suspended, the new policy will be in force once the fleet actions are restarted.

Rule-based policy

A rule-based policy tracks specified fleet metric, sets a threshold value, and specifies the type of action to initiate when triggered. With a rule-based policy, you can select from several available fleet metrics. Each policy specifies whether to scale up or scale down (and by how much), so you need one policy for each type of action.

For example, a policy may make the following statement: "If the percentage of idle instances is greater than 20% for more than 15 minutes, then reduce the fleet capacity by 10%."

A policy's rule statement has the following structure:

If [MetricName] is [ComparisonOperator] [Threshold] for [EvaluationPeriods] minutes, then [ScalingAdjustmentType] to/by [ScalingAdjustment].

To implement the example, the rule statement would look like this:

If [PercentIdleInstances] is [GreaterThanThreshold] [20] for [15] minutes, then [PercentChangeInCapacity] to/by [10].

To create or update a scaling policy, specify a unique combination of name and fleet ID, and set the policy type to "RuleBased". Specify the parameter values for a policy rule statement. On a successful request, the policy name is returned. Scaling policies are automatically in force as soon as they're successfully created. If the fleet's auto-scaling actions are temporarily suspended, the new policy will be in force once the fleet actions are restarted.

Parameter Syntax

$result = $client->putScalingPolicy([
    'ComparisonOperator' => 'GreaterThanOrEqualToThreshold|GreaterThanThreshold|LessThanThreshold|LessThanOrEqualToThreshold',
    'EvaluationPeriods' => <integer>,
    'FleetId' => '<string>', // REQUIRED
    'MetricName' => 'ActivatingGameSessions|ActiveGameSessions|ActiveInstances|AvailableGameSessions|AvailablePlayerSessions|CurrentPlayerSessions|IdleInstances|PercentAvailableGameSessions|PercentIdleInstances|QueueDepth|WaitTime|ConcurrentActivatableGameSessions', // REQUIRED
    'Name' => '<string>', // REQUIRED
    'PolicyType' => 'RuleBased|TargetBased',
    'ScalingAdjustment' => <integer>,
    'ScalingAdjustmentType' => 'ChangeInCapacity|ExactCapacity|PercentChangeInCapacity',
    'TargetConfiguration' => [
        'TargetValue' => <float>, // REQUIRED
    ],
    'Threshold' => <float>,
]);

Parameter Details

Members
ComparisonOperator
Type: string

Comparison operator to use when measuring the metric against the threshold value.

EvaluationPeriods
Type: int

Length of time (in minutes) the metric must be at or beyond the threshold before a scaling event is triggered.

FleetId
Required: Yes
Type: string

A unique identifier for the fleet to apply this policy to. You can use either the fleet ID or ARN value. The fleet cannot be in any of the following statuses: ERROR or DELETING.

MetricName
Required: Yes
Type: string

Name of the Amazon GameLift-defined metric that is used to trigger a scaling adjustment. For detailed descriptions of fleet metrics, see Monitor Amazon GameLift with Amazon CloudWatch.

  • ActivatingGameSessions -- Game sessions in the process of being created.

  • ActiveGameSessions -- Game sessions that are currently running.

  • ActiveInstances -- Fleet instances that are currently running at least one game session.

  • AvailableGameSessions -- Additional game sessions that fleet could host simultaneously, given current capacity.

  • AvailablePlayerSessions -- Empty player slots in currently active game sessions. This includes game sessions that are not currently accepting players. Reserved player slots are not included.

  • CurrentPlayerSessions -- Player slots in active game sessions that are being used by a player or are reserved for a player.

  • IdleInstances -- Active instances that are currently hosting zero game sessions.

  • PercentAvailableGameSessions -- Unused percentage of the total number of game sessions that a fleet could host simultaneously, given current capacity. Use this metric for a target-based scaling policy.

  • PercentIdleInstances -- Percentage of the total number of active instances that are hosting zero game sessions.

  • QueueDepth -- Pending game session placement requests, in any queue, where the current fleet is the top-priority destination.

  • WaitTime -- Current wait time for pending game session placement requests, in any queue, where the current fleet is the top-priority destination.

Name
Required: Yes
Type: string

A descriptive label that is associated with a fleet's scaling policy. Policy names do not need to be unique. A fleet can have only one scaling policy with the same name.

PolicyType
Type: string

The type of scaling policy to create. For a target-based policy, set the parameter MetricName to 'PercentAvailableGameSessions' and specify a TargetConfiguration. For a rule-based policy set the following parameters: MetricName, ComparisonOperator, Threshold, EvaluationPeriods, ScalingAdjustmentType, and ScalingAdjustment.

ScalingAdjustment
Type: int

Amount of adjustment to make, based on the scaling adjustment type.

ScalingAdjustmentType
Type: string

The type of adjustment to make to a fleet's instance count:

  • ChangeInCapacity -- add (or subtract) the scaling adjustment value from the current instance count. Positive values scale up while negative values scale down.

  • ExactCapacity -- set the instance count to the scaling adjustment value.

  • PercentChangeInCapacity -- increase or reduce the current instance count by the scaling adjustment, read as a percentage. Positive values scale up while negative values scale down; for example, a value of "-10" scales the fleet down by 10%.

TargetConfiguration
Type: TargetConfiguration structure

An object that contains settings for a target-based scaling policy.

Threshold
Type: double

Metric value used to trigger a scaling event.

Result Syntax

[
    'Name' => '<string>',
]

Result Details

Members
Name
Type: string

A descriptive label that is associated with a fleet's scaling policy. Policy names do not need to be unique.

Errors

InternalServiceException:

The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

InvalidRequestException:

One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

UnauthorizedException:

The client failed authentication. Clients should not retry such requests.

NotFoundException:

THe requested resources was not found. The resource was either not created yet or deleted.

RegisterCompute

$result = $client->registerCompute([/* ... */]);
$promise = $client->registerComputeAsync([/* ... */]);

This operation has been expanded to use with the Amazon GameLift containers feature, which is currently in public preview.

Registers a compute resource in an Amazon GameLift fleet. Register computes with an Amazon GameLift Anywhere fleet or a container fleet.

For an Anywhere fleet or a container fleet that's running the Amazon GameLift Agent, the Agent handles all compute registry tasks for you. For an Anywhere fleet that doesn't use the Agent, call this operation to register fleet computes.

To register a compute, give the compute a name (must be unique within the fleet) and specify the compute resource's DNS name or IP address. Provide a fleet ID and a fleet location to associate with the compute being registered. You can optionally include the path to a TLS certificate on the compute resource.

If successful, this operation returns compute details, including an Amazon GameLift SDK endpoint or Agent endpoint. Game server processes running on the compute can use this endpoint to communicate with the Amazon GameLift service. Each server process includes the SDK endpoint in its call to the Amazon GameLift server SDK action InitSDK().

To view compute details, call DescribeCompute with the compute name.

Learn more

Parameter Syntax

$result = $client->registerCompute([
    'CertificatePath' => '<string>',
    'ComputeName' => '<string>', // REQUIRED
    'DnsName' => '<string>',
    'FleetId' => '<string>', // REQUIRED
    'IpAddress' => '<string>',
    'Location' => '<string>',
]);

Parameter Details

Members
CertificatePath
Type: string

The path to a TLS certificate on your compute resource. Amazon GameLift doesn't validate the path and certificate.

ComputeName
Required: Yes
Type: string

A descriptive label for the compute resource.

DnsName
Type: string

The DNS name of the compute resource. Amazon GameLift requires either a DNS name or IP address.

FleetId
Required: Yes
Type: string

A unique identifier for the fleet to register the compute to. You can use either the fleet ID or ARN value.

IpAddress
Type: string

The IP address of the compute resource. Amazon GameLift requires either a DNS name or IP address.

Location
Type: string

The name of a custom location to associate with the compute resource being registered.

Result Syntax

[
    'Compute' => [
        'ComputeArn' => '<string>',
        'ComputeName' => '<string>',
        'ComputeStatus' => 'PENDING|ACTIVE|TERMINATING',
        'ContainerAttributes' => [
            'ContainerPortMappings' => [
                [
                    'ConnectionPort' => <integer>,
                    'ContainerPort' => <integer>,
                    'Protocol' => 'TCP|UDP',
                ],
                // ...
            ],
        ],
        'CreationTime' => <DateTime>,
        'DnsName' => '<string>',
        'FleetArn' => '<string>',
        'FleetId' => '<string>',
        'GameLiftAgentEndpoint' => '<string>',
        'GameLiftServiceSdkEndpoint' => '<string>',
        'InstanceId' => '<string>',
        'IpAddress' => '<string>',
        'Location' => '<string>',
        'OperatingSystem' => 'WINDOWS_2012|AMAZON_LINUX|AMAZON_LINUX_2|WINDOWS_2016|AMAZON_LINUX_2023',
        'Type' => 't2.micro|t2.small|t2.medium|t2.large|c3.large|c3.xlarge|c3.2xlarge|c3.4xlarge|c3.8xlarge|c4.large|c4.xlarge|c4.2xlarge|c4.4xlarge|c4.8xlarge|c5.large|c5.xlarge|c5.2xlarge|c5.4xlarge|c5.9xlarge|c5.12xlarge|c5.18xlarge|c5.24xlarge|c5a.large|c5a.xlarge|c5a.2xlarge|c5a.4xlarge|c5a.8xlarge|c5a.12xlarge|c5a.16xlarge|c5a.24xlarge|r3.large|r3.xlarge|r3.2xlarge|r3.4xlarge|r3.8xlarge|r4.large|r4.xlarge|r4.2xlarge|r4.4xlarge|r4.8xlarge|r4.16xlarge|r5.large|r5.xlarge|r5.2xlarge|r5.4xlarge|r5.8xlarge|r5.12xlarge|r5.16xlarge|r5.24xlarge|r5a.large|r5a.xlarge|r5a.2xlarge|r5a.4xlarge|r5a.8xlarge|r5a.12xlarge|r5a.16xlarge|r5a.24xlarge|m3.medium|m3.large|m3.xlarge|m3.2xlarge|m4.large|m4.xlarge|m4.2xlarge|m4.4xlarge|m4.10xlarge|m5.large|m5.xlarge|m5.2xlarge|m5.4xlarge|m5.8xlarge|m5.12xlarge|m5.16xlarge|m5.24xlarge|m5a.large|m5a.xlarge|m5a.2xlarge|m5a.4xlarge|m5a.8xlarge|m5a.12xlarge|m5a.16xlarge|m5a.24xlarge|c5d.large|c5d.xlarge|c5d.2xlarge|c5d.4xlarge|c5d.9xlarge|c5d.12xlarge|c5d.18xlarge|c5d.24xlarge|c6a.large|c6a.xlarge|c6a.2xlarge|c6a.4xlarge|c6a.8xlarge|c6a.12xlarge|c6a.16xlarge|c6a.24xlarge|c6i.large|c6i.xlarge|c6i.2xlarge|c6i.4xlarge|c6i.8xlarge|c6i.12xlarge|c6i.16xlarge|c6i.24xlarge|r5d.large|r5d.xlarge|r5d.2xlarge|r5d.4xlarge|r5d.8xlarge|r5d.12xlarge|r5d.16xlarge|r5d.24xlarge|m6g.medium|m6g.large|m6g.xlarge|m6g.2xlarge|m6g.4xlarge|m6g.8xlarge|m6g.12xlarge|m6g.16xlarge|c6g.medium|c6g.large|c6g.xlarge|c6g.2xlarge|c6g.4xlarge|c6g.8xlarge|c6g.12xlarge|c6g.16xlarge|r6g.medium|r6g.large|r6g.xlarge|r6g.2xlarge|r6g.4xlarge|r6g.8xlarge|r6g.12xlarge|r6g.16xlarge|c6gn.medium|c6gn.large|c6gn.xlarge|c6gn.2xlarge|c6gn.4xlarge|c6gn.8xlarge|c6gn.12xlarge|c6gn.16xlarge|c7g.medium|c7g.large|c7g.xlarge|c7g.2xlarge|c7g.4xlarge|c7g.8xlarge|c7g.12xlarge|c7g.16xlarge|r7g.medium|r7g.large|r7g.xlarge|r7g.2xlarge|r7g.4xlarge|r7g.8xlarge|r7g.12xlarge|r7g.16xlarge|m7g.medium|m7g.large|m7g.xlarge|m7g.2xlarge|m7g.4xlarge|m7g.8xlarge|m7g.12xlarge|m7g.16xlarge|g5g.xlarge|g5g.2xlarge|g5g.4xlarge|g5g.8xlarge|g5g.16xlarge',
    ],
]

Result Details

Members
Compute
Type: Compute structure

The details of the compute resource you registered.

Errors

UnauthorizedException:

The client failed authentication. Clients should not retry such requests.

InvalidRequestException:

One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

ConflictException:

The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request.

InternalServiceException:

The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

NotReadyException:

The operation failed because Amazon GameLift has not yet finished validating this compute. We recommend attempting 8 to 10 retries over 3 to 5 minutes with exponential backoffs and jitter.

LimitExceededException:

The requested operation would cause the resource to exceed the allowed service limit. Resolve the issue before retrying.

RegisterGameServer

$result = $client->registerGameServer([/* ... */]);
$promise = $client->registerGameServerAsync([/* ... */]);

This operation is used with the Amazon GameLift FleetIQ solution and game server groups.

Creates a new game server resource and notifies Amazon GameLift FleetIQ that the game server is ready to host gameplay and players. This operation is called by a game server process that is running on an instance in a game server group. Registering game servers enables Amazon GameLift FleetIQ to track available game servers and enables game clients and services to claim a game server for a new game session.

To register a game server, identify the game server group and instance where the game server is running, and provide a unique identifier for the game server. You can also include connection and game server data.

Once a game server is successfully registered, it is put in status AVAILABLE. A request to register a game server may fail if the instance it is running on is in the process of shutting down as part of instance balancing or scale-down activity.

Learn more

Amazon GameLift FleetIQ Guide

Parameter Syntax

$result = $client->registerGameServer([
    'ConnectionInfo' => '<string>',
    'GameServerData' => '<string>',
    'GameServerGroupName' => '<string>', // REQUIRED
    'GameServerId' => '<string>', // REQUIRED
    'InstanceId' => '<string>', // REQUIRED
]);

Parameter Details

Members
ConnectionInfo
Type: string

Information that is needed to make inbound client connections to the game server. This might include the IP address and port, DNS name, and other information.

GameServerData
Type: string

A set of custom game server properties, formatted as a single string value. This data is passed to a game client or service when it requests information on game servers.

GameServerGroupName
Required: Yes
Type: string

A unique identifier for the game server group where the game server is running.

GameServerId
Required: Yes
Type: string

A custom string that uniquely identifies the game server to register. Game server IDs are developer-defined and must be unique across all game server groups in your Amazon Web Services account.

InstanceId
Required: Yes
Type: string

The unique identifier for the instance where the game server is running. This ID is available in the instance metadata. EC2 instance IDs use a 17-character format, for example: i-1234567890abcdef0.

Result Syntax

[
    'GameServer' => [
        'ClaimStatus' => 'CLAIMED',
        'ConnectionInfo' => '<string>',
        'GameServerData' => '<string>',
        'GameServerGroupArn' => '<string>',
        'GameServerGroupName' => '<string>',
        'GameServerId' => '<string>',
        'InstanceId' => '<string>',
        'LastClaimTime' => <DateTime>,
        'LastHealthCheckTime' => <DateTime>,
        'RegistrationTime' => <DateTime>,
        'UtilizationStatus' => 'AVAILABLE|UTILIZED',
    ],
]

Result Details

Members
GameServer
Type: GameServer structure

Object that describes the newly registered game server.

Errors

InvalidRequestException:

One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

ConflictException:

The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request.

UnauthorizedException:

The client failed authentication. Clients should not retry such requests.

LimitExceededException:

The requested operation would cause the resource to exceed the allowed service limit. Resolve the issue before retrying.

InternalServiceException:

The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

RequestUploadCredentials

$result = $client->requestUploadCredentials([/* ... */]);
$promise = $client->requestUploadCredentialsAsync([/* ... */]);

Retrieves a fresh set of credentials for use when uploading a new set of game build files to Amazon GameLift's Amazon S3. This is done as part of the build creation process; see CreateBuild.

To request new credentials, specify the build ID as returned with an initial CreateBuild request. If successful, a new set of credentials are returned, along with the S3 storage location associated with the build ID.

Learn more

Create a Build with Files in S3

All APIs by task

Parameter Syntax

$result = $client->requestUploadCredentials([
    'BuildId' => '<string>', // REQUIRED
]);

Parameter Details

Members
BuildId
Required: Yes
Type: string

A unique identifier for the build to get credentials for. You can use either the build ID or ARN value.

Result Syntax

[
    'StorageLocation' => [
        'Bucket' => '<string>',
        'Key' => '<string>',
        'ObjectVersion' => '<string>',
        'RoleArn' => '<string>',
    ],
    'UploadCredentials' => [
        'AccessKeyId' => '<string>',
        'SecretAccessKey' => '<string>',
        'SessionToken' => '<string>',
    ],
]

Result Details

Members
StorageLocation
Type: S3Location structure

Amazon S3 path and key, identifying where the game build files are stored.

UploadCredentials
Type: AwsCredentials structure

Amazon Web Services credentials required when uploading a game build to the storage location. These credentials have a limited lifespan and are valid only for the build they were issued for.

Errors

UnauthorizedException:

The client failed authentication. Clients should not retry such requests.

InvalidRequestException:

One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

NotFoundException:

THe requested resources was not found. The resource was either not created yet or deleted.

InternalServiceException:

The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

ResolveAlias

$result = $client->resolveAlias([/* ... */]);
$promise = $client->resolveAliasAsync([/* ... */]);

Attempts to retrieve a fleet ID that is associated with an alias. Specify a unique alias identifier.

If the alias has a SIMPLE routing strategy, Amazon GameLift returns a fleet ID. If the alias has a TERMINAL routing strategy, the result is a TerminalRoutingStrategyException.

Related actions

All APIs by task

Parameter Syntax

$result = $client->resolveAlias([
    'AliasId' => '<string>', // REQUIRED
]);

Parameter Details

Members
AliasId
Required: Yes
Type: string

The unique identifier of the alias that you want to retrieve a fleet ID for. You can use either the alias ID or ARN value.

Result Syntax

[
    'FleetArn' => '<string>',
    'FleetId' => '<string>',
]

Result Details

Members
FleetArn
Type: string

The Amazon Resource Name (ARN) associated with the GameLift fleet resource that this alias points to.

FleetId
Type: string

The fleet identifier that the alias is pointing to.

Errors

UnauthorizedException:

The client failed authentication. Clients should not retry such requests.

InvalidRequestException:

One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

NotFoundException:

THe requested resources was not found. The resource was either not created yet or deleted.

TerminalRoutingStrategyException:

The service is unable to resolve the routing for a particular alias because it has a terminal RoutingStrategy associated with it. The message returned in this exception is the message defined in the routing strategy itself. Such requests should only be retried if the routing strategy for the specified alias is modified.

InternalServiceException:

The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

ResumeGameServerGroup

$result = $client->resumeGameServerGroup([/* ... */]);
$promise = $client->resumeGameServerGroupAsync([/* ... */]);

This operation is used with the Amazon GameLift FleetIQ solution and game server groups.

Reinstates activity on a game server group after it has been suspended. A game server group might be suspended by the SuspendGameServerGroup operation, or it might be suspended involuntarily due to a configuration problem. In the second case, you can manually resume activity on the group once the configuration problem has been resolved. Refer to the game server group status and status reason for more information on why group activity is suspended.

To resume activity, specify a game server group ARN and the type of activity to be resumed. If successful, a GameServerGroup object is returned showing that the resumed activity is no longer listed in SuspendedActions.

Learn more

Amazon GameLift FleetIQ Guide

Parameter Syntax

$result = $client->resumeGameServerGroup([
    'GameServerGroupName' => '<string>', // REQUIRED
    'ResumeActions' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members
GameServerGroupName
Required: Yes
Type: string

A unique identifier for the game server group. Use either the name or ARN value.

ResumeActions
Required: Yes
Type: Array of strings

The activity to resume for this game server group.

Result Syntax

[
    'GameServerGroup' => [
        'AutoScalingGroupArn' => '<string>',
        'BalancingStrategy' => 'SPOT_ONLY|SPOT_PREFERRED|ON_DEMAND_ONLY',
        'CreationTime' => <DateTime>,
        'GameServerGroupArn' => '<string>',
        'GameServerGroupName' => '<string>',
        'GameServerProtectionPolicy' => 'NO_PROTECTION|FULL_PROTECTION',
        'InstanceDefinitions' => [
            [
                'InstanceType' => 'c4.large|c4.xlarge|c4.2xlarge|c4.4xlarge|c4.8xlarge|c5.large|c5.xlarge|c5.2xlarge|c5.4xlarge|c5.9xlarge|c5.12xlarge|c5.18xlarge|c5.24xlarge|c5a.large|c5a.xlarge|c5a.2xlarge|c5a.4xlarge|c5a.8xlarge|c5a.12xlarge|c5a.16xlarge|c5a.24xlarge|c6g.medium|c6g.large|c6g.xlarge|c6g.2xlarge|c6g.4xlarge|c6g.8xlarge|c6g.12xlarge|c6g.16xlarge|r4.large|r4.xlarge|r4.2xlarge|r4.4xlarge|r4.8xlarge|r4.16xlarge|r5.large|r5.xlarge|r5.2xlarge|r5.4xlarge|r5.8xlarge|r5.12xlarge|r5.16xlarge|r5.24xlarge|r5a.large|r5a.xlarge|r5a.2xlarge|r5a.4xlarge|r5a.8xlarge|r5a.12xlarge|r5a.16xlarge|r5a.24xlarge|r6g.medium|r6g.large|r6g.xlarge|r6g.2xlarge|r6g.4xlarge|r6g.8xlarge|r6g.12xlarge|r6g.16xlarge|m4.large|m4.xlarge|m4.2xlarge|m4.4xlarge|m4.10xlarge|m5.large|m5.xlarge|m5.2xlarge|m5.4xlarge|m5.8xlarge|m5.12xlarge|m5.16xlarge|m5.24xlarge|m5a.large|m5a.xlarge|m5a.2xlarge|m5a.4xlarge|m5a.8xlarge|m5a.12xlarge|m5a.16xlarge|m5a.24xlarge|m6g.medium|m6g.large|m6g.xlarge|m6g.2xlarge|m6g.4xlarge|m6g.8xlarge|m6g.12xlarge|m6g.16xlarge',
                'WeightedCapacity' => '<string>',
            ],
            // ...
        ],
        'LastUpdatedTime' => <DateTime>,
        'RoleArn' => '<string>',
        'Status' => 'NEW|ACTIVATING|ACTIVE|DELETE_SCHEDULED|DELETING|DELETED|ERROR',
        'StatusReason' => '<string>',
        'SuspendedActions' => ['<string>', ...],
    ],
]

Result Details

Members
GameServerGroup
Type: GameServerGroup structure

An object that describes the game server group resource, with the SuspendedActions property updated to reflect the resumed activity.

Errors

InvalidRequestException:

One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

NotFoundException:

THe requested resources was not found. The resource was either not created yet or deleted.

UnauthorizedException:

The client failed authentication. Clients should not retry such requests.

InternalServiceException:

The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

SearchGameSessions

$result = $client->searchGameSessions([/* ... */]);
$promise = $client->searchGameSessionsAsync([/* ... */]);

Retrieves all active game sessions that match a set of search criteria and sorts them into a specified order.

This operation is not designed to continually track game session status because that practice can cause you to exceed your API limit and generate errors. Instead, configure an Amazon Simple Notification Service (Amazon SNS) topic to receive notifications from a matchmaker or a game session placement queue.

When searching for game sessions, you specify exactly where you want to search and provide a search filter expression, a sort expression, or both. A search request can search only one fleet, but it can search all of a fleet's locations.

This operation can be used in the following ways:

  • To search all game sessions that are currently running on all locations in a fleet, provide a fleet or alias ID. This approach returns game sessions in the fleet's home Region and all remote locations that fit the search criteria.

  • To search all game sessions that are currently running on a specific fleet location, provide a fleet or alias ID and a location name. For location, you can specify a fleet's home Region or any remote location.

Use the pagination parameters to retrieve results as a set of sequential pages.

If successful, a GameSession object is returned for each game session that matches the request. Search finds game sessions that are in ACTIVE status only. To retrieve information on game sessions in other statuses, use DescribeGameSessions .

To set search and sort criteria, create a filter expression using the following game session attributes. For game session search examples, see the Examples section of this topic.

  • gameSessionId -- A unique identifier for the game session. You can use either a GameSessionId or GameSessionArn value.

  • gameSessionName -- Name assigned to a game session. Game session names do not need to be unique to a game session.

  • gameSessionProperties -- A set of key-value pairs that can store custom data in a game session. For example: {"Key": "difficulty", "Value": "novice"}. The filter expression must specify the GameProperty -- a Key and a string Value to search for the game sessions.

    For example, to search for the above key-value pair, specify the following search filter: gameSessionProperties.difficulty = "novice". All game property values are searched as strings.

    For examples of searching game sessions, see the ones below, and also see Search game sessions by game property.

  • maximumSessions -- Maximum number of player sessions allowed for a game session.

  • creationTimeMillis -- Value indicating when a game session was created. It is expressed in Unix time as milliseconds.

  • playerSessionCount -- Number of players currently connected to a game session. This value changes rapidly as players join the session or drop out.

  • hasAvailablePlayerSessions -- Boolean value indicating whether a game session has reached its maximum number of players. It is highly recommended that all search requests include this filter attribute to optimize search performance and return only sessions that players can join.

Returned values for playerSessionCount and hasAvailablePlayerSessions change quickly as players join sessions and others drop out. Results should be considered a snapshot in time. Be sure to refresh search results often, and handle sessions that fill up before a player can join.

All APIs by task

Parameter Syntax

$result = $client->searchGameSessions([
    'AliasId' => '<string>',
    'FilterExpression' => '<string>',
    'FleetId' => '<string>',
    'Limit' => <integer>,
    'Location' => '<string>',
    'NextToken' => '<string>',
    'SortExpression' => '<string>',
]);

Parameter Details

Members
AliasId
Type: string

A unique identifier for the alias associated with the fleet to search for active game sessions. You can use either the alias ID or ARN value. Each request must reference either a fleet ID or alias ID, but not both.

FilterExpression
Type: string

String containing the search criteria for the session search. If no filter expression is included, the request returns results for all game sessions in the fleet that are in ACTIVE status.

A filter expression can contain one or multiple conditions. Each condition consists of the following:

  • Operand -- Name of a game session attribute. Valid values are gameSessionName, gameSessionId, gameSessionProperties, maximumSessions, creationTimeMillis, playerSessionCount, hasAvailablePlayerSessions.

  • Comparator -- Valid comparators are: =, <>, <, >, <=, >=.

  • Value -- Value to be searched for. Values may be numbers, boolean values (true/false) or strings depending on the operand. String values are case sensitive and must be enclosed in single quotes. Special characters must be escaped. Boolean and string values can only be used with the comparators = and <>. For example, the following filter expression searches on gameSessionName: "FilterExpression": "gameSessionName = 'Matt\\'s Awesome Game 1'".

To chain multiple conditions in a single expression, use the logical keywords AND, OR, and NOT and parentheses as needed. For example: x AND y AND NOT z, NOT (x OR y).

Session search evaluates conditions from left to right using the following precedence rules:

  1. =, <>, <, >, <=, >=

  2. Parentheses

  3. NOT

  4. AND

  5. OR

For example, this filter expression retrieves game sessions hosting at least ten players that have an open player slot: "maximumSessions>=10 AND hasAvailablePlayerSessions=true".

FleetId
Type: string

A unique identifier for the fleet to search for active game sessions. You can use either the fleet ID or ARN value. Each request must reference either a fleet ID or alias ID, but not both.

Limit
Type: int

The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages. The maximum number of results returned is 20, even if this value is not set or is set higher than 20.

Location
Type: string

A fleet location to search for game sessions. You can specify a fleet's home Region or a remote location. Use the Amazon Web Services Region code format, such as us-west-2.

NextToken
Type: string

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.

SortExpression
Type: string

Instructions on how to sort the search results. If no sort expression is included, the request returns results in random order. A sort expression consists of the following elements:

  • Operand -- Name of a game session attribute. Valid values are gameSessionName, gameSessionId, gameSessionProperties, maximumSessions, creationTimeMillis, playerSessionCount, hasAvailablePlayerSessions.

  • Order -- Valid sort orders are ASC (ascending) and DESC (descending).

For example, this sort expression returns the oldest active sessions first: "SortExpression": "creationTimeMillis ASC". Results with a null value for the sort operand are returned at the end of the list.

Result Syntax

[
    'GameSessions' => [
        [
            'CreationTime' => <DateTime>,
            'CreatorId' => '<string>',
            'CurrentPlayerSessionCount' => <integer>,
            'DnsName' => '<string>',
            'FleetArn' => '<string>',
            'FleetId' => '<string>',
            'GameProperties' => [
                [
                    'Key' => '<string>',
                    'Value' => '<string>',
                ],
                // ...
            ],
            'GameSessionData' => '<string>',
            'GameSessionId' => '<string>',
            'IpAddress' => '<string>',
            'Location' => '<string>',
            'MatchmakerData' => '<string>',
            'MaximumPlayerSessionCount' => <integer>,
            'Name' => '<string>',
            'PlayerSessionCreationPolicy' => 'ACCEPT_ALL|DENY_ALL',
            'Port' => <integer>,
            'Status' => 'ACTIVE|ACTIVATING|TERMINATED|TERMINATING|ERROR',
            'StatusReason' => 'INTERRUPTED',
            'TerminationTime' => <DateTime>,
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members
GameSessions
Type: Array of GameSession structures

A collection of objects containing game session properties for each session that matches the request.

NextToken
Type: string

A token that indicates where to resume retrieving results on the next call to this operation. If no token is returned, these results represent the end of the list.

Errors

InternalServiceException:

The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

NotFoundException:

THe requested resources was not found. The resource was either not created yet or deleted.

InvalidRequestException:

One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

UnauthorizedException:

The client failed authentication. Clients should not retry such requests.

TerminalRoutingStrategyException:

The service is unable to resolve the routing for a particular alias because it has a terminal RoutingStrategy associated with it. The message returned in this exception is the message defined in the routing strategy itself. Such requests should only be retried if the routing strategy for the specified alias is modified.

UnsupportedRegionException:

The requested operation is not supported in the Region specified.

StartFleetActions

$result = $client->startFleetActions([/* ... */]);
$promise = $client->startFleetActionsAsync([/* ... */]);

Resumes certain types of activity on fleet instances that were suspended with StopFleetActions. For multi-location fleets, fleet actions are managed separately for each location. Currently, this operation is used to restart a fleet's auto-scaling activity.

This operation can be used in the following ways:

  • To restart actions on instances in the fleet's home Region, provide a fleet ID and the type of actions to resume.

  • To restart actions on instances in one of the fleet's remote locations, provide a fleet ID, a location name, and the type of actions to resume.

If successful, Amazon GameLift once again initiates scaling events as triggered by the fleet's scaling policies. If actions on the fleet location were never stopped, this operation will have no effect.

Learn more

Setting up Amazon GameLift fleets

Parameter Syntax

$result = $client->startFleetActions([
    'Actions' => ['<string>', ...], // REQUIRED
    'FleetId' => '<string>', // REQUIRED
    'Location' => '<string>',
]);

Parameter Details

Members
Actions
Required: Yes
Type: Array of strings

List of actions to restart on the fleet.

FleetId
Required: Yes
Type: string

A unique identifier for the fleet to restart actions on. You can use either the fleet ID or ARN value.

Location
Type: string

The fleet location to restart fleet actions for. Specify a location in the form of an Amazon Web Services Region code, such as us-west-2.

Result Syntax

[
    'FleetArn' => '<string>',
    'FleetId' => '<string>',
]

Result Details

Members
FleetArn
Type: string

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.

FleetId
Type: string

A unique identifier for the fleet to restart actions on.

Errors

InternalServiceException:

The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

InvalidRequestException:

One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

UnauthorizedException:

The client failed authentication. Clients should not retry such requests.

NotFoundException:

THe requested resources was not found. The resource was either not created yet or deleted.

UnsupportedRegionException:

The requested operation is not supported in the Region specified.

StartGameSessionPlacement

$result = $client->startGameSessionPlacement([/* ... */]);
$promise = $client->startGameSessionPlacementAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->startGameSessionPlacement([
    'DesiredPlayerSessions' => [
        [
            'PlayerData' => '<string>',
            'PlayerId' => '<string>',
        ],
        // ...
    ],
    'GameProperties' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'GameSessionData' => '<string>',
    'GameSessionName' => '<string>',
    'GameSessionQueueName' => '<string>', // REQUIRED
    'MaximumPlayerSessionCount' => <integer>, // REQUIRED
    'PlacementId' => '<string>', // REQUIRED
    'PlayerLatencies' => [
        [
            'LatencyInMilliseconds' => <float>,
            'PlayerId' => '<string>',
            'RegionIdentifier' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Members
DesiredPlayerSessions
Type: Array of DesiredPlayerSession structures

Set of information on each player to create a player session for.

GameProperties
Type: Array of GameProperty structures

A set of key-value pairs that can store custom data in a game session. For example: {"Key": "difficulty", "Value": "novice"}.

GameSessionData
Type: string

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

GameSessionName
Type: string

A descriptive label that is associated with a game session. Session names do not need to be unique.

GameSessionQueueName
Required: Yes
Type: string

Name of the queue to use to place the new game session. You can use either the queue name or ARN value.

MaximumPlayerSessionCount
Required: Yes
Type: int

The maximum number of players that can be connected simultaneously to the game session.

PlacementId
Required: Yes
Type: string

A unique identifier to assign to the new game session placement. This value is developer-defined. The value must be unique across all Regions and cannot be reused.

PlayerLatencies
Type: Array of PlayerLatency structures

A set of values, expressed in milliseconds, that indicates the amount of latency that a player experiences when connected to Amazon Web Services Regions. This information is used to try to place the new game session where it can offer the best possible gameplay experience for the players.

Result Syntax

[
    'GameSessionPlacement' => [
        'DnsName' => '<string>',
        'EndTime' => <DateTime>,
        'GameProperties' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
        'GameSessionArn' => '<string>',
        'GameSessionData' => '<string>',
        'GameSessionId' => '<string>',
        'GameSessionName' => '<string>',
        'GameSessionQueueName' => '<string>',
        'GameSessionRegion' => '<string>',
        'IpAddress' => '<string>',
        'MatchmakerData' => '<string>',
        'MaximumPlayerSessionCount' => <integer>,
        'PlacedPlayerSessions' => [
            [
                'PlayerId' => '<string>',
                'PlayerSessionId' => '<string>',
            ],
            // ...
        ],
        'PlacementId' => '<string>',
        'PlayerLatencies' => [
            [
                'LatencyInMilliseconds' => <float>,
                'PlayerId' => '<string>',
                'RegionIdentifier' => '<string>',
            ],
            // ...
        ],
        'Port' => <integer>,
        'StartTime' => <DateTime>,
        'Status' => 'PENDING|FULFILLED|CANCELLED|TIMED_OUT|FAILED',
    ],
]

Result Details

Members
GameSessionPlacement
Type: GameSessionPlacement structure

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.

Errors

InternalServiceException:

The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

InvalidRequestException:

One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

NotFoundException:

THe requested resources was not found. The resource was either not created yet or deleted.

UnauthorizedException:

The client failed authentication. Clients should not retry such requests.

StartMatchBackfill

$result = $client->startMatchBackfill([/* ... */]);
$promise = $client->startMatchBackfillAsync([/* ... */]);

Finds new players to fill open slots in currently running game sessions. The backfill match process is essentially identical to the process of forming new matches. Backfill requests use the same matchmaker that was used to make the original match, and they provide matchmaking data for all players currently in the game session. FlexMatch uses this information to select new players so that backfilled match continues to meet the original match requirements.

When using FlexMatch with Amazon GameLift managed hosting, you can request a backfill match from a client service by calling this operation with a GameSessions ID. You also have the option of making backfill requests directly from your game server. In response to a request, FlexMatch creates player sessions for the new players, updates the GameSession resource, and sends updated matchmaking data to the game server. You can request a backfill match at any point after a game session is started. Each game session can have only one active backfill request at a time; a subsequent request automatically replaces the earlier request.

When using FlexMatch as a standalone component, request a backfill match by calling this operation without a game session identifier. As with newly formed matches, matchmaking results are returned in a matchmaking event so that your game can update the game session that is being backfilled.

To request a backfill match, specify a unique ticket ID, the original matchmaking configuration, and matchmaking data for all current players in the game session being backfilled. Optionally, specify the GameSession ARN. If successful, a match backfill ticket is created and returned with status set to QUEUED. Track the status of backfill tickets using the same method for tracking tickets for new matches.

Only game sessions created by FlexMatch are supported for match backfill.

Learn more

Backfill existing games with FlexMatch

Matchmaking events (reference)

How Amazon GameLift FlexMatch works

Parameter Syntax

$result = $client->startMatchBackfill([
    'ConfigurationName' => '<string>', // REQUIRED
    'GameSessionArn' => '<string>',
    'Players' => [ // REQUIRED
        [
            'LatencyInMs' => [<integer>, ...],
            'PlayerAttributes' => [
                '<NonZeroAndMaxString>' => [
                    'N' => <float>,
                    'S' => '<string>',
                    'SDM' => [<float>, ...],
                    'SL' => ['<string>', ...],
                ],
                // ...
            ],
            'PlayerId' => '<string>',
            'Team' => '<string>',
        ],
        // ...
    ],
    'TicketId' => '<string>',
]);

Parameter Details

Members
ConfigurationName
Required: Yes
Type: string

Name of the matchmaker to use for this request. You can use either the configuration name or ARN value. The ARN of the matchmaker that was used with the original game session is listed in the GameSession object, MatchmakerData property.

GameSessionArn
Type: string

A unique identifier for the game session. Use the game session ID. When using FlexMatch as a standalone matchmaking solution, this parameter is not needed.

Players
Required: Yes
Type: Array of Player structures

Match information on all players that are currently assigned to the game session. This information is used by the matchmaker to find new players and add them to the existing game.

You can include up to 199 Players in a StartMatchBackfill request.

  • PlayerID, PlayerAttributes, Team -- This information is maintained in the GameSession object, MatchmakerData property, for all players who are currently assigned to the game session. The matchmaker data is in JSON syntax, formatted as a string. For more details, see Match Data.

    The backfill request must specify the team membership for every player. Do not specify team if you are not using backfill.

  • LatencyInMs -- If the matchmaker uses player latency, include a latency value, in milliseconds, for the Region that the game session is currently in. Do not include latency values for any other Region.

TicketId
Type: string

A unique identifier for a matchmaking ticket. If no ticket ID is specified here, Amazon GameLift will generate one in the form of a UUID. Use this identifier to track the match backfill ticket status and retrieve match results.

Result Syntax

[
    'MatchmakingTicket' => [
        'ConfigurationArn' => '<string>',
        'ConfigurationName' => '<string>',
        'EndTime' => <DateTime>,
        'EstimatedWaitTime' => <integer>,
        'GameSessionConnectionInfo' => [
            'DnsName' => '<string>',
            'GameSessionArn' => '<string>',
            'IpAddress' => '<string>',
            'MatchedPlayerSessions' => [
                [
                    'PlayerId' => '<string>',
                    'PlayerSessionId' => '<string>',
                ],
                // ...
            ],
            'Port' => <integer>,
        ],
        'Players' => [
            [
                'LatencyInMs' => [<integer>, ...],
                'PlayerAttributes' => [
                    '<NonZeroAndMaxString>' => [
                        'N' => <float>,
                        'S' => '<string>',
                        'SDM' => [<float>, ...],
                        'SL' => ['<string>', ...],
                    ],
                    // ...
                ],
                'PlayerId' => '<string>',
                'Team' => '<string>',
            ],
            // ...
        ],
        'StartTime' => <DateTime>,
        'Status' => 'CANCELLED|COMPLETED|FAILED|PLACING|QUEUED|REQUIRES_ACCEPTANCE|SEARCHING|TIMED_OUT',
        'StatusMessage' => '<string>',
        'StatusReason' => '<string>',
        'TicketId' => '<string>',
    ],
]

Result Details

Members
MatchmakingTicket
Type: MatchmakingTicket structure

Ticket representing the backfill matchmaking request. This object includes the information in the request, ticket status, and match results as generated during the matchmaking process.

Errors

InvalidRequestException:

One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

NotFoundException:

THe requested resources was not found. The resource was either not created yet or deleted.

InternalServiceException:

The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

UnsupportedRegionException:

The requested operation is not supported in the Region specified.

StartMatchmaking

$result = $client->startMatchmaking([/* ... */]);
$promise = $client->startMatchmakingAsync([/* ... */]);

Uses FlexMatch to create a game match for a group of players based on custom matchmaking rules. With games that use Amazon GameLift managed hosting, this operation also triggers Amazon GameLift to find hosting resources and start a new game session for the new match. Each matchmaking request includes information on one or more players and specifies the FlexMatch matchmaker to use. When a request is for multiple players, FlexMatch attempts to build a match that includes all players in the request, placing them in the same team and finding additional players as needed to fill the match.

To start matchmaking, provide a unique ticket ID, specify a matchmaking configuration, and include the players to be matched. You must also include any player attributes that are required by the matchmaking configuration's rule set. If successful, a matchmaking ticket is returned with status set to QUEUED.

Track matchmaking events to respond as needed and acquire game session connection information for successfully completed matches. Ticket status updates are tracked using event notification through Amazon Simple Notification Service, which is defined in the matchmaking configuration.

Learn more

Add FlexMatch to a game client

Set Up FlexMatch event notification

How Amazon GameLift FlexMatch works

Parameter Syntax

$result = $client->startMatchmaking([
    'ConfigurationName' => '<string>', // REQUIRED
    'Players' => [ // REQUIRED
        [
            'LatencyInMs' => [<integer>, ...],
            'PlayerAttributes' => [
                '<NonZeroAndMaxString>' => [
                    'N' => <float>,
                    'S' => '<string>',
                    'SDM' => [<float>, ...],
                    'SL' => ['<string>', ...],
                ],
                // ...
            ],
            'PlayerId' => '<string>',
            'Team' => '<string>',
        ],
        // ...
    ],
    'TicketId' => '<string>',
]);

Parameter Details

Members
ConfigurationName
Required: Yes
Type: string

Name of the matchmaking configuration to use for this request. Matchmaking configurations must exist in the same Region as this request. You can use either the configuration name or ARN value.

Players
Required: Yes
Type: Array of Player structures

Information on each player to be matched. This information must include a player ID, and may contain player attributes and latency data to be used in the matchmaking process. After a successful match, Player objects contain the name of the team the player is assigned to.

You can include up to 10 Players in a StartMatchmaking request.

TicketId
Type: string

A unique identifier for a matchmaking ticket. If no ticket ID is specified here, Amazon GameLift will generate one in the form of a UUID. Use this identifier to track the matchmaking ticket status and retrieve match results.

Result Syntax

[
    'MatchmakingTicket' => [
        'ConfigurationArn' => '<string>',
        'ConfigurationName' => '<string>',
        'EndTime' => <DateTime>,
        'EstimatedWaitTime' => <integer>,
        'GameSessionConnectionInfo' => [
            'DnsName' => '<string>',
            'GameSessionArn' => '<string>',
            'IpAddress' => '<string>',
            'MatchedPlayerSessions' => [
                [
                    'PlayerId' => '<string>',
                    'PlayerSessionId' => '<string>',
                ],
                // ...
            ],
            'Port' => <integer>,
        ],
        'Players' => [
            [
                'LatencyInMs' => [<integer>, ...],
                'PlayerAttributes' => [
                    '<NonZeroAndMaxString>' => [
                        'N' => <float>,
                        'S' => '<string>',
                        'SDM' => [<float>, ...],
                        'SL' => ['<string>', ...],
                    ],
                    // ...
                ],
                'PlayerId' => '<string>',
                'Team' => '<string>',
            ],
            // ...
        ],
        'StartTime' => <DateTime>,
        'Status' => 'CANCELLED|COMPLETED|FAILED|PLACING|QUEUED|REQUIRES_ACCEPTANCE|SEARCHING|TIMED_OUT',
        'StatusMessage' => '<string>',
        'StatusReason' => '<string>',
        'TicketId' => '<string>',
    ],
]

Result Details

Members
MatchmakingTicket
Type: MatchmakingTicket structure

Ticket representing the matchmaking request. This object include the information included in the request, ticket status, and match results as generated during the matchmaking process.

Errors

InvalidRequestException:

One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

NotFoundException:

THe requested resources was not found. The resource was either not created yet or deleted.

InternalServiceException:

The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

UnsupportedRegionException:

The requested operation is not supported in the Region specified.

StopFleetActions

$result = $client->stopFleetActions([/* ... */]);
$promise = $client->stopFleetActionsAsync([/* ... */]);

Suspends certain types of activity in a fleet location. Currently, this operation is used to stop auto-scaling activity. For multi-location fleets, fleet actions are managed separately for each location.

Stopping fleet actions has several potential purposes. It allows you to temporarily stop auto-scaling activity but retain your scaling policies for use in the future. For multi-location fleets, you can set up fleet-wide auto-scaling, and then opt out of it for certain locations.

This operation can be used in the following ways:

  • To stop actions on instances in the fleet's home Region, provide a fleet ID and the type of actions to suspend.

  • To stop actions on instances in one of the fleet's remote locations, provide a fleet ID, a location name, and the type of actions to suspend.

If successful, Amazon GameLift no longer initiates scaling events except in response to manual changes using UpdateFleetCapacity. To restart fleet actions again, call StartFleetActions.

Learn more

Setting up Amazon GameLift Fleets

Parameter Syntax

$result = $client->stopFleetActions([
    'Actions' => ['<string>', ...], // REQUIRED
    'FleetId' => '<string>', // REQUIRED
    'Location' => '<string>',
]);

Parameter Details

Members
Actions
Required: Yes
Type: Array of strings

List of actions to suspend on the fleet.

FleetId
Required: Yes
Type: string

A unique identifier for the fleet to stop actions on. You can use either the fleet ID or ARN value.

Location
Type: string

The fleet location to stop fleet actions for. Specify a location in the form of an Amazon Web Services Region code, such as us-west-2.

Result Syntax

[
    'FleetArn' => '<string>',
    'FleetId' => '<string>',
]

Result Details

Members
FleetArn
Type: string

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.

FleetId
Type: string

A unique identifier for the fleet to stop actions on.

Errors

InternalServiceException:

The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

InvalidRequestException:

One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

UnauthorizedException:

The client failed authentication. Clients should not retry such requests.

NotFoundException:

THe requested resources was not found. The resource was either not created yet or deleted.

UnsupportedRegionException:

The requested operation is not supported in the Region specified.

StopGameSessionPlacement

$result = $client->stopGameSessionPlacement([/* ... */]);
$promise = $client->stopGameSessionPlacementAsync([/* ... */]);

Cancels a game session placement that is in PENDING status. To stop a placement, provide the placement ID values. If successful, the placement is moved to CANCELLED status.

Parameter Syntax

$result = $client->stopGameSessionPlacement([
    'PlacementId' => '<string>', // REQUIRED
]);

Parameter Details

Members
PlacementId
Required: Yes
Type: string

A unique identifier for a game session placement to stop.

Result Syntax

[
    'GameSessionPlacement' => [
        'DnsName' => '<string>',
        'EndTime' => <DateTime>,
        'GameProperties' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
        'GameSessionArn' => '<string>',
        'GameSessionData' => '<string>',
        'GameSessionId' => '<string>',
        'GameSessionName' => '<string>',
        'GameSessionQueueName' => '<string>',
        'GameSessionRegion' => '<string>',
        'IpAddress' => '<string>',
        'MatchmakerData' => '<string>',
        'MaximumPlayerSessionCount' => <integer>,
        'PlacedPlayerSessions' => [
            [
                'PlayerId' => '<string>',
                'PlayerSessionId' => '<string>',
            ],
            // ...
        ],
        'PlacementId' => '<string>',
        'PlayerLatencies' => [
            [
                'LatencyInMilliseconds' => <float>,
                'PlayerId' => '<string>',
                'RegionIdentifier' => '<string>',
            ],
            // ...
        ],
        'Port' => <integer>,
        'StartTime' => <DateTime>,
        'Status' => 'PENDING|FULFILLED|CANCELLED|TIMED_OUT|FAILED',
    ],
]

Result Details

Members
GameSessionPlacement
Type: GameSessionPlacement structure

Object that describes the canceled game session placement, with CANCELLED status and an end time stamp.

Errors

InternalServiceException:

The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

InvalidRequestException:

One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

NotFoundException:

THe requested resources was not found. The resource was either not created yet or deleted.

UnauthorizedException:

The client failed authentication. Clients should not retry such requests.

StopMatchmaking

$result = $client->stopMatchmaking([/* ... */]);
$promise = $client->stopMatchmakingAsync([/* ... */]);

Cancels a matchmaking ticket or match backfill ticket that is currently being processed. To stop the matchmaking operation, specify the ticket ID. If successful, work on the ticket is stopped, and the ticket status is changed to CANCELLED.

This call is also used to turn off automatic backfill for an individual game session. This is for game sessions that are created with a matchmaking configuration that has automatic backfill enabled. The ticket ID is included in the MatchmakerData of an updated game session object, which is provided to the game server.

If the operation is successful, the service sends back an empty JSON struct with the HTTP 200 response (not an empty HTTP body).

Learn more

Add FlexMatch to a game client

Parameter Syntax

$result = $client->stopMatchmaking([
    'TicketId' => '<string>', // REQUIRED
]);

Parameter Details

Members
TicketId
Required: Yes
Type: string

A unique identifier for a matchmaking ticket.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InvalidRequestException:

One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

NotFoundException:

THe requested resources was not found. The resource was either not created yet or deleted.

InternalServiceException:

The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

UnsupportedRegionException:

The requested operation is not supported in the Region specified.

SuspendGameServerGroup

$result = $client->suspendGameServerGroup([/* ... */]);
$promise = $client->suspendGameServerGroupAsync([/* ... */]);

This operation is used with the Amazon GameLift FleetIQ solution and game server groups.

Temporarily stops activity on a game server group without terminating instances or the game server group. You can restart activity by calling ResumeGameServerGroup. You can suspend the following activity:

  • Instance type replacement - This activity evaluates the current game hosting viability of all Spot instance types that are defined for the game server group. It updates the Auto Scaling group to remove nonviable Spot Instance types, which have a higher chance of game server interruptions. It then balances capacity across the remaining viable Spot Instance types. When this activity is suspended, the Auto Scaling group continues with its current balance, regardless of viability. Instance protection, utilization metrics, and capacity scaling activities continue to be active.

To suspend activity, specify a game server group ARN and the type of activity to be suspended. If successful, a GameServerGroup object is returned showing that the activity is listed in SuspendedActions.

Learn more

Amazon GameLift FleetIQ Guide

Parameter Syntax

$result = $client->suspendGameServerGroup([
    'GameServerGroupName' => '<string>', // REQUIRED
    'SuspendActions' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members
GameServerGroupName
Required: Yes
Type: string

A unique identifier for the game server group. Use either the name or ARN value.

SuspendActions
Required: Yes
Type: Array of strings

The activity to suspend for this game server group.

Result Syntax

[
    'GameServerGroup' => [
        'AutoScalingGroupArn' => '<string>',
        'BalancingStrategy' => 'SPOT_ONLY|SPOT_PREFERRED|ON_DEMAND_ONLY',
        'CreationTime' => <DateTime>,
        'GameServerGroupArn' => '<string>',
        'GameServerGroupName' => '<string>',
        'GameServerProtectionPolicy' => 'NO_PROTECTION|FULL_PROTECTION',
        'InstanceDefinitions' => [
            [
                'InstanceType' => 'c4.large|c4.xlarge|c4.2xlarge|c4.4xlarge|c4.8xlarge|c5.large|c5.xlarge|c5.2xlarge|c5.4xlarge|c5.9xlarge|c5.12xlarge|c5.18xlarge|c5.24xlarge|c5a.large|c5a.xlarge|c5a.2xlarge|c5a.4xlarge|c5a.8xlarge|c5a.12xlarge|c5a.16xlarge|c5a.24xlarge|c6g.medium|c6g.large|c6g.xlarge|c6g.2xlarge|c6g.4xlarge|c6g.8xlarge|c6g.12xlarge|c6g.16xlarge|r4.large|r4.xlarge|r4.2xlarge|r4.4xlarge|r4.8xlarge|r4.16xlarge|r5.large|r5.xlarge|r5.2xlarge|r5.4xlarge|r5.8xlarge|r5.12xlarge|r5.16xlarge|r5.24xlarge|r5a.large|r5a.xlarge|r5a.2xlarge|r5a.4xlarge|r5a.8xlarge|r5a.12xlarge|r5a.16xlarge|r5a.24xlarge|r6g.medium|r6g.large|r6g.xlarge|r6g.2xlarge|r6g.4xlarge|r6g.8xlarge|r6g.12xlarge|r6g.16xlarge|m4.large|m4.xlarge|m4.2xlarge|m4.4xlarge|m4.10xlarge|m5.large|m5.xlarge|m5.2xlarge|m5.4xlarge|m5.8xlarge|m5.12xlarge|m5.16xlarge|m5.24xlarge|m5a.large|m5a.xlarge|m5a.2xlarge|m5a.4xlarge|m5a.8xlarge|m5a.12xlarge|m5a.16xlarge|m5a.24xlarge|m6g.medium|m6g.large|m6g.xlarge|m6g.2xlarge|m6g.4xlarge|m6g.8xlarge|m6g.12xlarge|m6g.16xlarge',
                'WeightedCapacity' => '<string>',
            ],
            // ...
        ],
        'LastUpdatedTime' => <DateTime>,
        'RoleArn' => '<string>',
        'Status' => 'NEW|ACTIVATING|ACTIVE|DELETE_SCHEDULED|DELETING|DELETED|ERROR',
        'StatusReason' => '<string>',
        'SuspendedActions' => ['<string>', ...],
    ],
]

Result Details

Members
GameServerGroup
Type: GameServerGroup structure

An object that describes the game server group resource, with the SuspendedActions property updated to reflect the suspended activity.

Errors

InvalidRequestException:

One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

NotFoundException:

THe requested resources was not found. The resource was either not created yet or deleted.

UnauthorizedException:

The client failed authentication. Clients should not retry such requests.

InternalServiceException:

The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

TagResource

$result = $client->tagResource([/* ... */]);
$promise = $client->tagResourceAsync([/* ... */]);

Assigns a tag to an Amazon GameLift resource. You can use tags to organize resources, create IAM permissions policies to manage access to groups of resources, customize Amazon Web Services cost breakdowns, and more. This operation handles the permissions necessary to manage tags for Amazon GameLift resources that support tagging.

To add a tag to a resource, specify the unique ARN value for the resource and provide a tag list containing one or more tags. The operation succeeds even if the list includes tags that are already assigned to the resource.

Learn more

Tagging Amazon Web Services Resources in the Amazon Web Services General Reference

Amazon Web Services Tagging Strategies

Related actions

All APIs by task

Parameter Syntax

$result = $client->tagResource([
    'ResourceARN' => '<string>', // REQUIRED
    'Tags' => [ // REQUIRED
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Members
ResourceARN
Required: Yes
Type: string

The Amazon Resource Name (ARN) that uniquely identifies the Amazon GameLift resource that you want to assign tags to. Amazon GameLift includes resource ARNs in the data object for the resource. You can retrieve the ARN by calling a List or Describe operation for the resource type.

Tags
Required: Yes
Type: Array of Tag structures

A list of one or more tags to assign to the specified Amazon GameLift resource. Tags are developer-defined and structured as key-value pairs. The maximum tag limit may be lower than stated. See Tagging Amazon Web Services Resources for tagging limits.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

NotFoundException:

THe requested resources was not found. The resource was either not created yet or deleted.

InvalidRequestException:

One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

TaggingFailedException:

The requested tagging operation did not succeed. This may be due to invalid tag format or the maximum tag limit may have been exceeded. Resolve the issue before retrying.

InternalServiceException:

The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

UntagResource

$result = $client->untagResource([/* ... */]);
$promise = $client->untagResourceAsync([/* ... */]);

Removes a tag assigned to a Amazon GameLift resource. You can use resource tags to organize Amazon Web Services resources for a range of purposes. This operation handles the permissions necessary to manage tags for Amazon GameLift resources that support tagging.

To remove a tag from a resource, specify the unique ARN value for the resource and provide a string list containing one or more tags to remove. This operation succeeds even if the list includes tags that aren't assigned to the resource.

Learn more

Tagging Amazon Web Services Resources in the Amazon Web Services General Reference

Amazon Web Services Tagging Strategies

Related actions

All APIs by task

Parameter Syntax

$result = $client->untagResource([
    'ResourceARN' => '<string>', // REQUIRED
    'TagKeys' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members
ResourceARN
Required: Yes
Type: string

The Amazon Resource Name (ARN) that uniquely identifies the Amazon GameLift resource that you want to remove tags from. Amazon GameLift includes resource ARNs in the data object for the resource. You can retrieve the ARN by calling a List or Describe operation for the resource type.

TagKeys
Required: Yes
Type: Array of strings

A list of one or more tag keys to remove from the specified Amazon GameLift resource.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

NotFoundException:

THe requested resources was not found. The resource was either not created yet or deleted.

InvalidRequestException:

One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

TaggingFailedException:

The requested tagging operation did not succeed. This may be due to invalid tag format or the maximum tag limit may have been exceeded. Resolve the issue before retrying.

InternalServiceException:

The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

UpdateAlias

$result = $client->updateAlias([/* ... */]);
$promise = $client->updateAliasAsync([/* ... */]);

Updates properties for an alias. Specify the unique identifier of the alias to be updated and the new property values. When reassigning an alias to a new fleet, provide an updated routing strategy. If successful, the updated alias record is returned.

Related actions

All APIs by task

Parameter Syntax

$result = $client->updateAlias([
    'AliasId' => '<string>', // REQUIRED
    'Description' => '<string>',
    'Name' => '<string>',
    'RoutingStrategy' => [
        'FleetId' => '<string>',
        'Message' => '<string>',
        'Type' => 'SIMPLE|TERMINAL',
    ],
]);

Parameter Details

Members
AliasId
Required: Yes
Type: string

A unique identifier for the alias that you want to update. You can use either the alias ID or ARN value.

Description
Type: string

A human-readable description of the alias.

Name
Type: string

A descriptive label that is associated with an alias. Alias names do not need to be unique.

RoutingStrategy
Type: RoutingStrategy structure

The routing configuration, including routing type and fleet target, for the alias.

Result Syntax

[
    'Alias' => [
        'AliasArn' => '<string>',
        'AliasId' => '<string>',
        'CreationTime' => <DateTime>,
        'Description' => '<string>',
        'LastUpdatedTime' => <DateTime>,
        'Name' => '<string>',
        'RoutingStrategy' => [
            'FleetId' => '<string>',
            'Message' => '<string>',
            'Type' => 'SIMPLE|TERMINAL',
        ],
    ],
]

Result Details

Members
Alias
Type: Alias structure

The updated alias resource.

Errors

UnauthorizedException:

The client failed authentication. Clients should not retry such requests.

InvalidRequestException:

One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

NotFoundException:

THe requested resources was not found. The resource was either not created yet or deleted.

InternalServiceException:

The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

UpdateBuild

$result = $client->updateBuild([/* ... */]);
$promise = $client->updateBuildAsync([/* ... */]);

Updates metadata in a build resource, including the build name and version. To update the metadata, specify the build ID to update and provide the new values. If successful, a build object containing the updated metadata is returned.

Learn more

Upload a Custom Server Build

All APIs by task

Parameter Syntax

$result = $client->updateBuild([
    'BuildId' => '<string>', // REQUIRED
    'Name' => '<string>',
    'Version' => '<string>',
]);

Parameter Details

Members
BuildId
Required: Yes
Type: string

A unique identifier for the build to update. You can use either the build ID or ARN value.

Name
Type: string

A descriptive label associated with a build. Build names don't need to be unique.

Version
Type: string

Version information associated with a build or script. Version strings don't need to be unique.

Result Syntax

[
    'Build' => [
        'BuildArn' => '<string>',
        'BuildId' => '<string>',
        'CreationTime' => <DateTime>,
        'Name' => '<string>',
        'OperatingSystem' => 'WINDOWS_2012|AMAZON_LINUX|AMAZON_LINUX_2|WINDOWS_2016|AMAZON_LINUX_2023',
        'ServerSdkVersion' => '<string>',
        'SizeOnDisk' => <integer>,
        'Status' => 'INITIALIZED|READY|FAILED',
        'Version' => '<string>',
    ],
]

Result Details

Members
Build
Type: Build structure

The updated build resource.

Errors

UnauthorizedException:

The client failed authentication. Clients should not retry such requests.

InvalidRequestException:

One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

NotFoundException:

THe requested resources was not found. The resource was either not created yet or deleted.

InternalServiceException:

The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

UpdateFleetAttributes

$result = $client->updateFleetAttributes([/* ... */]);
$promise = $client->updateFleetAttributesAsync([/* ... */]);

Updates a fleet's mutable attributes, such as game session protection and resource creation limits.

To update fleet attributes, specify the fleet ID and the property values that you want to change. If successful, Amazon GameLift returns the identifiers for the updated fleet.

Learn more

Setting up Amazon GameLift fleets

Parameter Syntax

$result = $client->updateFleetAttributes([
    'AnywhereConfiguration' => [
        'Cost' => '<string>', // REQUIRED
    ],
    'Description' => '<string>',
    'FleetId' => '<string>', // REQUIRED
    'MetricGroups' => ['<string>', ...],
    'Name' => '<string>',
    'NewGameSessionProtectionPolicy' => 'NoProtection|FullProtection',
    'ResourceCreationLimitPolicy' => [
        'NewGameSessionsPerCreator' => <integer>,
        'PolicyPeriodInMinutes' => <integer>,
    ],
]);

Parameter Details

Members
AnywhereConfiguration
Type: AnywhereConfiguration structure

Amazon GameLift Anywhere configuration options.

Description
Type: string

A human-readable description of a fleet.

FleetId
Required: Yes
Type: string

A unique identifier for the fleet to update attribute metadata for. You can use either the fleet ID or ARN value.

MetricGroups
Type: Array of strings

The name of a metric group to add this fleet to. Use a metric group in Amazon CloudWatch to aggregate the metrics from multiple fleets. Provide an existing metric group name, or create a new metric group by providing a new name. A fleet can only be in one metric group at a time.

Name
Type: string

A descriptive label that is associated with a fleet. Fleet names do not need to be unique.

NewGameSessionProtectionPolicy
Type: string

The game session protection policy to apply to all new game sessions created in this fleet. Game sessions that already exist are not affected. You can set protection for individual game sessions using UpdateGameSession .

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

ResourceCreationLimitPolicy
Type: ResourceCreationLimitPolicy structure

Policy settings that limit the number of game sessions an individual player can create over a span of time.

Result Syntax

[
    'FleetArn' => '<string>',
    'FleetId' => '<string>',
]

Result Details

Members
FleetArn
Type: string

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.

FleetId
Type: string

A unique identifier for the fleet that was updated.

Errors

NotFoundException:

THe requested resources was not found. The resource was either not created yet or deleted.

ConflictException:

The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request.

InvalidFleetStatusException:

The requested operation would cause a conflict with the current state of a resource associated with the request and/or the fleet. Resolve the conflict before retrying.

LimitExceededException:

The requested operation would cause the resource to exceed the allowed service limit. Resolve the issue before retrying.

InternalServiceException:

The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

InvalidRequestException:

One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

UnauthorizedException:

The client failed authentication. Clients should not retry such requests.

UpdateFleetCapacity

$result = $client->updateFleetCapacity([/* ... */]);
$promise = $client->updateFleetCapacityAsync([/* ... */]);

This operation has been expanded to use with the Amazon GameLift containers feature, which is currently in public preview.

Updates capacity settings for a managed EC2 fleet or container fleet. For these fleets, you adjust capacity by changing the number of instances in the fleet. Fleet capacity determines the number of game sessions and players that the fleet can host based on its configuration. For fleets with multiple locations, use this operation to manage capacity settings in each location individually.

Use this operation to set these fleet capacity properties:

  • Minimum/maximum size: Set hard limits on the number of Amazon EC2 instances allowed. If Amazon GameLift receives a request--either through manual update or automatic scaling--it won't change the capacity to a value outside of this range.

  • Desired capacity: As an alternative to automatic scaling, manually set the number of Amazon EC2 instances to be maintained. Before changing a fleet's desired capacity, check the maximum capacity of the fleet's Amazon EC2 instance type by calling DescribeEC2InstanceLimits.

To update capacity for a fleet's home Region, or if the fleet has no remote locations, omit the Location parameter. The fleet must be in ACTIVE status.

To update capacity for a fleet's remote location, set the Location parameter to the location to update. The location must be in ACTIVE status.

If successful, Amazon GameLift updates the capacity settings and returns the identifiers for the updated fleet and/or location. If a requested change to desired capacity exceeds the instance type's limit, the LimitExceeded exception occurs.

Updates often prompt an immediate change in fleet capacity, such as when current capacity is different than the new desired capacity or outside the new limits. In this scenario, Amazon GameLift automatically initiates steps to add or remove instances in the fleet location. You can track a fleet's current capacity by calling DescribeFleetCapacity or DescribeFleetLocationCapacity.

Learn more

Scaling fleet capacity

Parameter Syntax

$result = $client->updateFleetCapacity([
    'DesiredInstances' => <integer>,
    'FleetId' => '<string>', // REQUIRED
    'Location' => '<string>',
    'MaxSize' => <integer>,
    'MinSize' => <integer>,
]);

Parameter Details

Members
DesiredInstances
Type: int

The number of Amazon EC2 instances you want to maintain in the specified fleet location. This value must fall between the minimum and maximum size limits. Changes in desired instance value can take up to 1 minute to be reflected when viewing the fleet's capacity settings.

FleetId
Required: Yes
Type: string

A unique identifier for the fleet to update capacity settings for. You can use either the fleet ID or ARN value.

Location
Type: string

The name of a remote location to update fleet capacity settings for, in the form of an Amazon Web Services Region code such as us-west-2.

MaxSize
Type: int

The maximum number of instances that are allowed in the specified fleet location. If this parameter is not set, the default is 1.

MinSize
Type: int

The minimum number of instances that are allowed in the specified fleet location. If this parameter is not set, the default is 0.

Result Syntax

[
    'FleetArn' => '<string>',
    'FleetId' => '<string>',
    'Location' => '<string>',
]

Result Details

Members
FleetArn
Type: string

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.

FleetId
Type: string

A unique identifier for the fleet that was updated.

Location
Type: string

The remote location being updated, expressed as an Amazon Web Services Region code, such as us-west-2.

Errors

NotFoundException:

THe requested resources was not found. The resource was either not created yet or deleted.

ConflictException:

The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request.

LimitExceededException:

The requested operation would cause the resource to exceed the allowed service limit. Resolve the issue before retrying.

InvalidFleetStatusException:

The requested operation would cause a conflict with the current state of a resource associated with the request and/or the fleet. Resolve the conflict before retrying.

InternalServiceException:

The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

InvalidRequestException:

One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

UnauthorizedException:

The client failed authentication. Clients should not retry such requests.

UnsupportedRegionException:

The requested operation is not supported in the Region specified.

UpdateFleetPortSettings

$result = $client->updateFleetPortSettings([/* ... */]);
$promise = $client->updateFleetPortSettingsAsync([/* ... */]);

Updates permissions that allow inbound traffic to connect to game sessions in the fleet.

To update settings, specify the fleet ID to be updated and specify the changes to be made. List the permissions you want to add in InboundPermissionAuthorizations, and permissions you want to remove in InboundPermissionRevocations. Permissions to be removed must match existing fleet permissions.

For a container fleet, inbound permissions must specify port numbers that are defined in the fleet's connection port settings.

If successful, the fleet ID for the updated fleet is returned. For fleets with remote locations, port setting updates can take time to propagate across all locations. You can check the status of updates in each location by calling DescribeFleetPortSettings with a location name.

Learn more

Setting up Amazon GameLift fleets

Parameter Syntax

$result = $client->updateFleetPortSettings([
    'FleetId' => '<string>', // REQUIRED
    'InboundPermissionAuthorizations' => [
        [
            'FromPort' => <integer>, // REQUIRED
            'IpRange' => '<string>', // REQUIRED
            'Protocol' => 'TCP|UDP', // REQUIRED
            'ToPort' => <integer>, // REQUIRED
        ],
        // ...
    ],
    'InboundPermissionRevocations' => [
        [
            'FromPort' => <integer>, // REQUIRED
            'IpRange' => '<string>', // REQUIRED
            'Protocol' => 'TCP|UDP', // REQUIRED
            'ToPort' => <integer>, // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Members
FleetId
Required: Yes
Type: string

A unique identifier for the fleet to update port settings for. You can use either the fleet ID or ARN value.

InboundPermissionAuthorizations
Type: Array of IpPermission structures

A collection of port settings to be added to the fleet resource.

InboundPermissionRevocations
Type: Array of IpPermission structures

A collection of port settings to be removed from the fleet resource.

Result Syntax

[
    'FleetArn' => '<string>',
    'FleetId' => '<string>',
]

Result Details

Members
FleetArn
Type: string

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.

FleetId
Type: string

A unique identifier for the fleet that was updated.

Errors

NotFoundException:

THe requested resources was not found. The resource was either not created yet or deleted.

ConflictException:

The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request.

InvalidFleetStatusException:

The requested operation would cause a conflict with the current state of a resource associated with the request and/or the fleet. Resolve the conflict before retrying.

LimitExceededException:

The requested operation would cause the resource to exceed the allowed service limit. Resolve the issue before retrying.

InternalServiceException:

The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

InvalidRequestException:

One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

UnauthorizedException:

The client failed authentication. Clients should not retry such requests.

UpdateGameServer

$result = $client->updateGameServer([/* ... */]);
$promise = $client->updateGameServerAsync([/* ... */]);

This operation is used with the Amazon GameLift FleetIQ solution and game server groups.

Updates information about a registered game server to help Amazon GameLift FleetIQ track game server availability. This operation is called by a game server process that is running on an instance in a game server group.

Use this operation to update the following types of game server information. You can make all three types of updates in the same request:

  • To update the game server's utilization status from AVAILABLE (when the game server is available to be claimed) to UTILIZED (when the game server is currently hosting games). Identify the game server and game server group and specify the new utilization status. You can't change the status from to UTILIZED to AVAILABLE .

  • To report health status, identify the game server and game server group and set health check to HEALTHY. If a game server does not report health status for a certain length of time, the game server is no longer considered healthy. As a result, it will be eventually deregistered from the game server group to avoid affecting utilization metrics. The best practice is to report health every 60 seconds.

  • To change game server metadata, provide updated game server data.

Once a game server is successfully updated, the relevant statuses and timestamps are updated.

Learn more

Amazon GameLift FleetIQ Guide

Parameter Syntax

$result = $client->updateGameServer([
    'GameServerData' => '<string>',
    'GameServerGroupName' => '<string>', // REQUIRED
    'GameServerId' => '<string>', // REQUIRED
    'HealthCheck' => 'HEALTHY',
    'UtilizationStatus' => 'AVAILABLE|UTILIZED',
]);

Parameter Details

Members
GameServerData
Type: string

A set of custom game server properties, formatted as a single string value. This data is passed to a game client or service when it requests information on game servers.

GameServerGroupName
Required: Yes
Type: string

A unique identifier for the game server group where the game server is running.

GameServerId
Required: Yes
Type: string

A custom string that uniquely identifies the game server to update.

HealthCheck
Type: string

Indicates health status of the game server. A request that includes this parameter updates the game server's LastHealthCheckTime timestamp.

UtilizationStatus
Type: string

Indicates if the game server is available or is currently hosting gameplay. You can update a game server status from AVAILABLE to UTILIZED, but you can't change a the status from UTILIZED to AVAILABLE.

Result Syntax

[
    'GameServer' => [
        'ClaimStatus' => 'CLAIMED',
        'ConnectionInfo' => '<string>',
        'GameServerData' => '<string>',
        'GameServerGroupArn' => '<string>',
        'GameServerGroupName' => '<string>',
        'GameServerId' => '<string>',
        'InstanceId' => '<string>',
        'LastClaimTime' => <DateTime>,
        'LastHealthCheckTime' => <DateTime>,
        'RegistrationTime' => <DateTime>,
        'UtilizationStatus' => 'AVAILABLE|UTILIZED',
    ],
]

Result Details

Members
GameServer
Type: GameServer structure

Object that describes the newly updated game server.

Errors

InvalidRequestException:

One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

NotFoundException:

THe requested resources was not found. The resource was either not created yet or deleted.

UnauthorizedException:

The client failed authentication. Clients should not retry such requests.

InternalServiceException:

The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

UpdateGameServerGroup

$result = $client->updateGameServerGroup([/* ... */]);
$promise = $client->updateGameServerGroupAsync([/* ... */]);

This operation is used with the Amazon GameLift FleetIQ solution and game server groups.

Updates Amazon GameLift FleetIQ-specific properties for a game server group. Many Auto Scaling group properties are updated on the Auto Scaling group directly, including the launch template, Auto Scaling policies, and maximum/minimum/desired instance counts.

To update the game server group, specify the game server group ID and provide the updated values. Before applying the updates, the new values are validated to ensure that Amazon GameLift FleetIQ can continue to perform instance balancing activity. If successful, a GameServerGroup object is returned.

Learn more

Amazon GameLift FleetIQ Guide

Parameter Syntax

$result = $client->updateGameServerGroup([
    'BalancingStrategy' => 'SPOT_ONLY|SPOT_PREFERRED|ON_DEMAND_ONLY',
    'GameServerGroupName' => '<string>', // REQUIRED
    'GameServerProtectionPolicy' => 'NO_PROTECTION|FULL_PROTECTION',
    'InstanceDefinitions' => [
        [
            'InstanceType' => 'c4.large|c4.xlarge|c4.2xlarge|c4.4xlarge|c4.8xlarge|c5.large|c5.xlarge|c5.2xlarge|c5.4xlarge|c5.9xlarge|c5.12xlarge|c5.18xlarge|c5.24xlarge|c5a.large|c5a.xlarge|c5a.2xlarge|c5a.4xlarge|c5a.8xlarge|c5a.12xlarge|c5a.16xlarge|c5a.24xlarge|c6g.medium|c6g.large|c6g.xlarge|c6g.2xlarge|c6g.4xlarge|c6g.8xlarge|c6g.12xlarge|c6g.16xlarge|r4.large|r4.xlarge|r4.2xlarge|r4.4xlarge|r4.8xlarge|r4.16xlarge|r5.large|r5.xlarge|r5.2xlarge|r5.4xlarge|r5.8xlarge|r5.12xlarge|r5.16xlarge|r5.24xlarge|r5a.large|r5a.xlarge|r5a.2xlarge|r5a.4xlarge|r5a.8xlarge|r5a.12xlarge|r5a.16xlarge|r5a.24xlarge|r6g.medium|r6g.large|r6g.xlarge|r6g.2xlarge|r6g.4xlarge|r6g.8xlarge|r6g.12xlarge|r6g.16xlarge|m4.large|m4.xlarge|m4.2xlarge|m4.4xlarge|m4.10xlarge|m5.large|m5.xlarge|m5.2xlarge|m5.4xlarge|m5.8xlarge|m5.12xlarge|m5.16xlarge|m5.24xlarge|m5a.large|m5a.xlarge|m5a.2xlarge|m5a.4xlarge|m5a.8xlarge|m5a.12xlarge|m5a.16xlarge|m5a.24xlarge|m6g.medium|m6g.large|m6g.xlarge|m6g.2xlarge|m6g.4xlarge|m6g.8xlarge|m6g.12xlarge|m6g.16xlarge', // REQUIRED
            'WeightedCapacity' => '<string>',
        ],
        // ...
    ],
    'RoleArn' => '<string>',
]);

Parameter Details

Members
BalancingStrategy
Type: string

Indicates how Amazon GameLift FleetIQ balances the use of Spot Instances and On-Demand Instances in the game server group. Method options include the following:

  • SPOT_ONLY - Only Spot Instances are used in the game server group. If Spot Instances are unavailable or not viable for game hosting, the game server group provides no hosting capacity until Spot Instances can again be used. Until then, no new instances are started, and the existing nonviable Spot Instances are terminated (after current gameplay ends) and are not replaced.

  • SPOT_PREFERRED - (default value) Spot Instances are used whenever available in the game server group. If Spot Instances are unavailable, the game server group continues to provide hosting capacity by falling back to On-Demand Instances. Existing nonviable Spot Instances are terminated (after current gameplay ends) and are replaced with new On-Demand Instances.

  • ON_DEMAND_ONLY - Only On-Demand Instances are used in the game server group. No Spot Instances are used, even when available, while this balancing strategy is in force.

GameServerGroupName
Required: Yes
Type: string

A unique identifier for the game server group. Use either the name or ARN value.

GameServerProtectionPolicy
Type: string

A flag that indicates whether instances in the game server group are protected from early termination. Unprotected instances that have active game servers running might be terminated during a scale-down event, causing players to be dropped from the game. Protected instances cannot be terminated while there are active game servers running except in the event of a forced game server group deletion (see ). An exception to this is with Spot Instances, which can be terminated by Amazon Web Services regardless of protection status. This property is set to NO_PROTECTION by default.

InstanceDefinitions
Type: Array of InstanceDefinition structures

An updated list of Amazon EC2 instance types to use in the Auto Scaling group. The instance definitions must specify at least two different instance types that are supported by Amazon GameLift FleetIQ. This updated list replaces the entire current list of instance definitions for the game server group. For more information on instance types, see EC2 Instance Types in the Amazon EC2 User Guide. You can optionally specify capacity weighting for each instance type. If no weight value is specified for an instance type, it is set to the default value "1". For more information about capacity weighting, see Instance Weighting for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

RoleArn
Type: string

The Amazon Resource Name (ARN) for an IAM role that allows Amazon GameLift to access your Amazon EC2 Auto Scaling groups.

Result Syntax

[
    'GameServerGroup' => [
        'AutoScalingGroupArn' => '<string>',
        'BalancingStrategy' => 'SPOT_ONLY|SPOT_PREFERRED|ON_DEMAND_ONLY',
        'CreationTime' => <DateTime>,
        'GameServerGroupArn' => '<string>',
        'GameServerGroupName' => '<string>',
        'GameServerProtectionPolicy' => 'NO_PROTECTION|FULL_PROTECTION',
        'InstanceDefinitions' => [
            [
                'InstanceType' => 'c4.large|c4.xlarge|c4.2xlarge|c4.4xlarge|c4.8xlarge|c5.large|c5.xlarge|c5.2xlarge|c5.4xlarge|c5.9xlarge|c5.12xlarge|c5.18xlarge|c5.24xlarge|c5a.large|c5a.xlarge|c5a.2xlarge|c5a.4xlarge|c5a.8xlarge|c5a.12xlarge|c5a.16xlarge|c5a.24xlarge|c6g.medium|c6g.large|c6g.xlarge|c6g.2xlarge|c6g.4xlarge|c6g.8xlarge|c6g.12xlarge|c6g.16xlarge|r4.large|r4.xlarge|r4.2xlarge|r4.4xlarge|r4.8xlarge|r4.16xlarge|r5.large|r5.xlarge|r5.2xlarge|r5.4xlarge|r5.8xlarge|r5.12xlarge|r5.16xlarge|r5.24xlarge|r5a.large|r5a.xlarge|r5a.2xlarge|r5a.4xlarge|r5a.8xlarge|r5a.12xlarge|r5a.16xlarge|r5a.24xlarge|r6g.medium|r6g.large|r6g.xlarge|r6g.2xlarge|r6g.4xlarge|r6g.8xlarge|r6g.12xlarge|r6g.16xlarge|m4.large|m4.xlarge|m4.2xlarge|m4.4xlarge|m4.10xlarge|m5.large|m5.xlarge|m5.2xlarge|m5.4xlarge|m5.8xlarge|m5.12xlarge|m5.16xlarge|m5.24xlarge|m5a.large|m5a.xlarge|m5a.2xlarge|m5a.4xlarge|m5a.8xlarge|m5a.12xlarge|m5a.16xlarge|m5a.24xlarge|m6g.medium|m6g.large|m6g.xlarge|m6g.2xlarge|m6g.4xlarge|m6g.8xlarge|m6g.12xlarge|m6g.16xlarge',
                'WeightedCapacity' => '<string>',
            ],
            // ...
        ],
        'LastUpdatedTime' => <DateTime>,
        'RoleArn' => '<string>',
        'Status' => 'NEW|ACTIVATING|ACTIVE|DELETE_SCHEDULED|DELETING|DELETED|ERROR',
        'StatusReason' => '<string>',
        'SuspendedActions' => ['<string>', ...],
    ],
]

Result Details

Members
GameServerGroup
Type: GameServerGroup structure

An object that describes the game server group resource with updated properties.

Errors

InvalidRequestException:

One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

NotFoundException:

THe requested resources was not found. The resource was either not created yet or deleted.

UnauthorizedException:

The client failed authentication. Clients should not retry such requests.

InternalServiceException:

The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

UpdateGameSession

$result = $client->updateGameSession([/* ... */]);
$promise = $client->updateGameSessionAsync([/* ... */]);

Updates the mutable properties of a game session.

To update a game session, specify the game session ID and the values you want to change.

If successful, the updated GameSession object is returned.

All APIs by task

Parameter Syntax

$result = $client->updateGameSession([
    'GameProperties' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'GameSessionId' => '<string>', // REQUIRED
    'MaximumPlayerSessionCount' => <integer>,
    'Name' => '<string>',
    'PlayerSessionCreationPolicy' => 'ACCEPT_ALL|DENY_ALL',
    'ProtectionPolicy' => 'NoProtection|FullProtection',
]);

Parameter Details

Members
GameProperties
Type: Array of GameProperty structures

A set of key-value pairs that can store custom data in a game session. For example: {"Key": "difficulty", "Value": "novice"}. You can use this parameter to modify game properties in an active game session. This action adds new properties and modifies existing properties. There is no way to delete properties. For an example, see Update the value of a game property.

GameSessionId
Required: Yes
Type: string

A unique identifier for the game session to update.

MaximumPlayerSessionCount
Type: int

The maximum number of players that can be connected simultaneously to the game session.

Name
Type: string

A descriptive label that is associated with a game session. Session names do not need to be unique.

PlayerSessionCreationPolicy
Type: string

A policy that determines whether the game session is accepting new players.

ProtectionPolicy
Type: string

Game session protection policy to apply to this game session only.

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

Result Syntax

[
    'GameSession' => [
        'CreationTime' => <DateTime>,
        'CreatorId' => '<string>',
        'CurrentPlayerSessionCount' => <integer>,
        'DnsName' => '<string>',
        'FleetArn' => '<string>',
        'FleetId' => '<string>',
        'GameProperties' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
        'GameSessionData' => '<string>',
        'GameSessionId' => '<string>',
        'IpAddress' => '<string>',
        'Location' => '<string>',
        'MatchmakerData' => '<string>',
        'MaximumPlayerSessionCount' => <integer>,
        'Name' => '<string>',
        'PlayerSessionCreationPolicy' => 'ACCEPT_ALL|DENY_ALL',
        'Port' => <integer>,
        'Status' => 'ACTIVE|ACTIVATING|TERMINATED|TERMINATING|ERROR',
        'StatusReason' => 'INTERRUPTED',
        'TerminationTime' => <DateTime>,
    ],
]

Result Details

Members
GameSession
Type: GameSession structure

The updated game session properties.

Errors

NotFoundException:

THe requested resources was not found. The resource was either not created yet or deleted.

ConflictException:

The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request.

InternalServiceException:

The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

UnauthorizedException:

The client failed authentication. Clients should not retry such requests.

InvalidGameSessionStatusException:

The requested operation would cause a conflict with the current state of a resource associated with the request and/or the game instance. Resolve the conflict before retrying.

InvalidRequestException:

One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

UpdateGameSessionQueue

$result = $client->updateGameSessionQueue([/* ... */]);
$promise = $client->updateGameSessionQueueAsync([/* ... */]);

Updates the configuration of a game session queue, which determines how the queue processes new game session requests. To update settings, specify the queue name to be updated and provide the new settings. When updating destinations, provide a complete list of destinations.

Learn more

Using Multi-Region Queues

Parameter Syntax

$result = $client->updateGameSessionQueue([
    'CustomEventData' => '<string>',
    'Destinations' => [
        [
            'DestinationArn' => '<string>',
        ],
        // ...
    ],
    'FilterConfiguration' => [
        'AllowedLocations' => ['<string>', ...],
    ],
    'Name' => '<string>', // REQUIRED
    'NotificationTarget' => '<string>',
    'PlayerLatencyPolicies' => [
        [
            'MaximumIndividualPlayerLatencyMilliseconds' => <integer>,
            'PolicyDurationSeconds' => <integer>,
        ],
        // ...
    ],
    'PriorityConfiguration' => [
        'LocationOrder' => ['<string>', ...],
        'PriorityOrder' => ['<string>', ...],
    ],
    'TimeoutInSeconds' => <integer>,
]);

Parameter Details

Members
CustomEventData
Type: string

Information to be added to all events that are related to this game session queue.

Destinations
Type: Array of GameSessionQueueDestination structures

A list of fleets and/or fleet aliases that can be used to fulfill game session placement requests in the queue. Destinations are identified by either a fleet ARN or a fleet alias ARN, and are listed in order of placement preference. When updating this list, provide a complete list of destinations.

FilterConfiguration
Type: FilterConfiguration structure

A list of locations where a queue is allowed to place new game sessions. Locations are specified in the form of Amazon Web Services Region codes, such as us-west-2. If this parameter is not set, game sessions can be placed in any queue location. To remove an existing filter configuration, pass in an empty set.

Name
Required: Yes
Type: string

A descriptive label that is associated with game session queue. Queue names must be unique within each Region. You can use either the queue ID or ARN value.

NotificationTarget
Type: string

An SNS topic ARN that is set up to receive game session placement notifications. See Setting up notifications for game session placement.

PlayerLatencyPolicies
Type: Array of PlayerLatencyPolicy structures

A set of policies that act as a sliding cap on player latency. FleetIQ works to deliver low latency for most players in a game session. These policies ensure that no individual player can be placed into a game with unreasonably high latency. Use multiple policies to gradually relax latency requirements a step at a time. Multiple policies are applied based on their maximum allowed latency, starting with the lowest value. When updating policies, provide a complete collection of policies.

PriorityConfiguration
Type: PriorityConfiguration structure

Custom settings to use when prioritizing destinations and locations for game session placements. This configuration replaces the FleetIQ default prioritization process. Priority types that are not explicitly named will be automatically applied at the end of the prioritization process. To remove an existing priority configuration, pass in an empty set.

TimeoutInSeconds
Type: int

The maximum time, in seconds, that a new game session placement request remains in the queue. When a request exceeds this time, the game session placement changes to a TIMED_OUT status. By default, this property is set to 600.

Result Syntax

[
    'GameSessionQueue' => [
        'CustomEventData' => '<string>',
        'Destinations' => [
            [
                'DestinationArn' => '<string>',
            ],
            // ...
        ],
        'FilterConfiguration' => [
            'AllowedLocations' => ['<string>', ...],
        ],
        'GameSessionQueueArn' => '<string>',
        'Name' => '<string>',
        'NotificationTarget' => '<string>',
        'PlayerLatencyPolicies' => [
            [
                'MaximumIndividualPlayerLatencyMilliseconds' => <integer>,
                'PolicyDurationSeconds' => <integer>,
            ],
            // ...
        ],
        'PriorityConfiguration' => [
            'LocationOrder' => ['<string>', ...],
            'PriorityOrder' => ['<string>', ...],
        ],
        'TimeoutInSeconds' => <integer>,
    ],
]

Result Details

Members
GameSessionQueue
Type: GameSessionQueue structure

An object that describes the newly updated game session queue.

Errors

InternalServiceException:

The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

InvalidRequestException:

One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

NotFoundException:

THe requested resources was not found. The resource was either not created yet or deleted.

UnauthorizedException:

The client failed authentication. Clients should not retry such requests.

UpdateMatchmakingConfiguration

$result = $client->updateMatchmakingConfiguration([/* ... */]);
$promise = $client->updateMatchmakingConfigurationAsync([/* ... */]);

Updates settings for a FlexMatch matchmaking configuration. These changes affect all matches and game sessions that are created after the update. To update settings, specify the configuration name to be updated and provide the new settings.

Learn more

Design a FlexMatch matchmaker

Parameter Syntax

$result = $client->updateMatchmakingConfiguration([
    'AcceptanceRequired' => true || false,
    'AcceptanceTimeoutSeconds' => <integer>,
    'AdditionalPlayerCount' => <integer>,
    'BackfillMode' => 'AUTOMATIC|MANUAL',
    'CustomEventData' => '<string>',
    'Description' => '<string>',
    'FlexMatchMode' => 'STANDALONE|WITH_QUEUE',
    'GameProperties' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'GameSessionData' => '<string>',
    'GameSessionQueueArns' => ['<string>', ...],
    'Name' => '<string>', // REQUIRED
    'NotificationTarget' => '<string>',
    'RequestTimeoutSeconds' => <integer>,
    'RuleSetName' => '<string>',
]);

Parameter Details

Members
AcceptanceRequired
Type: boolean

A flag that indicates whether a match that was created with this configuration must be accepted by the matched players. To require acceptance, set to TRUE. With this option enabled, matchmaking tickets use the status REQUIRES_ACCEPTANCE to indicate when a completed potential match is waiting for player acceptance.

AcceptanceTimeoutSeconds
Type: int

The length of time (in seconds) to wait for players to accept a proposed match, if acceptance is required.

AdditionalPlayerCount
Type: int

The number of player slots in a match to keep open for future players. For example, if the configuration's rule set specifies a match for a single 10-person team, and the additional player count is set to 2, 10 players will be selected for the match and 2 more player slots will be open for future players. This parameter is not used if FlexMatchMode is set to STANDALONE.

BackfillMode
Type: string

The method that is used to backfill game sessions created with this matchmaking configuration. Specify MANUAL when your game manages backfill requests manually or does not use the match backfill feature. Specify AUTOMATIC to have GameLift create a match backfill request whenever a game session has one or more open slots. Learn more about manual and automatic backfill in Backfill Existing Games with FlexMatch. Automatic backfill is not available when FlexMatchMode is set to STANDALONE.

CustomEventData
Type: string

Information to add to all events related to the matchmaking configuration.

Description
Type: string

A description for the matchmaking configuration.

FlexMatchMode
Type: string

Indicates whether this matchmaking configuration is being used with Amazon GameLift hosting or as a standalone matchmaking solution.

  • STANDALONE - FlexMatch forms matches and returns match information, including players and team assignments, in a MatchmakingSucceeded event.

  • WITH_QUEUE - FlexMatch forms matches and uses the specified Amazon GameLift queue to start a game session for the match.

GameProperties
Type: Array of GameProperty structures

A set of key-value pairs that can store custom data in a game session. For example: {"Key": "difficulty", "Value": "novice"}. This information is added to the new GameSession object that is created for a successful match. This parameter is not used if FlexMatchMode is set to STANDALONE.

GameSessionData
Type: string

A set of custom game session properties, formatted as a single string value. This data is passed to a game server process with a request to start a new game session (see Start a Game Session). This information is added to the game session that is created for a successful match. This parameter is not used if FlexMatchMode is set to STANDALONE.

GameSessionQueueArns
Type: Array of strings

The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift game session queue resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::gamesessionqueue/<queue name>. Queues can be located in any Region. Queues are used to start new Amazon GameLift-hosted game sessions for matches that are created with this matchmaking configuration. If FlexMatchMode is set to STANDALONE, do not set this parameter.

Name
Required: Yes
Type: string

A unique identifier for the matchmaking configuration to update. You can use either the configuration name or ARN value.

NotificationTarget
Type: string

An SNS topic ARN that is set up to receive matchmaking notifications. See Setting up notifications for matchmaking for more information.

RequestTimeoutSeconds
Type: int

The maximum duration, in seconds, that a matchmaking ticket can remain in process before timing out. Requests that fail due to timing out can be resubmitted as needed.

RuleSetName
Type: string

A unique identifier for the matchmaking rule set to use with this configuration. You can use either the rule set name or ARN value. A matchmaking configuration can only use rule sets that are defined in the same Region.

Result Syntax

[
    'Configuration' => [
        'AcceptanceRequired' => true || false,
        'AcceptanceTimeoutSeconds' => <integer>,
        'AdditionalPlayerCount' => <integer>,
        'BackfillMode' => 'AUTOMATIC|MANUAL',
        'ConfigurationArn' => '<string>',
        'CreationTime' => <DateTime>,
        'CustomEventData' => '<string>',
        'Description' => '<string>',
        'FlexMatchMode' => 'STANDALONE|WITH_QUEUE',
        'GameProperties' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
        'GameSessionData' => '<string>',
        'GameSessionQueueArns' => ['<string>', ...],
        'Name' => '<string>',
        'NotificationTarget' => '<string>',
        'RequestTimeoutSeconds' => <integer>,
        'RuleSetArn' => '<string>',
        'RuleSetName' => '<string>',
    ],
]

Result Details

Members
Configuration
Type: MatchmakingConfiguration structure

The updated matchmaking configuration.

Errors

InvalidRequestException:

One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

NotFoundException:

THe requested resources was not found. The resource was either not created yet or deleted.

InternalServiceException:

The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

UnsupportedRegionException:

The requested operation is not supported in the Region specified.

UpdateRuntimeConfiguration

$result = $client->updateRuntimeConfiguration([/* ... */]);
$promise = $client->updateRuntimeConfigurationAsync([/* ... */]);

Updates the runtime configuration for the specified fleet. The runtime configuration tells Amazon GameLift how to launch server processes on computes in the fleet. For managed EC2 fleets, it determines what server processes to run on each fleet instance. For container fleets, it describes what server processes to run in each replica container group. You can update a fleet's runtime configuration at any time after the fleet is created; it does not need to be in ACTIVE status.

To update runtime configuration, specify the fleet ID and provide a RuntimeConfiguration with an updated set of server process configurations.

If successful, the fleet's runtime configuration settings are updated. Fleet computes that run game server processes regularly check for and receive updated runtime configurations. The computes immediately take action to comply with the new configuration by launching new server processes or by not replacing existing processes when they shut down. Updating a fleet's runtime configuration never affects existing server processes.

Learn more

Setting up Amazon GameLift fleets

Parameter Syntax

$result = $client->updateRuntimeConfiguration([
    'FleetId' => '<string>', // REQUIRED
    'RuntimeConfiguration' => [ // REQUIRED
        'GameSessionActivationTimeoutSeconds' => <integer>,
        'MaxConcurrentGameSessionActivations' => <integer>,
        'ServerProcesses' => [
            [
                'ConcurrentExecutions' => <integer>, // REQUIRED
                'LaunchPath' => '<string>', // REQUIRED
                'Parameters' => '<string>',
            ],
            // ...
        ],
    ],
]);

Parameter Details

Members
FleetId
Required: Yes
Type: string

A unique identifier for the fleet to update runtime configuration for. You can use either the fleet ID or ARN value.

RuntimeConfiguration
Required: Yes
Type: RuntimeConfiguration structure

Instructions for launching server processes on fleet computes. Server processes run either a custom game build executable or a Realtime Servers script. The runtime configuration lists the types of server processes to run, how to launch them, and the number of processes to run concurrently.

Result Syntax

[
    'RuntimeConfiguration' => [
        'GameSessionActivationTimeoutSeconds' => <integer>,
        'MaxConcurrentGameSessionActivations' => <integer>,
        'ServerProcesses' => [
            [
                'ConcurrentExecutions' => <integer>,
                'LaunchPath' => '<string>',
                'Parameters' => '<string>',
            ],
            // ...
        ],
    ],
]

Result Details

Members
RuntimeConfiguration
Type: RuntimeConfiguration structure

The runtime configuration currently in use by computes in the fleet. If the update is successful, all property changes are shown.

Errors

UnauthorizedException:

The client failed authentication. Clients should not retry such requests.

NotFoundException:

THe requested resources was not found. The resource was either not created yet or deleted.

InternalServiceException:

The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

InvalidRequestException:

One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

InvalidFleetStatusException:

The requested operation would cause a conflict with the current state of a resource associated with the request and/or the fleet. Resolve the conflict before retrying.

LimitExceededException:

The requested operation would cause the resource to exceed the allowed service limit. Resolve the issue before retrying.

UpdateScript

$result = $client->updateScript([/* ... */]);
$promise = $client->updateScriptAsync([/* ... */]);

Updates Realtime script metadata and content.

To update script metadata, specify the script ID and provide updated name and/or version values.

To update script content, provide an updated zip file by pointing to either a local file or an Amazon S3 bucket location. You can use either method regardless of how the original script was uploaded. Use the Version parameter to track updates to the script.

If the call is successful, the updated metadata is stored in the script record and a revised script is uploaded to the Amazon GameLift service. Once the script is updated and acquired by a fleet instance, the new version is used for all new game sessions.

Learn more

Amazon GameLift Realtime Servers

Related actions

All APIs by task

Parameter Syntax

$result = $client->updateScript([
    'Name' => '<string>',
    'ScriptId' => '<string>', // REQUIRED
    'StorageLocation' => [
        'Bucket' => '<string>',
        'Key' => '<string>',
        'ObjectVersion' => '<string>',
        'RoleArn' => '<string>',
    ],
    'Version' => '<string>',
    'ZipFile' => <string || resource || Psr\Http\Message\StreamInterface>,
]);

Parameter Details

Members
Name
Type: string

A descriptive label that is associated with a script. Script names don't need to be unique.

ScriptId
Required: Yes
Type: string

A unique identifier for the Realtime script to update. You can use either the script ID or ARN value.

StorageLocation
Type: S3Location structure

The location of the Amazon S3 bucket where a zipped file containing your Realtime scripts is stored. The storage location must specify the Amazon S3 bucket name, the zip file name (the "key"), and a role ARN that allows Amazon GameLift to access the Amazon S3 storage location. The S3 bucket must be in the same Region where you want to create a new script. By default, Amazon GameLift uploads the latest version of the zip file; if you have S3 object versioning turned on, you can use the ObjectVersion parameter to specify an earlier version.

Version
Type: string

Version information associated with a build or script. Version strings don't need to be unique.

ZipFile
Type: blob (string|resource|Psr\Http\Message\StreamInterface)

A data object containing your Realtime scripts and dependencies as a zip file. The zip file can have one or multiple files. Maximum size of a zip file is 5 MB.

When using the Amazon Web Services CLI tool to create a script, this parameter is set to the zip file name. It must be prepended with the string "fileb://" to indicate that the file data is a binary object. For example: --zip-file fileb://myRealtimeScript.zip.

Result Syntax

[
    'Script' => [
        'CreationTime' => <DateTime>,
        'Name' => '<string>',
        'ScriptArn' => '<string>',
        'ScriptId' => '<string>',
        'SizeOnDisk' => <integer>,
        'StorageLocation' => [
            'Bucket' => '<string>',
            'Key' => '<string>',
            'ObjectVersion' => '<string>',
            'RoleArn' => '<string>',
        ],
        'Version' => '<string>',
    ],
]

Result Details

Members
Script
Type: Script structure

The newly created script record with a unique script ID. The new script's storage location reflects an Amazon S3 location: (1) If the script was uploaded from an S3 bucket under your account, the storage location reflects the information that was provided in the CreateScript request; (2) If the script file was uploaded from a local zip file, the storage location reflects an S3 location controls by the Amazon GameLift service.

Errors

UnauthorizedException:

The client failed authentication. Clients should not retry such requests.

InvalidRequestException:

One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

NotFoundException:

THe requested resources was not found. The resource was either not created yet or deleted.

InternalServiceException:

The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

ValidateMatchmakingRuleSet

$result = $client->validateMatchmakingRuleSet([/* ... */]);
$promise = $client->validateMatchmakingRuleSetAsync([/* ... */]);

Validates the syntax of a matchmaking rule or rule set. This operation checks that the rule set is using syntactically correct JSON and that it conforms to allowed property expressions. To validate syntax, provide a rule set JSON string.

Learn more

Parameter Syntax

$result = $client->validateMatchmakingRuleSet([
    'RuleSetBody' => '<string>', // REQUIRED
]);

Parameter Details

Members
RuleSetBody
Required: Yes
Type: string

A collection of matchmaking rules to validate, formatted as a JSON string.

Result Syntax

[
    'Valid' => true || false,
]

Result Details

Members
Valid
Type: boolean

A response indicating whether the rule set is valid.

Errors

InternalServiceException:

The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

UnsupportedRegionException:

The requested operation is not supported in the Region specified.

InvalidRequestException:

One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

Shapes

Alias

Description

Properties that describe an alias resource.

Related actions

All APIs by task

Members
AliasArn
Type: string

The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift alias resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::alias/alias-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912. In a GameLift alias ARN, the resource ID matches the alias ID value.

AliasId
Type: string

A unique identifier for the alias. Alias IDs are unique within a Region.

CreationTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

Description
Type: string

A human-readable description of an alias.

LastUpdatedTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time that this data object was last modified. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

Name
Type: string

A descriptive label that is associated with an alias. Alias names do not need to be unique.

RoutingStrategy
Type: RoutingStrategy structure

The routing configuration, including routing type and fleet target, for the alias.

AnywhereConfiguration

Description

Amazon GameLift configuration options for your Anywhere fleets.

Members
Cost
Required: Yes
Type: string

The cost to run your fleet per hour. Amazon GameLift uses the provided cost of your fleet to balance usage in queues. For more information about queues, see Setting up queues in the Amazon GameLift Developer Guide.

AttributeValue

Description

Values for use in player attribute key-value pairs. This object lets you specify an attribute value using any of the valid data types: string, number, string array, or data map. Each AttributeValue object can use only one of the available properties.

Members
N
Type: double

For number values, expressed as double.

S
Type: string

For single string values. Maximum string length is 100 characters.

SDM
Type: Associative array of custom strings keys (PlayerAttributeString) to doubles

For a map of up to 10 data type:value pairs. Maximum length for each string value is 100 characters.

SL
Type: Array of strings

For a list of up to 100 strings. Maximum length for each string is 100 characters. Duplicate values are not recognized; all occurrences of the repeated value after the first of a repeated value are ignored.

AwsCredentials

Description

Amazon Web Services account security credentials that allow interactions with Amazon GameLift resources. The credentials are temporary and valid for a limited time span. You can request fresh credentials at any time.

Amazon Web Services security credentials consist of three parts: an access key ID, a secret access key, and a session token. You must use all three parts together to authenticate your access requests.

You need Amazon Web Services credentials for the following tasks:

  • To upload a game server build directly to Amazon GameLift S3 storage using CreateBuild. To get access for this task, call RequestUploadCredentials.

  • To remotely connect to an active Amazon GameLift fleet instances. To get remote access, call GetComputeAccess.

Members
AccessKeyId
Type: string

The access key ID that identifies the temporary security credentials.

SecretAccessKey
Type: string

The secret access key that can be used to sign requests.

SessionToken
Type: string

The token that users must pass to the service API to use the temporary credentials.

Build

Description

Properties describing a custom game build.

All APIs by task

Members
BuildArn
Type: string

The Amazon Resource Name (ARN) assigned to a Amazon GameLift build resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::build/build-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912. In a GameLift build ARN, the resource ID matches the BuildId value.

BuildId
Type: string

A unique identifier for the build.

CreationTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

Name
Type: string

A descriptive label associated with a build. Build names don't need to be unique. It can be set using CreateBuild or UpdateBuild.

OperatingSystem
Type: string

Operating system that the game server binaries are built to run on. This value determines the type of fleet resources that you can use for this build.

ServerSdkVersion
Type: string

The Amazon GameLift Server SDK version used to develop your game server.

SizeOnDisk
Type: long (int|float)

File size of the uploaded game build, expressed in bytes. When the build status is INITIALIZED or when using a custom Amazon S3 storage location, this value is 0.

Status
Type: string

Current status of the build.

Possible build statuses include the following:

  • INITIALIZED -- A new build has been defined, but no files have been uploaded. You cannot create fleets for builds that are in this status. When a build is successfully created, the build status is set to this value.

  • READY -- The game build has been successfully uploaded. You can now create new fleets for this build.

  • FAILED -- The game build upload failed. You cannot create new fleets for this build.

Version
Type: string

Version information associated with a build or script. Version strings don't need to be unique.

CertificateConfiguration

Description

This data type has been expanded to use with the Amazon GameLift containers feature, which is currently in public preview.

Determines whether a TLS/SSL certificate is generated for a fleet. This feature must be enabled when creating the fleet. All instances in a fleet share the same certificate. The certificate can be retrieved by calling the Amazon GameLift Server SDK operation GetInstanceCertificate.

Members
CertificateType
Required: Yes
Type: string

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.

ClaimFilterOption

Description

This data type is used with the Amazon GameLift FleetIQ and game server groups.

Filters which game servers may be claimed when calling ClaimGameServer.

Members
InstanceStatuses
Type: Array of strings

List of instance statuses that game servers may be claimed on. If provided, the list must contain the ACTIVE status.

Compute

Description

This data type has been expanded to use with the Amazon GameLift containers feature, which is currently in public preview.

An Amazon GameLift compute resource for hosting your game servers. Computes in an Amazon GameLift fleet differs depending on the fleet's compute type property as follows:

  • For EC2 fleets, a compute is an EC2 instance.

  • For ANYWHERE fleets, a compute is a computing resource that you provide and is registered to the fleet.

  • For CONTAINER fleets, a compute is a container that's registered to the fleet.

Members
ComputeArn
Type: string

The ARN that is assigned to a compute resource and uniquely identifies it. ARNs are unique across locations. Instances in managed EC2 fleets are not assigned a Compute ARN.

ComputeName
Type: string

A descriptive label for the compute resource. For instances in a managed EC2 fleet, the compute name is the same value as the InstanceId ID.

ComputeStatus
Type: string

Current status of the compute. A compute must have an ACTIVE status to host game sessions.

ContainerAttributes
Type: ContainerAttributes structure

Some attributes of a container.

CreationTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

DnsName
Type: string

The DNS name of a compute resource. Amazon GameLift requires a DNS name or IP address for a compute.

FleetArn
Type: string

The Amazon Resource Name (ARN) of the fleet that the compute belongs to.

FleetId
Type: string

A unique identifier for the fleet that the compute belongs to.

GameLiftAgentEndpoint
Type: string

The endpoint of the Amazon GameLift Agent.

GameLiftServiceSdkEndpoint
Type: string

The Amazon GameLift SDK endpoint connection for a registered compute resource in an Anywhere fleet. The game servers on the compute use this endpoint to connect to the Amazon GameLift service.

InstanceId
Type: string

The InstanceID of the Instance hosting the compute for Container and Managed EC2 fleets.

IpAddress
Type: string

The IP address of a compute resource. Amazon GameLift requires a DNS name or IP address for a compute.

Location
Type: string

The name of the custom location you added to the fleet that this compute resource resides in.

OperatingSystem
Type: string

The type of operating system on the compute resource.

Type
Type: string

The Amazon EC2 instance type that the fleet uses. For registered computes in an Amazon GameLift Anywhere fleet, this property is empty.

ConflictException

Description

The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request.

Members
Message
Type: string

ConnectionPortRange

Description

This operation has been expanded to use with the Amazon GameLift containers feature, which is currently in public preview.

The set of port numbers to open on each instance in a container fleet. Connection ports are used by inbound traffic to connect with processes that are running in containers on the fleet.

Part of: ContainerGroupsConfiguration, ContainerGroupsAttributes

Members
FromPort
Required: Yes
Type: int

Starting value for the port range.

ToPort
Required: Yes
Type: int

Ending value for the port. Port numbers are end-inclusive. This value must be equal to or greater than FromPort.

ContainerAttributes

Description

This data type is used with the Amazon GameLift containers feature, which is currently in public preview.

Describes attributes of containers that are deployed to a fleet with compute type CONTAINER.

Members
ContainerPortMappings
Type: Array of ContainerPortMapping structures

Describes how container ports map to connection ports on the fleet instance. Incoming traffic connects to a game via a connection port. A ContainerPortMapping directs the traffic from a connection port to a port on the container that hosts the game session.

ContainerDefinition

Description

This data type is used with the Amazon GameLift containers feature, which is currently in public preview.

Describes a container in a container fleet, the resources available to the container, and the commands that are run when the container starts. Container properties can't be updated. To change a property, create a new container group definition. See also ContainerDefinitionInput.

Part of: ContainerGroupDefinition

Returned by: DescribeContainerGroupDefinition, ListContainerGroupDefinitions

Members
Command
Type: Array of strings

A command that's passed to the container on startup. Each argument for the command is an additional string in the array. See the ContainerDefinition::command parameter in the Amazon Elastic Container Service API reference.

ContainerName
Required: Yes
Type: string

The container definition identifier. Container names are unique within a container group definition.

Cpu
Type: int

The number of CPU units that are reserved for the container. Note: 1 vCPU unit equals 1024 CPU units. If no resources are reserved, the container shares the total CPU limit for the container group.

Related data type: ContainerGroupDefinition$TotalCpuLimit

DependsOn
Type: Array of ContainerDependency structures

Indicates that the container relies on the status of other containers in the same container group during its startup and shutdown sequences. A container might have dependencies on multiple containers.

EntryPoint
Type: Array of strings

The entry point that's passed to the container on startup. If there are multiple arguments, each argument is an additional string in the array. See the ContainerDefinition::entryPoint parameter in the Amazon Elastic Container Service API Reference.

Environment
Type: Array of ContainerEnvironment structures

A set of environment variables that's passed to the container on startup. See the ContainerDefinition::environment parameter in the Amazon Elastic Container Service API Reference.

Essential
Type: boolean

Indicates whether the container is vital to the container group. If an essential container fails, the entire container group is restarted.

HealthCheck
Type: ContainerHealthCheck structure

A configuration for a non-terminal health check. A container, which automatically restarts if it stops functioning, also restarts if it fails this health check. If an essential container in the daemon group fails a health check, the entire container group is restarted. The essential container in the replica group doesn't use this health check mechanism, because the Amazon GameLift Agent automatically handles the task.

ImageUri
Required: Yes
Type: string

The URI to the image that $short; copied and deployed to a container fleet. For a more specific identifier, see ResolvedImageDigest.

MemoryLimits
Type: ContainerMemoryLimits structure

The amount of memory that Amazon GameLift makes available to the container. If memory limits aren't set for an individual container, the container shares the container group's total memory allocation.

Related data type: ContainerGroupDefinition$TotalMemoryLimit

PortConfiguration
Type: ContainerPortConfiguration structure

Defines the ports that are available to assign to processes in the container. For example, a game server process requires a container port to allow game clients to connect to it. Container ports aren't directly accessed by inbound traffic. Amazon GameLift maps these container ports to externally accessible connection ports, which are assigned as needed from the container fleet's ConnectionPortRange.

ResolvedImageDigest
Type: string

A unique and immutable identifier for the container image that is deployed to a container fleet. The digest is a SHA 256 hash of the container image manifest.

WorkingDirectory
Type: string

The directory in the container where commands are run. See the ContainerDefinition::workingDirectory parameter in the Amazon Elastic Container Service API Reference.

ContainerDefinitionInput

Description

This data type is used with the Amazon GameLift containers feature, which is currently in public preview.

Describes a container's configuration, resources, and start instructions. Use this data type to create a container group definition. For the properties of a container that's been deployed to a fleet, see ContainerDefinition. You can't change these properties after you've created the container group definition. If you need a container group with different properties, then you must create a new one.

Used with: CreateContainerGroupDefinition

Members
Command
Type: Array of strings

A command to pass to the container on startup. Add multiple arguments as additional strings in the array. See the ContainerDefinition command parameter in the Amazon Elastic Container Service API reference.

ContainerName
Required: Yes
Type: string

A string that uniquely identifies the container definition within a container group.

Cpu
Type: int

The number of CPU units to reserve for this container. The container can use more resources when needed, if available. Note: 1 vCPU unit equals 1024 CPU units. If you don't reserve CPU units for this container, then it shares the total CPU limit for the container group. This property is similar to the Amazon ECS container definition parameter environment (Amazon Elastic Container Service Developer Guide).

Related data type: ContainerGroupDefinition$TotalCpuLimit

DependsOn
Type: Array of ContainerDependency structures

Sets up dependencies between this container and the status of other containers in the same container group. A container can have dependencies on multiple different containers.

You can use dependencies to establish a startup/shutdown sequence across the container group. A container startup dependency is reversed on shutdown.

For example, you might specify that SideCarContainerB has a START dependency on SideCarContainerA. This dependency means that SideCarContainerB can't start until after SideCarContainerA has started. This dependency is reversed on shutdown, which means that SideCarContainerB must shut down before SideCarContainerA can shut down.

EntryPoint
Type: Array of strings

An entry point to pass to the container on startup. Add multiple arguments as additional strings in the array. See the ContainerDefinition::entryPoint parameter in the Amazon Elastic Container Service API Reference.

Environment
Type: Array of ContainerEnvironment structures

A set of environment variables to pass to the container on startup. See the ContainerDefinition::environment parameter in the Amazon Elastic Container Service API Reference.

Essential
Type: boolean

Specifies whether the container is vital for the container group to function properly. If an essential container fails, it causes the entire container group to restart. Each container group must have an essential container.

Replica container groups - A replica group must have exactly one essential container. Use the following to configure an essential replica container:

  • Choose a container is running your game server and the Amazon GameLift Agent.

  • Include a port configuration. This container runs your game server processes, and each process requires a container port to allow access to game clients.

  • Don't configure a health check. The Agent handles this task for the essential replica container.

Daemon container groups - A daemon group must have at least one essential container.

HealthCheck
Type: ContainerHealthCheck structure

Configuration for a non-terminal health check. A container automatically restarts if it stops functioning. This parameter lets you define additional reasons to consider a container unhealthy and restart it. You can set a health check for any container except for the essential container in the replica container group. If an essential container in the daemon group fails a health check, the entire container group is restarted.

ImageUri
Required: Yes
Type: string

The location of a container image that $short; will copy and deploy to a container fleet. Images in Amazon Elastic Container Registry private repositories are supported. The repository must be in the same Amazon Web Services account and Amazon Web Services Region where you're creating the container group definition. For limits on image size, see Amazon GameLift endpoints and quotas. You can use any of the following image URI formats:

  • Image ID only: [AWS account].dkr.ecr.[AWS region].amazonaws.com/[repository ID]

  • Image ID and digest: [AWS account].dkr.ecr.[AWS region].amazonaws.com/[repository ID]@[digest]

  • Image ID and tag: [AWS account].dkr.ecr.[AWS region].amazonaws.com/[repository ID]:[tag]

MemoryLimits
Type: ContainerMemoryLimits structure

The amount of memory to make available to the container. If you don't specify memory limits for this container, then it shares the container group's total memory allocation.

Related data type: ContainerGroupDefinition$TotalMemoryLimit

PortConfiguration
Type: ContainerPortConfiguration structure

A set of ports that Amazon GameLift can assign to processes in the container. All processes that accept inbound traffic connections, including game server processes, must be assigned a port from this set. The set of ports must be large enough to assign one to each process in the container that needs one. If the container includes your game server, include enough ports to assign one port to each concurrent server process (as defined in a container fleet's RuntimeConfiguration). For more details, see Networking for container fleets.

Container ports aren't directly accessed by inbound traffic. Amazon GameLift maps these container ports to externally accessible connection ports, which are assigned as needed from the container fleet's ConnectionPortRange.

WorkingDirectory
Type: string

The directory in the container where commands are run. See the ContainerDefinition::workingDirectory parameter in the Amazon Elastic Container Service API Reference.

ContainerDependency

Description

This data type is used with the Amazon GameLift containers feature, which is currently in public preview.

A container's dependency on another container in the same container group. The dependency impacts how the dependent container is able to start or shut down based the status of the other container.

For example, ContainerA is configured with the following dependency: a START dependency on ContainerB. This means that ContainerA can't start until ContainerB has started. It also means that ContainerA must shut down before ContainerB.

Part of: ContainerDefinition

Members
Condition
Required: Yes
Type: string

The condition that the dependency container must reach before the dependent container can start. Valid conditions include:

  • START - The dependency container must have started.

  • COMPLETE - The dependency container has run to completion (exits). Use this condition with nonessential containers, such as those that run a script and then exit. The dependency container can't be an essential container.

  • SUCCESS - The dependency container has run to completion and exited with a zero status. The dependency container can't be an essential container.

  • HEALTHY - The dependency container has passed its Docker health check. Use this condition with dependency containers that have health checks configured. This condition is confirmed at container group startup only.

ContainerName
Required: Yes
Type: string

A descriptive label for the container definition that this container depends on.

ContainerEnvironment

Description

This data type is used with the Amazon GameLift containers feature, which is currently in public preview.

An environment variable to set inside a container, in the form of a key-value pair.

Related data type: ContainerDefinition$Environment

Members
Name
Required: Yes
Type: string

The environment variable name.

Value
Required: Yes
Type: string

The environment variable value.

ContainerGroupDefinition

Description

This data type is used with the Amazon GameLift containers feature, which is currently in public preview.

The properties that describe a container group resource. Container group definition properties can't be updated. To change a property, create a new container group definition.

Used with: CreateContainerGroupDefinition

Returned by: DescribeContainerGroupDefinition, ListContainerGroupDefinitions

Members
ContainerDefinitions
Type: Array of ContainerDefinition structures

The set of container definitions that are included in the container group.

ContainerGroupDefinitionArn
Type: string

The Amazon Resource Name (ARN) that is assigned to an Amazon GameLift ContainerGroupDefinition resource. It uniquely identifies the resource across all Amazon Web Services Regions. Format is arn:aws:gamelift:<region>::containergroupdefinition/[container group definition name].

CreationTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

Name
Type: string

A descriptive identifier for the container group definition. The name value is unique in an Amazon Web Services Region.

OperatingSystem
Type: string

The platform required for all containers in the container group definition.

SchedulingStrategy
Type: string

The method for deploying the container group across fleet instances. A replica container group might have multiple copies on each fleet instance. A daemon container group maintains only one copy per fleet instance.

Status
Type: string

Current status of the container group definition resource. Values include:

  • COPYING -- Amazon GameLift is in the process of making copies of all container images that are defined in the group. While in this state, the resource can't be used to create a container fleet.

  • READY -- Amazon GameLift has copied the registry images for all containers that are defined in the group. You can use a container group definition in this status to create a container fleet.

  • FAILED -- Amazon GameLift failed to create a valid container group definition resource. For more details on the cause of the failure, see StatusReason. A container group definition resource in failed status will be deleted within a few minutes.

StatusReason
Type: string

Additional information about a container group definition that's in FAILED status. Possible reasons include:

  • An internal issue prevented Amazon GameLift from creating the container group definition resource. Delete the failed resource and call CreateContainerGroupDefinitionagain.

  • An access-denied message means that you don't have permissions to access the container image on ECR. See IAM permission examples for help setting up required IAM permissions for Amazon GameLift.

  • The ImageUri value for at least one of the containers in the container group definition was invalid or not found in the current Amazon Web Services account.

  • At least one of the container images referenced in the container group definition exceeds the allowed size. For size limits, see Amazon GameLift endpoints and quotas.

  • At least one of the container images referenced in the container group definition uses a different operating system than the one defined for the container group.

TotalCpuLimit
Type: int

The amount of CPU units on a fleet instance to allocate for the container group. All containers in the group share these resources. This property is an integer value in CPU units (1 vCPU is equal to 1024 CPU units).

You can set additional limits for each ContainerDefinition in the group. If individual containers have limits, this value must be equal to or greater than the sum of all container-specific CPU limits in the group.

For more details on memory allocation, see the Container fleet design guide.

TotalMemoryLimit
Type: int

The amount of memory (in MiB) on a fleet instance to allocate for the container group. All containers in the group share these resources.

You can set additional limits for each ContainerDefinition in the group. If individual containers have limits, this value must meet the following requirements:

  • Equal to or greater than the sum of all container-specific soft memory limits in the group.

  • Equal to or greater than any container-specific hard limits in the group.

For more details on memory allocation, see the Container fleet design guide.

ContainerGroupDefinitionProperty

Description

This data type is used with the Amazon GameLift containers feature, which is currently in public preview.

The properties of a container group that is deployed to a container fleet.

Part of: ContainerGroupsAttributes

Returned by: DescribeFleetAttributes

Members
ContainerGroupDefinitionName
Type: string

The unique identifier for the container group definition.

SchedulingStrategy
Type: string

The method for scheduling and maintaining copies of the container group across a container fleet.

ContainerGroupsAttributes

Description

This data type is used with the Amazon GameLift containers feature, which is currently in public preview.

The properties of container groups that are running on a container fleet. Container group properties for a fleet can't be changed.

Returned by: DescribeFleetAttributes, CreateFleet

Members
ConnectionPortRange
Type: ConnectionPortRange structure

A set of ports that allow inbound traffic to connect to processes running in the fleet's container groups. Amazon GameLift maps each connection port to a container port, which is assigned to a specific container process. A fleet's connection port range can't be changed, but you can control access to connection ports by updating a fleet's EC2InboundPermissions with UpdateFleetPortSettings.

ContainerGroupDefinitionProperties
Type: Array of ContainerGroupDefinitionProperty structures

A collection of properties that describe each container group in the fleet. A container fleet is deployed with one or more ContainerGroupDefinition resources, which is where these properties are set.

ContainerGroupsPerInstance
Type: ContainerGroupsPerInstance structure

Details about the number of replica container groups that Amazon GameLift deploys to each instance in the container fleet.

ContainerGroupsConfiguration

Description

This data type is used with the Amazon GameLift containers feature, which is currently in public preview.

Configuration details for a set of container groups, for use when creating a fleet with compute type CONTAINER.

Used with: CreateFleet

Members
ConnectionPortRange
Required: Yes
Type: ConnectionPortRange structure

A set of ports to allow inbound traffic, including game clients, to connect to processes running in the container fleet.

Connection ports are dynamically mapped to container ports, which are assigned to individual processes running in a container. The connection port range must have enough ports to map to all container ports across a fleet instance. To calculate the minimum connection ports needed, use the following formula:

[Total number of container ports as defined for containers in the replica container group] * [Desired or calculated number of replica container groups per instance] + [Total number of container ports as defined for containers in the daemon container group]

As a best practice, double the minimum number of connection ports.

Use the fleet's EC2InboundPermissions property to control external access to connection ports. Set this property to the connection port numbers that you want to open access to. See IpPermission for more details.

ContainerGroupDefinitionNames
Required: Yes
Type: Array of strings

The list of container group definition names to deploy to a new container fleet.

DesiredReplicaContainerGroupsPerInstance
Type: int

The number of times to replicate the replica container group on each instance in a container fleet. By default, Amazon GameLift calculates the maximum number of replica container groups that can fit on a fleet instance (based on CPU and memory resources). Leave this parameter empty if you want to use the maximum number, or specify a desired number to override the maximum. The desired number is used if it's less than the maximum number.

ContainerGroupsPerInstance

Description

This data type is used with the Amazon GameLift containers feature, which is currently in public preview.

Determines how many replica container groups that Amazon GameLift deploys to each instance in a container fleet.

Amazon GameLift calculates the maximum possible replica groups per instance based on the instance 's CPU and memory resources. When deploying a fleet, Amazon GameLift places replica container groups on each fleet instance based on the following:

  • If no desired value is set, Amazon GameLift places the calculated maximum.

  • If a desired number is set to a value higher than the calculated maximum, Amazon GameLift places the calculated maximum.

  • If a desired number is set to a value lower than the calculated maximum, Amazon GameLift places the desired number.

Part of: ContainerGroupsConfiguration, ContainerGroupsAttributes

Returned by: DescribeFleetAttributes, CreateFleet

Members
DesiredReplicaContainerGroupsPerInstance
Type: int

The desired number of replica container groups to place on each fleet instance.

MaxReplicaContainerGroupsPerInstance
Type: int

The maximum possible number of replica container groups that each fleet instance can have.

ContainerHealthCheck

Description

Instructions on when and how to check the health of a container in a container fleet. When health check properties are set in a container definition, they override any Docker health checks in the container image. For more information on container health checks, see HealthCheck command in the Amazon Elastic Container Service API.

The following example instructions tell the container to wait 100 seconds after launch before counting failed health checks, then initiate the health check command every 60 seconds. After issuing the health check command, wait 10 seconds for it to succeed. If it fails, retry the command 3 times before considering the container to be unhealthy.

{"Command": [ "CMD-SHELL", "ps cax | grep "processmanager" || exit 1" ], "Interval": 300, "Timeout": 30, "Retries": 5, "StartPeriod": 100 }

Part of: ContainerDefinition$HealthCheck

Members
Command
Required: Yes
Type: Array of strings

A string array that specifies the command that the container runs to determine if it's healthy.

Interval
Type: int

The time period (in seconds) between each health check.

Retries
Type: int

The number of times to retry a failed health check before the container is considered unhealthy. The first run of the command does not count as a retry.

StartPeriod
Type: int

The optional grace period (in seconds) to give a container time to bootstrap before the first failed health check counts toward the number of retries.

Timeout
Type: int

The time period (in seconds) to wait for a health check to succeed before a failed health check is counted.

ContainerMemoryLimits

Description

Specifies how much memory is available to a container. You can't change this value after you create this object.

Part of: ContainerDefinition$MemoryLimits

Members
HardLimit
Type: int

The maximum amount of memory that the container can use. If a container attempts to exceed this limit, the container is stopped. This property is similar to the Amazon ECS container definition parameter memory in the Amazon Elastic Container Service Developer Guide.

SoftLimit
Type: int

The amount of memory that is reserved for a container. When the container group's shared memory is under contention, the system attempts to maintain the container memory usage at this soft limit. However, the container can use more memory when needed, if available. This property is similar to the Amazon ECS container definition parameter memoryreservation (Amazon Elastic Container Service Developer Guide).

ContainerPortConfiguration

Description

Defines ranges of ports that server processes can connect to.

Part of: ContainerDefinition$PortConfiguration

Members
ContainerPortRanges
Required: Yes
Type: Array of ContainerPortRange structures

Specifies one or more ranges of ports on a container. These ranges must not overlap.

ContainerPortMapping

Description

This data type is used with the Amazon GameLift containers feature, which is currently in public preview.

Defines how an internal-facing container port is mapped to an external-facing connection port on a fleet instance of compute type CONTAINER. Incoming traffic, such as a game client, uses a connection port to connect to a process in the container fleet. Amazon GameLift directs the inbound traffic to the container port that is assigned to the process, such as a game session, running on a container.

Part of: ContainerAttributes

Members
ConnectionPort
Type: int

The port opened on the fleet instance. This is also called the "host port".

ContainerPort
Type: int

The port opened on the container.

Protocol
Type: string

The network protocol that this mapping supports.

ContainerPortRange

Description

This data type is used with the Amazon GameLift containers feature, which is currently in public preview.

A set of one or more port numbers that can be opened on the container.

Part of: ContainerPortConfiguration

Members
FromPort
Required: Yes
Type: int

A starting value for the range of allowed port numbers.

Protocol
Required: Yes
Type: string

The network protocol that these ports support.

ToPort
Required: Yes
Type: int

An ending value for the range of allowed port numbers. Port numbers are end-inclusive. This value must be equal to or greater than FromPort.

DesiredPlayerSession

Description

Player information for use when creating player sessions using a game session placement request.

Members
PlayerData
Type: string

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.

PlayerId
Type: string

A unique identifier for a player to associate with the player session.

EC2InstanceCounts

Description

Resource capacity settings. Fleet capacity is measured in Amazon EC2 instances. Pending and terminating counts are non-zero when the fleet capacity is adjusting to a scaling event or if access to resources is temporarily affected.

Members
ACTIVE
Type: int

Actual number of instances that are ready to host game sessions.

DESIRED
Type: int

Requested number of active instances. Amazon GameLift takes action as needed to maintain the desired number of instances. Capacity is scaled up or down by changing the desired instances. A change in the desired instances value can take up to 1 minute to be reflected when viewing a fleet's capacity settings.

IDLE
Type: int

Number of active instances that are not currently hosting a game session.

MAXIMUM
Type: int

The maximum instance count value allowed.

MINIMUM
Type: int

The minimum instance count value allowed.

PENDING
Type: int

Number of instances that are starting but not yet active.

TERMINATING
Type: int

Number of instances that are no longer active but haven't yet been terminated.

EC2InstanceLimit

Description

The Amazon GameLift service limits for an Amazon EC2 instance type and current utilization. Amazon GameLift allows Amazon Web Services accounts a maximum number of instances, per instance type, per Amazon Web Services Region or location, for use with Amazon GameLift. You can request an limit increase for your account by using the Service limits page in the Amazon GameLift console.

Members
CurrentInstances
Type: int

The number of instances for the specified type and location that are currently being used by the Amazon Web Services account.

EC2InstanceType
Type: string

The name of an Amazon EC2 instance type. See Amazon Elastic Compute Cloud Instance Types for detailed descriptions.

InstanceLimit
Type: int

The number of instances that is allowed for the specified instance type and location.

Location
Type: string

An Amazon Web Services Region code, such as us-west-2.

Event

Description

Log entry describing an event that involves Amazon GameLift resources (such as a fleet). In addition to tracking activity, event codes and messages can provide additional information for troubleshooting and debugging problems.

Members
Count
Type: long (int|float)

The number of times that this event occurred.

EventCode
Type: string

The type of event being logged.

Fleet state transition events:

  • FLEET_CREATED -- A fleet resource was successfully created with a status of NEW. Event messaging includes the fleet ID.

  • FLEET_STATE_DOWNLOADING -- Fleet status changed from NEW to DOWNLOADING. The compressed build has started downloading to a fleet instance for installation.

  • FLEET_STATE_VALIDATING -- Fleet status changed from DOWNLOADING to VALIDATING. Amazon GameLift has successfully downloaded the build and is now validating the build files.

  • FLEET_STATE_BUILDING -- Fleet status changed from VALIDATING to BUILDING. Amazon GameLift has successfully verified the build files and is now running the installation scripts.

  • FLEET_STATE_ACTIVATING -- Fleet status changed from BUILDING to ACTIVATING. Amazon GameLift is trying to launch an instance and test the connectivity between the build and the Amazon GameLift Service via the Server SDK.

  • FLEET_STATE_ACTIVE -- The fleet's status changed from ACTIVATING to ACTIVE. The fleet is now ready to host game sessions.

  • FLEET_STATE_ERROR -- The Fleet's status changed to ERROR. Describe the fleet event message for more details.

Fleet creation events (ordered by fleet creation activity):

  • FLEET_BINARY_DOWNLOAD_FAILED -- The build failed to download to the fleet instance.

  • FLEET_CREATION_EXTRACTING_BUILD -- The game server build was successfully downloaded to an instance, and the build files are now being extracted from the uploaded build and saved to an instance. Failure at this stage prevents a fleet from moving to ACTIVE status. Logs for this stage display a list of the files that are extracted and saved on the instance. Access the logs by using the URL in PreSignedLogUrl.

  • FLEET_CREATION_RUNNING_INSTALLER -- The game server build files were successfully extracted, and the GameLift is now running the build's install script (if one is included). Failure in this stage prevents a fleet from moving to ACTIVE status. Logs for this stage list the installation steps and whether or not the install completed successfully. Access the logs by using the URL in PreSignedLogUrl.

  • FLEET_CREATION_VALIDATING_RUNTIME_CONFIG -- The build process was successful, and the GameLift is now verifying that the game server launch paths, which are specified in the fleet's runtime configuration, exist. If any listed launch path exists, Amazon GameLift tries to launch a game server process and waits for the process to report ready. Failures in this stage prevent a fleet from moving to ACTIVE status. Logs for this stage list the launch paths in the runtime configuration and indicate whether each is found. Access the logs by using the URL in PreSignedLogUrl.

  • FLEET_VALIDATION_LAUNCH_PATH_NOT_FOUND -- Validation of the runtime configuration failed because the executable specified in a launch path does not exist on the instance.

  • FLEET_VALIDATION_EXECUTABLE_RUNTIME_FAILURE -- Validation of the runtime configuration failed because the executable specified in a launch path failed to run on the fleet instance.

  • FLEET_VALIDATION_TIMED_OUT -- Validation of the fleet at the end of creation timed out. Try fleet creation again.

  • FLEET_ACTIVATION_FAILED -- The fleet failed to successfully complete one of the steps in the fleet activation process. This event code indicates that the game build was successfully downloaded to a fleet instance, built, and validated, but was not able to start a server process. For more information, see Debug Fleet Creation Issues.

  • FLEET_ACTIVATION_FAILED_NO_INSTANCES -- Fleet creation was not able to obtain any instances based on the input fleet attributes. Try again at a different time or choose a different combination of fleet attributes such as fleet type, instance type, etc.

  • FLEET_INITIALIZATION_FAILED -- A generic exception occurred during fleet creation. Describe the fleet event message for more details.

VPC peering events:

  • FLEET_VPC_PEERING_SUCCEEDED -- A VPC peering connection has been established between the VPC for an Amazon GameLift fleet and a VPC in your Amazon Web Services account.

  • FLEET_VPC_PEERING_FAILED -- A requested VPC peering connection has failed. Event details and status information provide additional detail. A common reason for peering failure is that the two VPCs have overlapping CIDR blocks of IPv4 addresses. To resolve this, change the CIDR block for the VPC in your Amazon Web Services account. For more information on VPC peering failures, see https://docs.aws.amazon.com/AmazonVPC/latest/PeeringGuide/invalid-peering-configurations.html

  • FLEET_VPC_PEERING_DELETED -- A VPC peering connection has been successfully deleted.

Spot instance events:

  • INSTANCE_INTERRUPTED -- A spot instance was interrupted by EC2 with a two-minute notification.

  • INSTANCE_RECYCLED -- A spot instance was determined to have a high risk of interruption and is scheduled to be recycled once it has no active game sessions.

Server process events:

  • SERVER_PROCESS_INVALID_PATH -- The game server executable or script could not be found based on the Fleet runtime configuration. Check that the launch path is correct based on the operating system of the Fleet.

  • SERVER_PROCESS_SDK_INITIALIZATION_TIMEOUT -- The server process did not call InitSDK() within the time expected (5 minutes). Check your game session log to see why InitSDK() was not called in time.

  • SERVER_PROCESS_PROCESS_READY_TIMEOUT -- The server process did not call ProcessReady() within the time expected (5 minutes) after calling InitSDK(). Check your game session log to see why ProcessReady() was not called in time.

  • SERVER_PROCESS_CRASHED -- The server process exited without calling ProcessEnding(). Check your game session log to see why ProcessEnding() was not called.

  • SERVER_PROCESS_TERMINATED_UNHEALTHY -- The server process did not report a valid health check for too long and was therefore terminated by GameLift. Check your game session log to see if the thread became stuck processing a synchronous task for too long.

  • SERVER_PROCESS_FORCE_TERMINATED -- The server process did not exit cleanly within the time expected after OnProcessTerminate() was sent. Check your game session log to see why termination took longer than expected.

  • SERVER_PROCESS_PROCESS_EXIT_TIMEOUT -- The server process did not exit cleanly within the time expected (30 seconds) after calling ProcessEnding(). Check your game session log to see why termination took longer than expected.

Game session events:

  • GAME_SESSION_ACTIVATION_TIMEOUT -- GameSession failed to activate within the expected time. Check your game session log to see why ActivateGameSession() took longer to complete than expected.

Other fleet events:

  • FLEET_SCALING_EVENT -- A change was made to the fleet's capacity settings (desired instances, minimum/maximum scaling limits). Event messaging includes the new capacity settings.

  • FLEET_NEW_GAME_SESSION_PROTECTION_POLICY_UPDATED -- A change was made to the fleet's game session protection policy setting. Event messaging includes both the old and new policy setting.

  • FLEET_DELETED -- A request to delete a fleet was initiated.

  • GENERIC_EVENT -- An unspecified event has occurred.

EventId
Type: string

A unique identifier for a fleet event.

EventTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

Time stamp indicating when this event occurred. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

Message
Type: string

Additional information related to the event.

PreSignedLogUrl
Type: string

Location of stored logs with additional detail that is related to the event. This is useful for debugging issues. The URL is valid for 15 minutes. You can also access fleet creation logs through the Amazon GameLift console.

ResourceId
Type: string

A unique identifier for an event resource, such as a fleet ID.

FilterConfiguration

Description

A list of fleet locations where a game session queue can place new game sessions. You can use a filter to temporarily turn off placements for specific locations. For queues that have multi-location fleets, you can use a filter configuration allow placement with some, but not all of these locations.

Members
AllowedLocations
Type: Array of strings

A list of locations to allow game session placement in, in the form of Amazon Web Services Region codes such as us-west-2.

FleetAttributes

Description

This operation has been expanded to use with the Amazon GameLift containers feature, which is currently in public preview.

Describes an Amazon GameLift fleet of game hosting resources. Attributes differ based on the fleet's compute type, as follows:

  • EC2 fleet attributes identify a Build resource (for fleets with customer game server builds) or a Script resource (for Realtime Servers fleets).

  • Container fleets have ContainerGroupsAttributes, which identify the fleet's ContainerGroupDefinition resources.

  • Amazon GameLift Anywhere fleets have an abbreviated set of attributes, because most fleet configurations are set directly on the fleet's computes. Attributes include fleet identifiers and descriptive properties, creation/termination time, and fleet status.

Returned by: DescribeFleetAttributes

Members
AnywhereConfiguration
Type: AnywhereConfiguration structure

This property is used with the Amazon GameLift containers feature, which is currently in public preview. A set of attributes that describe the container groups that are deployed on the fleet. These attributes are included for fleets with compute type CONTAINER only. This attribute is used with fleets where ComputeType is "Container".

BuildArn
Type: string

The Amazon Resource Name (ARN) associated with the Amazon GameLift build resource that is deployed on instances in this fleet. In a GameLift build ARN, the resource ID matches the BuildId value. This attribute is used with fleets where ComputeType is "EC2".

BuildId
Type: string

A unique identifier for the build resource that is deployed on instances in this fleet. This attribute is used with fleets where ComputeType is "EC2".

CertificateConfiguration
Type: CertificateConfiguration structure

Determines whether a TLS/SSL certificate is generated for a fleet. This feature must be enabled when creating the fleet. All instances in a fleet share the same certificate.

ComputeType
Type: string

The type of compute resource used to host your game servers. You can use your own compute resources with Amazon GameLift Anywhere or use Amazon EC2 instances with managed Amazon GameLift.

ContainerGroupsAttributes
Type: ContainerGroupsAttributes structure

A set of properties that describe the container groups that are deployed to the fleet. These attributes are included for fleets with compute type CONTAINER.

CreationTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

Description
Type: string

A human-readable description of the fleet.

FleetArn
Type: string

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.

FleetId
Type: string

A unique identifier for the fleet.

FleetType
Type: string

Indicates whether the fleet uses On-Demand or Spot instances. For more information, see On-Demand versus Spot Instances. This fleet property can't be changed after the fleet is created.

InstanceRoleArn
Type: string

A unique identifier for an IAM role with access permissions to other Amazon Web Services services. Any application that runs on an instance in the fleet--including install scripts, server processes, and other processes--can use these permissions to interact with Amazon Web Services resources that you own or have access to. For more information about using the role with your game server builds, see Communicate with other Amazon Web Services resources from your fleets. This attribute is used with fleets where ComputeType is "EC2" or "Container".

InstanceRoleCredentialsProvider
Type: string

Indicates that fleet instances maintain a shared credentials file for the IAM role defined in InstanceRoleArn. Shared credentials allow applications that are deployed with the game server executable to communicate with other Amazon Web Services resources. This property is used only when the game server is integrated with the server SDK version 5.x. For more information about using shared credentials, see Communicate with other Amazon Web Services resources from your fleets. This attribute is used with fleets where ComputeType is "EC2" or "Container".

InstanceType
Type: string

The Amazon EC2 instance type that the fleet uses. Instance type determines the computing resources of each instance in the fleet, including CPU, memory, storage, and networking capacity. See Amazon Elastic Compute Cloud Instance Types for detailed descriptions. This attribute is used with fleets where ComputeType is "EC2" or "Container".

LogPaths
Type: Array of strings

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.

MetricGroups
Type: Array of strings

Name of a metric group that metrics for this fleet are added to. In Amazon CloudWatch, you can view aggregated metrics for fleets that are in a metric group. A fleet can be included in only one metric group at a time. This attribute is used with fleets where ComputeType is "EC2" or "Container".

Name
Type: string

A descriptive label that is associated with a fleet. Fleet names do not need to be unique.

NewGameSessionProtectionPolicy
Type: string

The type of game session protection to set on all new instances that are started in the fleet. This attribute is used with fleets where ComputeType is "EC2" or "Container".

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

OperatingSystem
Type: string

The operating system of the fleet's computing resources. A fleet's operating system is determined by the OS of the build or script that is deployed on this fleet. This attribute is used with fleets where ComputeType is "EC2" or "Container".

ResourceCreationLimitPolicy
Type: ResourceCreationLimitPolicy structure

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.

ScriptArn
Type: string

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.

ScriptId
Type: string

A unique identifier for the Realtime script resource that is deployed on instances in this fleet. This attribute is used with fleets where ComputeType is "EC2".

ServerLaunchParameters
Type: string

This parameter is no longer used. Server launch parameters are now defined using the fleet's runtime configuration . Requests that use this parameter continue to be valid.

ServerLaunchPath
Type: string

This parameter is no longer used. Server launch paths are now defined using the fleet's RuntimeConfiguration . Requests that use this parameter continue to be valid.

Status
Type: string

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.

StoppedActions
Type: Array of strings

A list of fleet activity that has been suspended using StopFleetActions. This includes fleet auto-scaling. This attribute is used with fleets where ComputeType is "EC2" or "Container".

TerminationTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

A time stamp indicating when this data object was terminated. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

FleetCapacity

Description

Current resource capacity settings for managed EC2 fleets and container fleets. For multi-location fleets, location values might refer to a fleet's remote location or its home Region.

Returned by: DescribeFleetCapacity, DescribeFleetLocationCapacity, UpdateFleetCapacity

Members
FleetArn
Type: string

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.

FleetId