public interface AmazonGameLiftAsync extends AmazonGameLift
AsyncHandler can be used to
receive notification when an asynchronous operation completes.
This is the reference guide for the Amazon GameLift service. GameLift is a managed AWS service for developers who need a scalable, server-based solution for multiplayer games. GameLift provides setup and deployment of game servers, and handles infrastructure scaling and session management. For more information about the GameLift service, including a feature overview, getting started guide, and tutorial, see the accompanying GameLift Developer Guide.
This reference describes the low-level service API for GameLift. You can call this API directly or use the AWS SDK for your preferred language. The AWS SDK includes a set of high-level GameLiftactions for. Alternatively, use the AWS command-line interface (CLI) tool, which includes commands for GameLift. For administrative actions, you can use the Amazon GameLift console.
Setting Up Your Game Servers
Use these administrative actions to configure GameLift to host your game servers. When configuring GameLift, you'll need to (1) configure a build for your game and provide build files, and (2) set up one or more fleets to host game sessions.
Managing Game and Player Sessions Through GameLift
Call these actions from your game clients and/or services to create and manage multiplayer game sessions.
createAlias, createBuild, createFleet, createGameSession, createPlayerSession, createPlayerSessions, deleteAlias, deleteBuild, deleteFleet, describeAlias, describeBuild, describeEC2InstanceLimits, describeFleetAttributes, describeFleetCapacity, describeFleetEvents, describeFleetPortSettings, describeFleetUtilization, describeGameSessions, describePlayerSessions, getCachedResponseMetadata, getGameSessionLogUrl, listAliases, listBuilds, listFleets, requestUploadCredentials, resolveAlias, setEndpoint, setRegion, shutdown, updateAlias, updateBuild, updateFleetAttributes, updateFleetCapacity, updateFleetPortSettings, updateGameSessionFuture<CreateAliasResult> createAliasAsync(CreateAliasRequest createAliasRequest)
Creates an alias for a fleet. An alias allows you to anonymize your fleet by referencing an alias instead of a specific fleet when you create game sessions. GameLift supports two types of routing strategies for aliases. Use a simple route to point to an active fleet.
Alternatively, a terminal routing strategy allows you to display a message to incoming traffic instead of routing players to an active fleet. This option is useful when a game server is no longer supported but you want to provide better messaging than a standard 404 error.
To create a fleet alias, specify an alias name and routing strategy. Optionally, add a description. If successful, a new alias record is returned, including an alias ID, which you'll reference when creating a game session. To reassign the alias to another fleet ID, call UpdateAlias.
createAliasRequest - Represents the input for a request action.Future<CreateAliasResult> createAliasAsync(CreateAliasRequest createAliasRequest, AsyncHandler<CreateAliasRequest,CreateAliasResult> asyncHandler)
Creates an alias for a fleet. An alias allows you to anonymize your fleet by referencing an alias instead of a specific fleet when you create game sessions. GameLift supports two types of routing strategies for aliases. Use a simple route to point to an active fleet.
Alternatively, a terminal routing strategy allows you to display a message to incoming traffic instead of routing players to an active fleet. This option is useful when a game server is no longer supported but you want to provide better messaging than a standard 404 error.
To create a fleet alias, specify an alias name and routing strategy. Optionally, add a description. If successful, a new alias record is returned, including an alias ID, which you'll reference when creating a game session. To reassign the alias to another fleet ID, call UpdateAlias.
createAliasRequest - Represents the input for a request action.asyncHandler - Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<CreateBuildResult> createBuildAsync(CreateBuildRequest createBuildRequest)
To create a build, use the CLI command upload-build, which
creates a new build record and uploads the build files in one step. (See
the GameLift Developer Guide for more details on CLI and on the upload
process.) Call this CreateBuild action only if you have your own S3
client and need to manually upload your build files.
Initializes a new build record and generates information required to upload a game build to GameLift. Once the build record has been created and is in an INITIALIZED state, you can upload your game build.
To create a new build, optionally specify a build name and version. This metadata is stored with other properties in the build record and is displayed in the Amazon GameLift console (it is not surfaced to players). If successful, this action returns the newly created build record along with an S3 storage location and AWS account credentials. Use the location and credentials to upload your game build.
createBuildRequest - Represents the input for a request action.Future<CreateBuildResult> createBuildAsync(CreateBuildRequest createBuildRequest, AsyncHandler<CreateBuildRequest,CreateBuildResult> asyncHandler)
To create a build, use the CLI command upload-build, which
creates a new build record and uploads the build files in one step. (See
the GameLift Developer Guide for more details on CLI and on the upload
process.) Call this CreateBuild action only if you have your own S3
client and need to manually upload your build files.
Initializes a new build record and generates information required to upload a game build to GameLift. Once the build record has been created and is in an INITIALIZED state, you can upload your game build.
To create a new build, optionally specify a build name and version. This metadata is stored with other properties in the build record and is displayed in the Amazon GameLift console (it is not surfaced to players). If successful, this action returns the newly created build record along with an S3 storage location and AWS account credentials. Use the location and credentials to upload your game build.
createBuildRequest - Represents the input for a request action.asyncHandler - Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<CreateFleetResult> createFleetAsync(CreateFleetRequest createFleetRequest)
Creates a new fleet to host game servers. A fleet consists of a set of EC2 instances of a certain type, which defines the CPU, memory, storage, networking capacity, etc., of each host in the fleet. See the EC2 documentation for more information on instance types. Each instance in the fleet hosts a game server from the specified game build. Once a fleet is ACTIVE, it can begin hosting game sessions.
To create a new fleet, provide a name and the EC2 instance type for the new fleet, and specify the build and server launch path. Builds must be in a READY state before they can be used to build fleets. When configuring the new fleet, you can optionally (1) provide a set of launch parameters to be passed to a game server when activated; (2) limit incoming traffic to a specified range of IP addresses and port numbers; and (3) configure GameLift to store game session logs by specifying the path to the logs stored in your game server files. If the call is successful, GameLift performs the following tasks:
Once a fleet is created, use the following actions to change certain fleet properties (server launch parameters and log paths cannot be changed):
createFleetRequest - Represents the input for a request action.Future<CreateFleetResult> createFleetAsync(CreateFleetRequest createFleetRequest, AsyncHandler<CreateFleetRequest,CreateFleetResult> asyncHandler)
Creates a new fleet to host game servers. A fleet consists of a set of EC2 instances of a certain type, which defines the CPU, memory, storage, networking capacity, etc., of each host in the fleet. See the EC2 documentation for more information on instance types. Each instance in the fleet hosts a game server from the specified game build. Once a fleet is ACTIVE, it can begin hosting game sessions.
To create a new fleet, provide a name and the EC2 instance type for the new fleet, and specify the build and server launch path. Builds must be in a READY state before they can be used to build fleets. When configuring the new fleet, you can optionally (1) provide a set of launch parameters to be passed to a game server when activated; (2) limit incoming traffic to a specified range of IP addresses and port numbers; and (3) configure GameLift to store game session logs by specifying the path to the logs stored in your game server files. If the call is successful, GameLift performs the following tasks:
Once a fleet is created, use the following actions to change certain fleet properties (server launch parameters and log paths cannot be changed):
createFleetRequest - Represents the input for a request action.asyncHandler - Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<CreateGameSessionResult> createGameSessionAsync(CreateGameSessionRequest createGameSessionRequest)
Creates a multiplayer game session for players. This action creates a game session record and assigns the new session to an instance in the specified fleet, which activates the server initialization process in your game server. A fleet must be in an ACTIVE state before a game session can be created for it.
To create a game session, specify either a fleet ID or an alias ID and indicate the maximum number of players the game session will allow. Optionally, provide a name and a set of properties for your game. If successful, a GameSession object is returned containing session properties, including an IP address. By default, newly created game sessions are set to accept adding any new players to the game session. Use UpdateGameSession to change the creation policy.
createGameSessionRequest - Represents the input for a request action.Future<CreateGameSessionResult> createGameSessionAsync(CreateGameSessionRequest createGameSessionRequest, AsyncHandler<CreateGameSessionRequest,CreateGameSessionResult> asyncHandler)
Creates a multiplayer game session for players. This action creates a game session record and assigns the new session to an instance in the specified fleet, which activates the server initialization process in your game server. A fleet must be in an ACTIVE state before a game session can be created for it.
To create a game session, specify either a fleet ID or an alias ID and indicate the maximum number of players the game session will allow. Optionally, provide a name and a set of properties for your game. If successful, a GameSession object is returned containing session properties, including an IP address. By default, newly created game sessions are set to accept adding any new players to the game session. Use UpdateGameSession to change the creation policy.
createGameSessionRequest - Represents the input for a request action.asyncHandler - Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<CreatePlayerSessionResult> createPlayerSessionAsync(CreatePlayerSessionRequest createPlayerSessionRequest)
Adds a player to a game session and creates a player session record. A game session must be in an ACTIVE state, have a creation policy of ALLOW_ALL, and have an open player slot before players can be added to the session.
To create a player session, specify a game session ID and player ID. If successful, the player is added to the game session and a new PlayerSession object is returned.
createPlayerSessionRequest - Represents the input for a request action.Future<CreatePlayerSessionResult> createPlayerSessionAsync(CreatePlayerSessionRequest createPlayerSessionRequest, AsyncHandler<CreatePlayerSessionRequest,CreatePlayerSessionResult> asyncHandler)
Adds a player to a game session and creates a player session record. A game session must be in an ACTIVE state, have a creation policy of ALLOW_ALL, and have an open player slot before players can be added to the session.
To create a player session, specify a game session ID and player ID. If successful, the player is added to the game session and a new PlayerSession object is returned.
createPlayerSessionRequest - Represents the input for a request action.asyncHandler - Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<CreatePlayerSessionsResult> createPlayerSessionsAsync(CreatePlayerSessionsRequest createPlayerSessionsRequest)
Adds a group of players to a game session. Similar to CreatePlayerSession, this action allows you to add multiple players in a single call, which is useful for games that provide party and/or matchmaking features. A game session must be in an ACTIVE state, have a creation policy of ALLOW_ALL, and have an open player slot before players can be added to the session.
To create player sessions, specify a game session ID and a list of player IDs. If successful, the players are added to the game session and a set of new PlayerSession objects is returned.
createPlayerSessionsRequest - Represents the input for a request action.Future<CreatePlayerSessionsResult> createPlayerSessionsAsync(CreatePlayerSessionsRequest createPlayerSessionsRequest, AsyncHandler<CreatePlayerSessionsRequest,CreatePlayerSessionsResult> asyncHandler)
Adds a group of players to a game session. Similar to CreatePlayerSession, this action allows you to add multiple players in a single call, which is useful for games that provide party and/or matchmaking features. A game session must be in an ACTIVE state, have a creation policy of ALLOW_ALL, and have an open player slot before players can be added to the session.
To create player sessions, specify a game session ID and a list of player IDs. If successful, the players are added to the game session and a set of new PlayerSession objects is returned.
createPlayerSessionsRequest - Represents the input for a request action.asyncHandler - Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<Void> deleteAliasAsync(DeleteAliasRequest deleteAliasRequest)
Deletes an alias. This action removes all record of the alias; game clients attempting to access a game server using the deleted alias will receive an error. To delete an alias, specify the alias ID to be deleted.
deleteAliasRequest - Represents the input for a request action.Future<Void> deleteAliasAsync(DeleteAliasRequest deleteAliasRequest, AsyncHandler<DeleteAliasRequest,Void> asyncHandler)
Deletes an alias. This action removes all record of the alias; game clients attempting to access a game server using the deleted alias will receive an error. To delete an alias, specify the alias ID to be deleted.
deleteAliasRequest - Represents the input for a request action.asyncHandler - Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<Void> deleteBuildAsync(DeleteBuildRequest deleteBuildRequest)
Deletes a build. This action permanently deletes the build record and any uploaded build files.
To delete a build, specify the build's ID. Deleting a build does not affect the status of any active fleets, but you can no longer create new fleets for the deleted build.
deleteBuildRequest - Represents the input for a request action.Future<Void> deleteBuildAsync(DeleteBuildRequest deleteBuildRequest, AsyncHandler<DeleteBuildRequest,Void> asyncHandler)
Deletes a build. This action permanently deletes the build record and any uploaded build files.
To delete a build, specify the build's ID. Deleting a build does not affect the status of any active fleets, but you can no longer create new fleets for the deleted build.
deleteBuildRequest - Represents the input for a request action.asyncHandler - Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<Void> deleteFleetAsync(DeleteFleetRequest deleteFleetRequest)
Deletes everything related to a fleet. Before deleting a fleet, you must set the fleet's desired capacity to zero (UpdateFleetCapacity).
This action deallocates the fleet's resources and the fleet record. Once a fleet is deleted, you will no longer be able to use a fleet.
deleteFleetRequest - Represents the input for a request action.Future<Void> deleteFleetAsync(DeleteFleetRequest deleteFleetRequest, AsyncHandler<DeleteFleetRequest,Void> asyncHandler)
Deletes everything related to a fleet. Before deleting a fleet, you must set the fleet's desired capacity to zero (UpdateFleetCapacity).
This action deallocates the fleet's resources and the fleet record. Once a fleet is deleted, you will no longer be able to use a fleet.
deleteFleetRequest - Represents the input for a request action.asyncHandler - Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribeAliasResult> describeAliasAsync(DescribeAliasRequest describeAliasRequest)
Retrieves properties for a specified alias. To get the alias, specify an alias ID. If successful, an Alias object is returned.
describeAliasRequest - Represents the input for a request action.Future<DescribeAliasResult> describeAliasAsync(DescribeAliasRequest describeAliasRequest, AsyncHandler<DescribeAliasRequest,DescribeAliasResult> asyncHandler)
Retrieves properties for a specified alias. To get the alias, specify an alias ID. If successful, an Alias object is returned.
describeAliasRequest - Represents the input for a request action.asyncHandler - Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribeBuildResult> describeBuildAsync(DescribeBuildRequest describeBuildRequest)
Retrieves properties for a build. To get a build record, specify a build ID. If successful, an object containing the build properties is returned.
describeBuildRequest - Represents the input for a request action.Future<DescribeBuildResult> describeBuildAsync(DescribeBuildRequest describeBuildRequest, AsyncHandler<DescribeBuildRequest,DescribeBuildResult> asyncHandler)
Retrieves properties for a build. To get a build record, specify a build ID. If successful, an object containing the build properties is returned.
describeBuildRequest - Represents the input for a request action.asyncHandler - Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribeEC2InstanceLimitsResult> describeEC2InstanceLimitsAsync(DescribeEC2InstanceLimitsRequest describeEC2InstanceLimitsRequest)
Retrieves the maximum number of instances by EC2 instance type for an AWS account, and includes the current usage level for the account.
describeEC2InstanceLimitsRequest - Represents the input for a request action.Future<DescribeEC2InstanceLimitsResult> describeEC2InstanceLimitsAsync(DescribeEC2InstanceLimitsRequest describeEC2InstanceLimitsRequest, AsyncHandler<DescribeEC2InstanceLimitsRequest,DescribeEC2InstanceLimitsResult> asyncHandler)
Retrieves the maximum number of instances by EC2 instance type for an AWS account, and includes the current usage level for the account.
describeEC2InstanceLimitsRequest - Represents the input for a request action.asyncHandler - Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribeFleetAttributesResult> describeFleetAttributesAsync(DescribeFleetAttributesRequest describeFleetAttributesRequest)
Retrieves fleet properties, including metadata, status, and configuration, for one or more fleets. You can request attributes for all fleets, or specify a list of one or more fleet IDs. If successful, a FleetAttributes object is returned for each requested fleet ID. When requesting all fleets, use the pagination parameters to retrieve results as a set of sequential pages. When specifying a list of fleet IDs, an attribute object will only be returned for fleets that currently exist.
There may be a maximum number of fleet IDs you can specify in one request. If a request exceeds this maximum, the request will fail and the error message will include the maximum allowed.
describeFleetAttributesRequest - Represents the input for a request action.Future<DescribeFleetAttributesResult> describeFleetAttributesAsync(DescribeFleetAttributesRequest describeFleetAttributesRequest, AsyncHandler<DescribeFleetAttributesRequest,DescribeFleetAttributesResult> asyncHandler)
Retrieves fleet properties, including metadata, status, and configuration, for one or more fleets. You can request attributes for all fleets, or specify a list of one or more fleet IDs. If successful, a FleetAttributes object is returned for each requested fleet ID. When requesting all fleets, use the pagination parameters to retrieve results as a set of sequential pages. When specifying a list of fleet IDs, an attribute object will only be returned for fleets that currently exist.
There may be a maximum number of fleet IDs you can specify in one request. If a request exceeds this maximum, the request will fail and the error message will include the maximum allowed.
describeFleetAttributesRequest - Represents the input for a request action.asyncHandler - Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribeFleetCapacityResult> describeFleetCapacityAsync(DescribeFleetCapacityRequest describeFleetCapacityRequest)
Retrieves the current status of fleet capacity for one or more fleets. This information includes the number of instances that have been requested for the fleet and the number currently active. You can request capacity for all fleets, or specify a list of one or more fleet IDs. If successful, an FleetCapacity object is returned for each requested fleet ID. When requesting all fleets, use the pagination parameters to retrieve results as a set of sequential pages. When specifying a list of fleet IDs, an attribute object will only be returned for fleets that currently exist.
There may be a maximum number of fleet IDs you can specify in one request. If a request exceeds this maximum, the request will fail and the error message will include the maximum allowed.
describeFleetCapacityRequest - Represents the input for a request action.Future<DescribeFleetCapacityResult> describeFleetCapacityAsync(DescribeFleetCapacityRequest describeFleetCapacityRequest, AsyncHandler<DescribeFleetCapacityRequest,DescribeFleetCapacityResult> asyncHandler)
Retrieves the current status of fleet capacity for one or more fleets. This information includes the number of instances that have been requested for the fleet and the number currently active. You can request capacity for all fleets, or specify a list of one or more fleet IDs. If successful, an FleetCapacity object is returned for each requested fleet ID. When requesting all fleets, use the pagination parameters to retrieve results as a set of sequential pages. When specifying a list of fleet IDs, an attribute object will only be returned for fleets that currently exist.
There may be a maximum number of fleet IDs you can specify in one request. If a request exceeds this maximum, the request will fail and the error message will include the maximum allowed.
describeFleetCapacityRequest - Represents the input for a request action.asyncHandler - Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribeFleetEventsResult> describeFleetEventsAsync(DescribeFleetEventsRequest describeFleetEventsRequest)
Retrieves entries from the fleet event log. You can specify a time range to limit the result set. This action provides pagination parameters, so you can opt to retrieve results as a set of sequential pages. If successful, a collection of event log entries matching the request are returned.
describeFleetEventsRequest - Represents the input for a request action.Future<DescribeFleetEventsResult> describeFleetEventsAsync(DescribeFleetEventsRequest describeFleetEventsRequest, AsyncHandler<DescribeFleetEventsRequest,DescribeFleetEventsResult> asyncHandler)
Retrieves entries from the fleet event log. You can specify a time range to limit the result set. This action provides pagination parameters, so you can opt to retrieve results as a set of sequential pages. If successful, a collection of event log entries matching the request are returned.
describeFleetEventsRequest - Represents the input for a request action.asyncHandler - Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribeFleetPortSettingsResult> describeFleetPortSettingsAsync(DescribeFleetPortSettingsRequest describeFleetPortSettingsRequest)
Retrieves the port settings for a fleet. Port settings are used to limit incoming traffic access to game servers in the fleet. To get a fleet's port settings, specify a fleet ID. If successful, an IpPermission object is returned for the requested fleet ID. If the requested fleet has been deleted, the result set will be empty.
describeFleetPortSettingsRequest - Represents the input for a request action.Future<DescribeFleetPortSettingsResult> describeFleetPortSettingsAsync(DescribeFleetPortSettingsRequest describeFleetPortSettingsRequest, AsyncHandler<DescribeFleetPortSettingsRequest,DescribeFleetPortSettingsResult> asyncHandler)
Retrieves the port settings for a fleet. Port settings are used to limit incoming traffic access to game servers in the fleet. To get a fleet's port settings, specify a fleet ID. If successful, an IpPermission object is returned for the requested fleet ID. If the requested fleet has been deleted, the result set will be empty.
describeFleetPortSettingsRequest - Represents the input for a request action.asyncHandler - Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribeFleetUtilizationResult> describeFleetUtilizationAsync(DescribeFleetUtilizationRequest describeFleetUtilizationRequest)
Retrieves utilization statistics for one or more fleets. You can request utilization data for all fleets, or specify a list of one or more fleet IDs. If successful, a FleetUtilization object is returned for each requested fleet ID. When requesting all fleets, use the pagination parameters to retrieve results as a set of sequential pages. When specifying a list of fleet IDs, a utilization object will only be returned for fleets that currently exist.
There may be a maximum number of fleet IDs you can specify in one request. If a request exceeds this maximum, the request will fail and the error message will include the maximum allowed.
describeFleetUtilizationRequest - Represents the input for a request action.Future<DescribeFleetUtilizationResult> describeFleetUtilizationAsync(DescribeFleetUtilizationRequest describeFleetUtilizationRequest, AsyncHandler<DescribeFleetUtilizationRequest,DescribeFleetUtilizationResult> asyncHandler)
Retrieves utilization statistics for one or more fleets. You can request utilization data for all fleets, or specify a list of one or more fleet IDs. If successful, a FleetUtilization object is returned for each requested fleet ID. When requesting all fleets, use the pagination parameters to retrieve results as a set of sequential pages. When specifying a list of fleet IDs, a utilization object will only be returned for fleets that currently exist.
There may be a maximum number of fleet IDs you can specify in one request. If a request exceeds this maximum, the request will fail and the error message will include the maximum allowed.
describeFleetUtilizationRequest - Represents the input for a request action.asyncHandler - Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribeGameSessionsResult> describeGameSessionsAsync(DescribeGameSessionsRequest describeGameSessionsRequest)
Retrieves properties for a game session. You can request properties for a single game session or for all sessions currently running on a fleet.
To get a game session record, specify a single game session ID. Alternatively, you can retrieve properties for all game sessions on a fleet by providing either a fleet ID or alias ID. You can optionally filter this request by game session status. This action provides pagination parameters, so you can opt to retrieve results in sequential chunks. If successful, a GameSession object is returned for each session matching the request.
describeGameSessionsRequest - Represents the input for a request action.Future<DescribeGameSessionsResult> describeGameSessionsAsync(DescribeGameSessionsRequest describeGameSessionsRequest, AsyncHandler<DescribeGameSessionsRequest,DescribeGameSessionsResult> asyncHandler)
Retrieves properties for a game session. You can request properties for a single game session or for all sessions currently running on a fleet.
To get a game session record, specify a single game session ID. Alternatively, you can retrieve properties for all game sessions on a fleet by providing either a fleet ID or alias ID. You can optionally filter this request by game session status. This action provides pagination parameters, so you can opt to retrieve results in sequential chunks. If successful, a GameSession object is returned for each session matching the request.
describeGameSessionsRequest - Represents the input for a request action.asyncHandler - Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribePlayerSessionsResult> describePlayerSessionsAsync(DescribePlayerSessionsRequest describePlayerSessionsRequest)
Retrieves properties for one or more player sessions. This action can be used for several purposes: (1) provide a PlayerSessionId to request properties for a specific player session; (2) provide a GameSessionId to request properties for all player sessions in the specified game session; (3) provide a PlayerId to request properties for all player sessions of a specified player.
To get game session record(s), specify only one of the following: a player session ID, a game session ID, or a player ID. You can optionally filter this request by player session status. This action provides pagination parameters, so you can opt to retrieve results as a set of sequential pages. If successful, a PlayerSession object is returned for each session matching the request.
describePlayerSessionsRequest - Represents the input for a request action.Future<DescribePlayerSessionsResult> describePlayerSessionsAsync(DescribePlayerSessionsRequest describePlayerSessionsRequest, AsyncHandler<DescribePlayerSessionsRequest,DescribePlayerSessionsResult> asyncHandler)
Retrieves properties for one or more player sessions. This action can be used for several purposes: (1) provide a PlayerSessionId to request properties for a specific player session; (2) provide a GameSessionId to request properties for all player sessions in the specified game session; (3) provide a PlayerId to request properties for all player sessions of a specified player.
To get game session record(s), specify only one of the following: a player session ID, a game session ID, or a player ID. You can optionally filter this request by player session status. This action provides pagination parameters, so you can opt to retrieve results as a set of sequential pages. If successful, a PlayerSession object is returned for each session matching the request.
describePlayerSessionsRequest - Represents the input for a request action.asyncHandler - Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetGameSessionLogUrlResult> getGameSessionLogUrlAsync(GetGameSessionLogUrlRequest getGameSessionLogUrlRequest)
Retrieves the location of stored game session logs for a specified game session. When a game session is terminated, GameLift automatically stores the logs in S3. Use this URL to download the logs.
See the AWS Service Limits page for maximum log file sizes. Log files that exceed this limit will not be saved.
getGameSessionLogUrlRequest - Represents the input for a request action.Future<GetGameSessionLogUrlResult> getGameSessionLogUrlAsync(GetGameSessionLogUrlRequest getGameSessionLogUrlRequest, AsyncHandler<GetGameSessionLogUrlRequest,GetGameSessionLogUrlResult> asyncHandler)
Retrieves the location of stored game session logs for a specified game session. When a game session is terminated, GameLift automatically stores the logs in S3. Use this URL to download the logs.
See the AWS Service Limits page for maximum log file sizes. Log files that exceed this limit will not be saved.
getGameSessionLogUrlRequest - Represents the input for a request action.asyncHandler - Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListAliasesResult> listAliasesAsync(ListAliasesRequest listAliasesRequest)
Retrieves a collection of alias records for this AWS account. You can opt to filter the result set by alias name and/or routing strategy type. This action provides pagination parameters, so you can opt to retrieve results in sequential chunks.
Aliases are not listed in any particular order.
listAliasesRequest - Represents the input for a request action.Future<ListAliasesResult> listAliasesAsync(ListAliasesRequest listAliasesRequest, AsyncHandler<ListAliasesRequest,ListAliasesResult> asyncHandler)
Retrieves a collection of alias records for this AWS account. You can opt to filter the result set by alias name and/or routing strategy type. This action provides pagination parameters, so you can opt to retrieve results in sequential chunks.
Aliases are not listed in any particular order.
listAliasesRequest - Represents the input for a request action.asyncHandler - Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListBuildsResult> listBuildsAsync(ListBuildsRequest listBuildsRequest)
Retrieves build records all builds associated with an AWS account. You can filter the result set by build status. This action provides pagination parameters, so you can opt to retrieve the results in a set of sequential pages.
Build records are not listed in any particular order.
listBuildsRequest - Represents the input for a request action.Future<ListBuildsResult> listBuildsAsync(ListBuildsRequest listBuildsRequest, AsyncHandler<ListBuildsRequest,ListBuildsResult> asyncHandler)
Retrieves build records all builds associated with an AWS account. You can filter the result set by build status. This action provides pagination parameters, so you can opt to retrieve the results in a set of sequential pages.
Build records are not listed in any particular order.
listBuildsRequest - Represents the input for a request action.asyncHandler - Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListFleetsResult> listFleetsAsync(ListFleetsRequest listFleetsRequest)
Retrieves a collection of fleet records for this AWS account. You can opt to filter the result set by build ID. This action provides pagination parameters, so you can opt to retrieve results in sequential chunks.
Fleet records are not listed in any particular order.
listFleetsRequest - Represents the input for a request action.Future<ListFleetsResult> listFleetsAsync(ListFleetsRequest listFleetsRequest, AsyncHandler<ListFleetsRequest,ListFleetsResult> asyncHandler)
Retrieves a collection of fleet records for this AWS account. You can opt to filter the result set by build ID. This action provides pagination parameters, so you can opt to retrieve results in sequential chunks.
Fleet records are not listed in any particular order.
listFleetsRequest - Represents the input for a request action.asyncHandler - Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<RequestUploadCredentialsResult> requestUploadCredentialsAsync(RequestUploadCredentialsRequest requestUploadCredentialsRequest)
Call this action only if you need credentials for a build created with
CreateBuild. This is a rare situation; in most cases, builds are
created using the CLI command upload-build, which creates a
build record and also uploads build files.
Retrieves a fresh set of upload credentials and the assigned S3 storage location for a specific build. Valid credentials are required to upload your game build files to S3. These credentials are returned when you create the build, but they have a limited lifespan. You can get fresh credentials and use them to re-upload game files as until the build state moves to READY. After this point, you'll need to create a brand new build.
requestUploadCredentialsRequest - Represents the input for a request action.Future<RequestUploadCredentialsResult> requestUploadCredentialsAsync(RequestUploadCredentialsRequest requestUploadCredentialsRequest, AsyncHandler<RequestUploadCredentialsRequest,RequestUploadCredentialsResult> asyncHandler)
Call this action only if you need credentials for a build created with
CreateBuild. This is a rare situation; in most cases, builds are
created using the CLI command upload-build, which creates a
build record and also uploads build files.
Retrieves a fresh set of upload credentials and the assigned S3 storage location for a specific build. Valid credentials are required to upload your game build files to S3. These credentials are returned when you create the build, but they have a limited lifespan. You can get fresh credentials and use them to re-upload game files as until the build state moves to READY. After this point, you'll need to create a brand new build.
requestUploadCredentialsRequest - Represents the input for a request action.asyncHandler - Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ResolveAliasResult> resolveAliasAsync(ResolveAliasRequest resolveAliasRequest)
Retrieves the fleet ID that a specified alias is currently pointing to.
resolveAliasRequest - Represents the input for a request action.Future<ResolveAliasResult> resolveAliasAsync(ResolveAliasRequest resolveAliasRequest, AsyncHandler<ResolveAliasRequest,ResolveAliasResult> asyncHandler)
Retrieves the fleet ID that a specified alias is currently pointing to.
resolveAliasRequest - Represents the input for a request action.asyncHandler - Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UpdateAliasResult> updateAliasAsync(UpdateAliasRequest updateAliasRequest)
Updates properties for an alias. To update properties, specify the alias ID to be updated and provide the information to be changed. To reassign an alias to another fleet, provide an updated routing strategy. If successful, the updated alias record is returned.
updateAliasRequest - Represents the input for a request action.Future<UpdateAliasResult> updateAliasAsync(UpdateAliasRequest updateAliasRequest, AsyncHandler<UpdateAliasRequest,UpdateAliasResult> asyncHandler)
Updates properties for an alias. To update properties, specify the alias ID to be updated and provide the information to be changed. To reassign an alias to another fleet, provide an updated routing strategy. If successful, the updated alias record is returned.
updateAliasRequest - Represents the input for a request action.asyncHandler - Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UpdateBuildResult> updateBuildAsync(UpdateBuildRequest updateBuildRequest)
Updates metadata in a build record, 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.
updateBuildRequest - Represents the input for a request action.Future<UpdateBuildResult> updateBuildAsync(UpdateBuildRequest updateBuildRequest, AsyncHandler<UpdateBuildRequest,UpdateBuildResult> asyncHandler)
Updates metadata in a build record, 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.
updateBuildRequest - Represents the input for a request action.asyncHandler - Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UpdateFleetAttributesResult> updateFleetAttributesAsync(UpdateFleetAttributesRequest updateFleetAttributesRequest)
Updates fleet properties, including name and description, for a fleet. To update metadata, specify the fleet ID and the property values you want to change. If successful, the fleet ID for the updated fleet is returned.
updateFleetAttributesRequest - Represents the input for a request action.Future<UpdateFleetAttributesResult> updateFleetAttributesAsync(UpdateFleetAttributesRequest updateFleetAttributesRequest, AsyncHandler<UpdateFleetAttributesRequest,UpdateFleetAttributesResult> asyncHandler)
Updates fleet properties, including name and description, for a fleet. To update metadata, specify the fleet ID and the property values you want to change. If successful, the fleet ID for the updated fleet is returned.
updateFleetAttributesRequest - Represents the input for a request action.asyncHandler - Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UpdateFleetCapacityResult> updateFleetCapacityAsync(UpdateFleetCapacityRequest updateFleetCapacityRequest)
Updates capacity settings for a fleet. Use this action to specify the number of EC2 instances (hosts) you want this fleet to contain. Before calling this action, you may want to call DescribeEC2InstanceLimits to get the maximum capacity based on the fleet's EC2 instance type.
To update fleet capacity, specify the fleet ID and the desired number of instances. If successful, GameLift will spin up or terminate instances so that the fleet's active instance count matches the desired instance count. You can view a fleet's current capacity information by calling DescribeFleetCapacity. If the desired instance count is higher than the instance type's limit, the call will throw "Limit Exceeded" exception.
updateFleetCapacityRequest - Represents the input for a request action.Future<UpdateFleetCapacityResult> updateFleetCapacityAsync(UpdateFleetCapacityRequest updateFleetCapacityRequest, AsyncHandler<UpdateFleetCapacityRequest,UpdateFleetCapacityResult> asyncHandler)
Updates capacity settings for a fleet. Use this action to specify the number of EC2 instances (hosts) you want this fleet to contain. Before calling this action, you may want to call DescribeEC2InstanceLimits to get the maximum capacity based on the fleet's EC2 instance type.
To update fleet capacity, specify the fleet ID and the desired number of instances. If successful, GameLift will spin up or terminate instances so that the fleet's active instance count matches the desired instance count. You can view a fleet's current capacity information by calling DescribeFleetCapacity. If the desired instance count is higher than the instance type's limit, the call will throw "Limit Exceeded" exception.
updateFleetCapacityRequest - Represents the input for a request action.asyncHandler - Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UpdateFleetPortSettingsResult> updateFleetPortSettingsAsync(UpdateFleetPortSettingsRequest updateFleetPortSettingsRequest)
Updates port settings for a fleet. To update settings, specify the fleet ID to be updated and list the permissions you want to update. 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. If successful, the fleet ID for the updated fleet is returned.
updateFleetPortSettingsRequest - Represents the input for a request action.Future<UpdateFleetPortSettingsResult> updateFleetPortSettingsAsync(UpdateFleetPortSettingsRequest updateFleetPortSettingsRequest, AsyncHandler<UpdateFleetPortSettingsRequest,UpdateFleetPortSettingsResult> asyncHandler)
Updates port settings for a fleet. To update settings, specify the fleet ID to be updated and list the permissions you want to update. 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. If successful, the fleet ID for the updated fleet is returned.
updateFleetPortSettingsRequest - Represents the input for a request action.asyncHandler - Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UpdateGameSessionResult> updateGameSessionAsync(UpdateGameSessionRequest updateGameSessionRequest)
Updates game session properties. This includes the session name, maximum player count and the player session creation policy, which either allows or denies new players from joining the session. To update a game session, specify the game session ID and the values you want to change. If successful, an updated GameSession object is returned.
updateGameSessionRequest - Represents the input for a request action.Future<UpdateGameSessionResult> updateGameSessionAsync(UpdateGameSessionRequest updateGameSessionRequest, AsyncHandler<UpdateGameSessionRequest,UpdateGameSessionResult> asyncHandler)
Updates game session properties. This includes the session name, maximum player count and the player session creation policy, which either allows or denies new players from joining the session. To update a game session, specify the game session ID and the values you want to change. If successful, an updated GameSession object is returned.
updateGameSessionRequest - Represents the input for a request action.asyncHandler - Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.