public class AbstractAmazonGameLiftAsync extends AbstractAmazonGameLift implements AmazonGameLiftAsync
AmazonGameLiftAsync
. Convenient method forms pass through to the corresponding
overload that takes a request object and an AsyncHandler
, which throws an
UnsupportedOperationException
.ENDPOINT_PREFIX
createAlias, createBuild, createFleet, createGameSession, createPlayerSession, createPlayerSessions, deleteAlias, deleteBuild, deleteFleet, deleteScalingPolicy, describeAlias, describeBuild, describeEC2InstanceLimits, describeFleetAttributes, describeFleetCapacity, describeFleetEvents, describeFleetPortSettings, describeFleetUtilization, describeGameSessionDetails, describeGameSessions, describeInstances, describePlayerSessions, describeRuntimeConfiguration, describeScalingPolicies, getCachedResponseMetadata, getGameSessionLogUrl, listAliases, listBuilds, listFleets, putScalingPolicy, requestUploadCredentials, resolveAlias, searchGameSessions, setEndpoint, setRegion, shutdown, updateAlias, updateBuild, updateFleetAttributes, updateFleetCapacity, updateFleetPortSettings, updateGameSession, updateRuntimeConfiguration
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
createAlias, createBuild, createFleet, createGameSession, createPlayerSession, createPlayerSessions, deleteAlias, deleteBuild, deleteFleet, deleteScalingPolicy, describeAlias, describeBuild, describeEC2InstanceLimits, describeFleetAttributes, describeFleetCapacity, describeFleetEvents, describeFleetPortSettings, describeFleetUtilization, describeGameSessionDetails, describeGameSessions, describeInstances, describePlayerSessions, describeRuntimeConfiguration, describeScalingPolicies, getCachedResponseMetadata, getGameSessionLogUrl, listAliases, listBuilds, listFleets, putScalingPolicy, requestUploadCredentials, resolveAlias, searchGameSessions, setEndpoint, setRegion, shutdown, updateAlias, updateBuild, updateFleetAttributes, updateFleetCapacity, updateFleetPortSettings, updateGameSession, updateRuntimeConfiguration
public Future<CreateAliasResult> createAliasAsync(CreateAliasRequest request)
AmazonGameLiftAsync
Creates an alias for a fleet. You can use an alias to anonymize your fleet by referencing an alias instead of a specific fleet when you create game sessions. Amazon GameLift supports two types of routing strategies for aliases: simple and terminal. Use a simple alias to point to an active fleet. Use a terminal alias 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, routing strategy, and optional description. If successful, a new alias record is returned, including an alias ID, which you can reference when creating a game session. To reassign the alias to another fleet ID, call UpdateAlias.
createAliasAsync
in interface AmazonGameLiftAsync
request
- Represents the input for a request action.public Future<CreateAliasResult> createAliasAsync(CreateAliasRequest request, AsyncHandler<CreateAliasRequest,CreateAliasResult> asyncHandler)
AmazonGameLiftAsync
Creates an alias for a fleet. You can use an alias to anonymize your fleet by referencing an alias instead of a specific fleet when you create game sessions. Amazon GameLift supports two types of routing strategies for aliases: simple and terminal. Use a simple alias to point to an active fleet. Use a terminal alias 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, routing strategy, and optional description. If successful, a new alias record is returned, including an alias ID, which you can reference when creating a game session. To reassign the alias to another fleet ID, call UpdateAlias.
createAliasAsync
in interface AmazonGameLiftAsync
request
- 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.public Future<CreateBuildResult> createBuildAsync(CreateBuildRequest request)
AmazonGameLiftAsync
Initializes a new build record and generates information required to upload a game build to Amazon GameLift. Once
the build record has been created and its status is INITIALIZED
, you can upload your game build.
Do not use this API action unless you are using your own Amazon Simple Storage Service (Amazon S3) client and
need to manually upload your build files. Instead, 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 Amazon GameLift
Developer Guide help on packaging and uploading your build.)
To create a new build, identify the operating system of the game server binaries. All game servers in a build must use the same operating system. Optionally, specify a build name and version; this metadata is stored with other properties in the build record and is displayed in the GameLift console (it is not visible to players). If successful, this action returns the newly created build record along with the Amazon S3 storage location and AWS account credentials. Use the location and credentials to upload your game build.
createBuildAsync
in interface AmazonGameLiftAsync
request
- Represents the input for a request action.public Future<CreateBuildResult> createBuildAsync(CreateBuildRequest request, AsyncHandler<CreateBuildRequest,CreateBuildResult> asyncHandler)
AmazonGameLiftAsync
Initializes a new build record and generates information required to upload a game build to Amazon GameLift. Once
the build record has been created and its status is INITIALIZED
, you can upload your game build.
Do not use this API action unless you are using your own Amazon Simple Storage Service (Amazon S3) client and
need to manually upload your build files. Instead, 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 Amazon GameLift
Developer Guide help on packaging and uploading your build.)
To create a new build, identify the operating system of the game server binaries. All game servers in a build must use the same operating system. Optionally, specify a build name and version; this metadata is stored with other properties in the build record and is displayed in the GameLift console (it is not visible to players). If successful, this action returns the newly created build record along with the Amazon S3 storage location and AWS account credentials. Use the location and credentials to upload your game build.
createBuildAsync
in interface AmazonGameLiftAsync
request
- 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.public Future<CreateFleetResult> createFleetAsync(CreateFleetRequest request)
AmazonGameLiftAsync
Creates a new fleet to run your game servers. A fleet is a set of Amazon Elastic Compute Cloud (Amazon EC2)
instances, each of which can run multiple server processes to host game sessions. You configure a fleet to create
instances with certain hardware specifications (see Amazon
EC2 Instance Types for more information), and deploy a specified game build to each instance. A newly created
fleet passes through several statuses; once it reaches the ACTIVE
status, it can begin hosting game
sessions.
To create a new fleet, provide a fleet name, an EC2 instance type, and a build ID of the game build to deploy. You can also configure the new fleet with the following settings: (1) a runtime configuration describing what server processes to run on each instance in the fleet (required to create fleet), (2) access permissions for inbound traffic, (3) fleet-wide game session protection, and (4) the location of default log files for GameLift to upload and store.
If the CreateFleet
call is successful, Amazon GameLift performs the following tasks:
Creates a fleet record and sets the status to NEW
(followed by other statuses as the fleet is
activated).
Sets the fleet's capacity to 1 "desired", which causes GameLift to start one new EC2 instance.
Starts launching server processes on the instance. If the fleet is configured to run multiple server processes per instance, GameLift staggers each launch by a few seconds.
Begins writing events to the fleet event log, which can be accessed in the GameLift console.
Sets the fleet's status to ACTIVE
once one server process in the fleet is ready to host a game
session.
After a fleet is created, use the following actions to change fleet properties and configuration:
UpdateFleetAttributes -- Update fleet metadata, including name and description.
UpdateFleetCapacity -- Increase or decrease the number of instances you want the fleet to maintain.
UpdateFleetPortSettings -- Change the IP address and port ranges that allow access to incoming traffic.
UpdateRuntimeConfiguration -- Change how server processes are launched in the fleet, including launch path, launch parameters, and the number of concurrent processes.
createFleetAsync
in interface AmazonGameLiftAsync
request
- Represents the input for a request action.public Future<CreateFleetResult> createFleetAsync(CreateFleetRequest request, AsyncHandler<CreateFleetRequest,CreateFleetResult> asyncHandler)
AmazonGameLiftAsync
Creates a new fleet to run your game servers. A fleet is a set of Amazon Elastic Compute Cloud (Amazon EC2)
instances, each of which can run multiple server processes to host game sessions. You configure a fleet to create
instances with certain hardware specifications (see Amazon
EC2 Instance Types for more information), and deploy a specified game build to each instance. A newly created
fleet passes through several statuses; once it reaches the ACTIVE
status, it can begin hosting game
sessions.
To create a new fleet, provide a fleet name, an EC2 instance type, and a build ID of the game build to deploy. You can also configure the new fleet with the following settings: (1) a runtime configuration describing what server processes to run on each instance in the fleet (required to create fleet), (2) access permissions for inbound traffic, (3) fleet-wide game session protection, and (4) the location of default log files for GameLift to upload and store.
If the CreateFleet
call is successful, Amazon GameLift performs the following tasks:
Creates a fleet record and sets the status to NEW
(followed by other statuses as the fleet is
activated).
Sets the fleet's capacity to 1 "desired", which causes GameLift to start one new EC2 instance.
Starts launching server processes on the instance. If the fleet is configured to run multiple server processes per instance, GameLift staggers each launch by a few seconds.
Begins writing events to the fleet event log, which can be accessed in the GameLift console.
Sets the fleet's status to ACTIVE
once one server process in the fleet is ready to host a game
session.
After a fleet is created, use the following actions to change fleet properties and configuration:
UpdateFleetAttributes -- Update fleet metadata, including name and description.
UpdateFleetCapacity -- Increase or decrease the number of instances you want the fleet to maintain.
UpdateFleetPortSettings -- Change the IP address and port ranges that allow access to incoming traffic.
UpdateRuntimeConfiguration -- Change how server processes are launched in the fleet, including launch path, launch parameters, and the number of concurrent processes.
createFleetAsync
in interface AmazonGameLiftAsync
request
- 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.public Future<CreateGameSessionResult> createGameSessionAsync(CreateGameSessionRequest request)
AmazonGameLiftAsync
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 initializes a new server process to host the game session. A
fleet must be in an ACTIVE
status before a game session can be created in 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 allows. You can also provide a name and a set of properties for your game (optional). 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.
createGameSessionAsync
in interface AmazonGameLiftAsync
request
- Represents the input for a request action.public Future<CreateGameSessionResult> createGameSessionAsync(CreateGameSessionRequest request, AsyncHandler<CreateGameSessionRequest,CreateGameSessionResult> asyncHandler)
AmazonGameLiftAsync
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 initializes a new server process to host the game session. A
fleet must be in an ACTIVE
status before a game session can be created in 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 allows. You can also provide a name and a set of properties for your game (optional). 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.
createGameSessionAsync
in interface AmazonGameLiftAsync
request
- 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.public Future<CreatePlayerSessionResult> createPlayerSessionAsync(CreatePlayerSessionRequest request)
AmazonGameLiftAsync
Adds a player to a game session and creates a player session record. A game session must be in an
ACTIVE
status, 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.
createPlayerSessionAsync
in interface AmazonGameLiftAsync
request
- Represents the input for a request action.public Future<CreatePlayerSessionResult> createPlayerSessionAsync(CreatePlayerSessionRequest request, AsyncHandler<CreatePlayerSessionRequest,CreatePlayerSessionResult> asyncHandler)
AmazonGameLiftAsync
Adds a player to a game session and creates a player session record. A game session must be in an
ACTIVE
status, 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.
createPlayerSessionAsync
in interface AmazonGameLiftAsync
request
- 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.public Future<CreatePlayerSessionsResult> createPlayerSessionsAsync(CreatePlayerSessionsRequest request)
AmazonGameLiftAsync
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
status, 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.
createPlayerSessionsAsync
in interface AmazonGameLiftAsync
request
- Represents the input for a request action.public Future<CreatePlayerSessionsResult> createPlayerSessionsAsync(CreatePlayerSessionsRequest request, AsyncHandler<CreatePlayerSessionsRequest,CreatePlayerSessionsResult> asyncHandler)
AmazonGameLiftAsync
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
status, 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.
createPlayerSessionsAsync
in interface AmazonGameLiftAsync
request
- 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.public Future<DeleteAliasResult> deleteAliasAsync(DeleteAliasRequest request)
AmazonGameLiftAsync
Deletes an alias. This action 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.
deleteAliasAsync
in interface AmazonGameLiftAsync
request
- Represents the input for a request action.public Future<DeleteAliasResult> deleteAliasAsync(DeleteAliasRequest request, AsyncHandler<DeleteAliasRequest,DeleteAliasResult> asyncHandler)
AmazonGameLiftAsync
Deletes an alias. This action 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.
deleteAliasAsync
in interface AmazonGameLiftAsync
request
- 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.public Future<DeleteBuildResult> deleteBuildAsync(DeleteBuildRequest request)
AmazonGameLiftAsync
Deletes a build. This action permanently deletes the build record and any uploaded build files.
To delete a build, specify its ID. 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.
deleteBuildAsync
in interface AmazonGameLiftAsync
request
- Represents the input for a request action.public Future<DeleteBuildResult> deleteBuildAsync(DeleteBuildRequest request, AsyncHandler<DeleteBuildRequest,DeleteBuildResult> asyncHandler)
AmazonGameLiftAsync
Deletes a build. This action permanently deletes the build record and any uploaded build files.
To delete a build, specify its ID. 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.
deleteBuildAsync
in interface AmazonGameLiftAsync
request
- 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.public Future<DeleteFleetResult> deleteFleetAsync(DeleteFleetRequest request)
AmazonGameLiftAsync
Deletes everything related to a fleet. Before deleting a fleet, you must set the fleet's desired capacity to zero. See UpdateFleetCapacity.
This action removes the fleet's resources and the fleet record. Once a fleet is deleted, you can no longer use that fleet.
deleteFleetAsync
in interface AmazonGameLiftAsync
request
- Represents the input for a request action.public Future<DeleteFleetResult> deleteFleetAsync(DeleteFleetRequest request, AsyncHandler<DeleteFleetRequest,DeleteFleetResult> asyncHandler)
AmazonGameLiftAsync
Deletes everything related to a fleet. Before deleting a fleet, you must set the fleet's desired capacity to zero. See UpdateFleetCapacity.
This action removes the fleet's resources and the fleet record. Once a fleet is deleted, you can no longer use that fleet.
deleteFleetAsync
in interface AmazonGameLiftAsync
request
- 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.public Future<DeleteScalingPolicyResult> deleteScalingPolicyAsync(DeleteScalingPolicyRequest request)
AmazonGameLiftAsync
Deletes a fleet scaling policy. This action means that the policy is no longer in force and removes all record of it. To delete a scaling policy, specify both the scaling policy name and the fleet ID it is associated with.
deleteScalingPolicyAsync
in interface AmazonGameLiftAsync
request
- Represents the input for a request action.public Future<DeleteScalingPolicyResult> deleteScalingPolicyAsync(DeleteScalingPolicyRequest request, AsyncHandler<DeleteScalingPolicyRequest,DeleteScalingPolicyResult> asyncHandler)
AmazonGameLiftAsync
Deletes a fleet scaling policy. This action means that the policy is no longer in force and removes all record of it. To delete a scaling policy, specify both the scaling policy name and the fleet ID it is associated with.
deleteScalingPolicyAsync
in interface AmazonGameLiftAsync
request
- 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.public Future<DescribeAliasResult> describeAliasAsync(DescribeAliasRequest request)
AmazonGameLiftAsync
Retrieves properties for a specified alias. To get the alias, specify an alias ID. If successful, an Alias object is returned.
describeAliasAsync
in interface AmazonGameLiftAsync
request
- Represents the input for a request action.public Future<DescribeAliasResult> describeAliasAsync(DescribeAliasRequest request, AsyncHandler<DescribeAliasRequest,DescribeAliasResult> asyncHandler)
AmazonGameLiftAsync
Retrieves properties for a specified alias. To get the alias, specify an alias ID. If successful, an Alias object is returned.
describeAliasAsync
in interface AmazonGameLiftAsync
request
- 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.public Future<DescribeBuildResult> describeBuildAsync(DescribeBuildRequest request)
AmazonGameLiftAsync
Retrieves properties for a build. To get a build record, specify a build ID. If successful, an object containing the build properties is returned.
describeBuildAsync
in interface AmazonGameLiftAsync
request
- Represents the input for a request action.public Future<DescribeBuildResult> describeBuildAsync(DescribeBuildRequest request, AsyncHandler<DescribeBuildRequest,DescribeBuildResult> asyncHandler)
AmazonGameLiftAsync
Retrieves properties for a build. To get a build record, specify a build ID. If successful, an object containing the build properties is returned.
describeBuildAsync
in interface AmazonGameLiftAsync
request
- 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.public Future<DescribeEC2InstanceLimitsResult> describeEC2InstanceLimitsAsync(DescribeEC2InstanceLimitsRequest request)
AmazonGameLiftAsync
Retrieves the following information for the specified EC2 instance type:
maximum number of instances allowed per AWS account (service limit)
current usage level for the AWS account
Service limits vary depending on region. Available regions for GameLift can be found in the AWS Management Console for GameLift (see the drop-down list in the upper right corner).
describeEC2InstanceLimitsAsync
in interface AmazonGameLiftAsync
request
- Represents the input for a request action.public Future<DescribeEC2InstanceLimitsResult> describeEC2InstanceLimitsAsync(DescribeEC2InstanceLimitsRequest request, AsyncHandler<DescribeEC2InstanceLimitsRequest,DescribeEC2InstanceLimitsResult> asyncHandler)
AmazonGameLiftAsync
Retrieves the following information for the specified EC2 instance type:
maximum number of instances allowed per AWS account (service limit)
current usage level for the AWS account
Service limits vary depending on region. Available regions for GameLift can be found in the AWS Management Console for GameLift (see the drop-down list in the upper right corner).
describeEC2InstanceLimitsAsync
in interface AmazonGameLiftAsync
request
- 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.public Future<DescribeFleetAttributesResult> describeFleetAttributesAsync(DescribeFleetAttributesRequest request)
AmazonGameLiftAsync
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. When requesting multiple fleets, use the pagination parameters to retrieve results as a set of sequential pages. If successful, a FleetAttributes object is returned for each requested fleet ID. When specifying a list of fleet IDs, attribute objects are returned only for fleets that currently exist.
Some API actions 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.
describeFleetAttributesAsync
in interface AmazonGameLiftAsync
request
- Represents the input for a request action.public Future<DescribeFleetAttributesResult> describeFleetAttributesAsync(DescribeFleetAttributesRequest request, AsyncHandler<DescribeFleetAttributesRequest,DescribeFleetAttributesResult> asyncHandler)
AmazonGameLiftAsync
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. When requesting multiple fleets, use the pagination parameters to retrieve results as a set of sequential pages. If successful, a FleetAttributes object is returned for each requested fleet ID. When specifying a list of fleet IDs, attribute objects are returned only for fleets that currently exist.
Some API actions 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.
describeFleetAttributesAsync
in interface AmazonGameLiftAsync
request
- 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.public Future<DescribeFleetCapacityResult> describeFleetCapacityAsync(DescribeFleetCapacityRequest request)
AmazonGameLiftAsync
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. 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. When specifying a list of fleet IDs, attribute objects are returned only for fleets that currently exist.
Some API actions 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.
describeFleetCapacityAsync
in interface AmazonGameLiftAsync
request
- Represents the input for a request action.public Future<DescribeFleetCapacityResult> describeFleetCapacityAsync(DescribeFleetCapacityRequest request, AsyncHandler<DescribeFleetCapacityRequest,DescribeFleetCapacityResult> asyncHandler)
AmazonGameLiftAsync
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. 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. When specifying a list of fleet IDs, attribute objects are returned only for fleets that currently exist.
Some API actions 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.
describeFleetCapacityAsync
in interface AmazonGameLiftAsync
request
- 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.public Future<DescribeFleetEventsResult> describeFleetEventsAsync(DescribeFleetEventsRequest request)
AmazonGameLiftAsync
Retrieves entries from the specified fleet's event log. 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.
describeFleetEventsAsync
in interface AmazonGameLiftAsync
request
- Represents the input for a request action.public Future<DescribeFleetEventsResult> describeFleetEventsAsync(DescribeFleetEventsRequest request, AsyncHandler<DescribeFleetEventsRequest,DescribeFleetEventsResult> asyncHandler)
AmazonGameLiftAsync
Retrieves entries from the specified fleet's event log. 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.
describeFleetEventsAsync
in interface AmazonGameLiftAsync
request
- 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.public Future<DescribeFleetPortSettingsResult> describeFleetPortSettingsAsync(DescribeFleetPortSettingsRequest request)
AmazonGameLiftAsync
Retrieves the inbound connection permissions for a fleet. Connection permissions include a range of IP addresses and port settings that incoming traffic can use to access server processes in the fleet. To get a fleet's inbound connection permissions, specify a fleet ID. If successful, a collection of IpPermission objects is returned for the requested fleet ID. If the requested fleet has been deleted, the result set is empty.
describeFleetPortSettingsAsync
in interface AmazonGameLiftAsync
request
- Represents the input for a request action.public Future<DescribeFleetPortSettingsResult> describeFleetPortSettingsAsync(DescribeFleetPortSettingsRequest request, AsyncHandler<DescribeFleetPortSettingsRequest,DescribeFleetPortSettingsResult> asyncHandler)
AmazonGameLiftAsync
Retrieves the inbound connection permissions for a fleet. Connection permissions include a range of IP addresses and port settings that incoming traffic can use to access server processes in the fleet. To get a fleet's inbound connection permissions, specify a fleet ID. If successful, a collection of IpPermission objects is returned for the requested fleet ID. If the requested fleet has been deleted, the result set is empty.
describeFleetPortSettingsAsync
in interface AmazonGameLiftAsync
request
- 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.public Future<DescribeFleetUtilizationResult> describeFleetUtilizationAsync(DescribeFleetUtilizationRequest request)
AmazonGameLiftAsync
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. 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. When specifying a list of fleet IDs, utilization objects are returned only for fleets that currently exist.
Some API actions 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.
describeFleetUtilizationAsync
in interface AmazonGameLiftAsync
request
- Represents the input for a request action.public Future<DescribeFleetUtilizationResult> describeFleetUtilizationAsync(DescribeFleetUtilizationRequest request, AsyncHandler<DescribeFleetUtilizationRequest,DescribeFleetUtilizationResult> asyncHandler)
AmazonGameLiftAsync
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. 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. When specifying a list of fleet IDs, utilization objects are returned only for fleets that currently exist.
Some API actions 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.
describeFleetUtilizationAsync
in interface AmazonGameLiftAsync
request
- 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.public Future<DescribeGameSessionDetailsResult> describeGameSessionDetailsAsync(DescribeGameSessionDetailsRequest request)
AmazonGameLiftAsync
Retrieves properties, including the protection policy in force, for one or more game sessions. This action can be
used in several ways: (1) provide a GameSessionId
to request details for a specific game session;
(2) provide either a FleetId
or an AliasId
to request properties for all game sessions
running on a fleet.
To get game session record(s), specify just one of the following: game session ID, fleet ID, or alias ID. You can filter this request by game session status. Use the pagination parameters to retrieve results as a set of sequential pages. If successful, a GameSessionDetail object is returned for each session matching the request.
describeGameSessionDetailsAsync
in interface AmazonGameLiftAsync
request
- Represents the input for a request action.public Future<DescribeGameSessionDetailsResult> describeGameSessionDetailsAsync(DescribeGameSessionDetailsRequest request, AsyncHandler<DescribeGameSessionDetailsRequest,DescribeGameSessionDetailsResult> asyncHandler)
AmazonGameLiftAsync
Retrieves properties, including the protection policy in force, for one or more game sessions. This action can be
used in several ways: (1) provide a GameSessionId
to request details for a specific game session;
(2) provide either a FleetId
or an AliasId
to request properties for all game sessions
running on a fleet.
To get game session record(s), specify just one of the following: game session ID, fleet ID, or alias ID. You can filter this request by game session status. Use the pagination parameters to retrieve results as a set of sequential pages. If successful, a GameSessionDetail object is returned for each session matching the request.
describeGameSessionDetailsAsync
in interface AmazonGameLiftAsync
request
- 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.public Future<DescribeGameSessionsResult> describeGameSessionsAsync(DescribeGameSessionsRequest request)
AmazonGameLiftAsync
Retrieves a set of one or more game sessions and properties. This action can be used in several ways: (1) provide
a GameSessionId
to request properties for a specific game session; (2) provide a
FleetId
or an AliasId
to request properties for all game sessions running on a fleet.
You can also use SearchGameSessions, which allows you to retrieve all game sessions or filter on certain
criteria, but only returns game sessions with a status of ACTIVE. If you need to retrieve the protection policy
for each game session, use DescribeGameSessionDetails.
To get game session record(s), specify just one of the following: game session ID, fleet ID, or alias ID. You can filter this request by game session status. Use the pagination parameters to retrieve results as a set of sequential pages. If successful, a GameSession object is returned for each session matching the request.
describeGameSessionsAsync
in interface AmazonGameLiftAsync
request
- Represents the input for a request action.public Future<DescribeGameSessionsResult> describeGameSessionsAsync(DescribeGameSessionsRequest request, AsyncHandler<DescribeGameSessionsRequest,DescribeGameSessionsResult> asyncHandler)
AmazonGameLiftAsync
Retrieves a set of one or more game sessions and properties. This action can be used in several ways: (1) provide
a GameSessionId
to request properties for a specific game session; (2) provide a
FleetId
or an AliasId
to request properties for all game sessions running on a fleet.
You can also use SearchGameSessions, which allows you to retrieve all game sessions or filter on certain
criteria, but only returns game sessions with a status of ACTIVE. If you need to retrieve the protection policy
for each game session, use DescribeGameSessionDetails.
To get game session record(s), specify just one of the following: game session ID, fleet ID, or alias ID. You can filter this request by game session status. Use the pagination parameters to retrieve results as a set of sequential pages. If successful, a GameSession object is returned for each session matching the request.
describeGameSessionsAsync
in interface AmazonGameLiftAsync
request
- 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.public Future<DescribeInstancesResult> describeInstancesAsync(DescribeInstancesRequest request)
AmazonGameLiftAsync
Retrieves information about instances in a fleet.
To get information on a specific instance, specify both a fleet ID and instance ID. To get information for all instances in a fleet, specify a fleet ID only. Use the pagination parameters to retrieve results as a set of sequential pages. If successful, an Instance object is returned for each result.
describeInstancesAsync
in interface AmazonGameLiftAsync
request
- Represents the input for a request action.public Future<DescribeInstancesResult> describeInstancesAsync(DescribeInstancesRequest request, AsyncHandler<DescribeInstancesRequest,DescribeInstancesResult> asyncHandler)
AmazonGameLiftAsync
Retrieves information about instances in a fleet.
To get information on a specific instance, specify both a fleet ID and instance ID. To get information for all instances in a fleet, specify a fleet ID only. Use the pagination parameters to retrieve results as a set of sequential pages. If successful, an Instance object is returned for each result.
describeInstancesAsync
in interface AmazonGameLiftAsync
request
- 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.public Future<DescribePlayerSessionsResult> describePlayerSessionsAsync(DescribePlayerSessionsRequest request)
AmazonGameLiftAsync
Retrieves properties for one or more player sessions. This action can be used in several ways: (1) provide a
PlayerSessionId
parameter to request properties for a specific player session; (2) provide a
GameSessionId
parameter to request properties for all player sessions in the specified game session;
(3) provide a PlayerId
parameter 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 filter this request by player session status. Use the pagination parameters to retrieve results as a set of sequential pages. If successful, a PlayerSession object is returned for each session matching the request.
describePlayerSessionsAsync
in interface AmazonGameLiftAsync
request
- Represents the input for a request action.public Future<DescribePlayerSessionsResult> describePlayerSessionsAsync(DescribePlayerSessionsRequest request, AsyncHandler<DescribePlayerSessionsRequest,DescribePlayerSessionsResult> asyncHandler)
AmazonGameLiftAsync
Retrieves properties for one or more player sessions. This action can be used in several ways: (1) provide a
PlayerSessionId
parameter to request properties for a specific player session; (2) provide a
GameSessionId
parameter to request properties for all player sessions in the specified game session;
(3) provide a PlayerId
parameter 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 filter this request by player session status. Use the pagination parameters to retrieve results as a set of sequential pages. If successful, a PlayerSession object is returned for each session matching the request.
describePlayerSessionsAsync
in interface AmazonGameLiftAsync
request
- 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.public Future<DescribeRuntimeConfigurationResult> describeRuntimeConfigurationAsync(DescribeRuntimeConfigurationRequest request)
AmazonGameLiftAsync
Retrieves the current runtime configuration for the specified fleet. The runtime configuration tells GameLift how to launch server processes on instances in the fleet.
describeRuntimeConfigurationAsync
in interface AmazonGameLiftAsync
request
- Represents the input for a request action.public Future<DescribeRuntimeConfigurationResult> describeRuntimeConfigurationAsync(DescribeRuntimeConfigurationRequest request, AsyncHandler<DescribeRuntimeConfigurationRequest,DescribeRuntimeConfigurationResult> asyncHandler)
AmazonGameLiftAsync
Retrieves the current runtime configuration for the specified fleet. The runtime configuration tells GameLift how to launch server processes on instances in the fleet.
describeRuntimeConfigurationAsync
in interface AmazonGameLiftAsync
request
- 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.public Future<DescribeScalingPoliciesResult> describeScalingPoliciesAsync(DescribeScalingPoliciesRequest request)
AmazonGameLiftAsync
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.
describeScalingPoliciesAsync
in interface AmazonGameLiftAsync
request
- Represents the input for a request action.public Future<DescribeScalingPoliciesResult> describeScalingPoliciesAsync(DescribeScalingPoliciesRequest request, AsyncHandler<DescribeScalingPoliciesRequest,DescribeScalingPoliciesResult> asyncHandler)
AmazonGameLiftAsync
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.
describeScalingPoliciesAsync
in interface AmazonGameLiftAsync
request
- 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.public Future<GetGameSessionLogUrlResult> getGameSessionLogUrlAsync(GetGameSessionLogUrlRequest request)
AmazonGameLiftAsync
Retrieves the location of stored game session logs for a specified game session. When a game session is terminated, Amazon GameLift automatically stores the logs in Amazon 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 are not saved.
getGameSessionLogUrlAsync
in interface AmazonGameLiftAsync
request
- Represents the input for a request action.public Future<GetGameSessionLogUrlResult> getGameSessionLogUrlAsync(GetGameSessionLogUrlRequest request, AsyncHandler<GetGameSessionLogUrlRequest,GetGameSessionLogUrlResult> asyncHandler)
AmazonGameLiftAsync
Retrieves the location of stored game session logs for a specified game session. When a game session is terminated, Amazon GameLift automatically stores the logs in Amazon 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 are not saved.
getGameSessionLogUrlAsync
in interface AmazonGameLiftAsync
request
- 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.public Future<ListAliasesResult> listAliasesAsync(ListAliasesRequest request)
AmazonGameLiftAsync
Retrieves a collection of alias records for this AWS 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.
Aliases are not listed in any particular order.
listAliasesAsync
in interface AmazonGameLiftAsync
request
- Represents the input for a request action.public Future<ListAliasesResult> listAliasesAsync(ListAliasesRequest request, AsyncHandler<ListAliasesRequest,ListAliasesResult> asyncHandler)
AmazonGameLiftAsync
Retrieves a collection of alias records for this AWS 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.
Aliases are not listed in any particular order.
listAliasesAsync
in interface AmazonGameLiftAsync
request
- 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.public Future<ListBuildsResult> listBuildsAsync(ListBuildsRequest request)
AmazonGameLiftAsync
Retrieves build records for all builds associated with the AWS 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 records are not listed in any particular order.
listBuildsAsync
in interface AmazonGameLiftAsync
request
- Represents the input for a request action.public Future<ListBuildsResult> listBuildsAsync(ListBuildsRequest request, AsyncHandler<ListBuildsRequest,ListBuildsResult> asyncHandler)
AmazonGameLiftAsync
Retrieves build records for all builds associated with the AWS 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 records are not listed in any particular order.
listBuildsAsync
in interface AmazonGameLiftAsync
request
- 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.public Future<ListFleetsResult> listFleetsAsync(ListFleetsRequest request)
AmazonGameLiftAsync
Retrieves a collection of fleet records for this AWS account. You can filter the result set by build ID. Use the pagination parameters to retrieve results in sequential pages.
Fleet records are not listed in any particular order.
listFleetsAsync
in interface AmazonGameLiftAsync
request
- Represents the input for a request action.public Future<ListFleetsResult> listFleetsAsync(ListFleetsRequest request, AsyncHandler<ListFleetsRequest,ListFleetsResult> asyncHandler)
AmazonGameLiftAsync
Retrieves a collection of fleet records for this AWS account. You can filter the result set by build ID. Use the pagination parameters to retrieve results in sequential pages.
Fleet records are not listed in any particular order.
listFleetsAsync
in interface AmazonGameLiftAsync
request
- 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.public Future<PutScalingPolicyResult> putScalingPolicyAsync(PutScalingPolicyRequest request)
AmazonGameLiftAsync
Creates or updates a scaling policy for a fleet. An active scaling policy prompts Amazon GameLift to track a certain metric for a fleet and automatically change the fleet's capacity in specific circumstances. Each scaling policy contains one rule statement. Fleets can have multiple scaling policies in force simultaneously.
A scaling policy rule statement has the following structure:
If [MetricName]
is [ComparisonOperator]
[Threshold]
for
[EvaluationPeriods]
minutes, then [ScalingAdjustmentType]
to/by
[ScalingAdjustment]
.
For example, this policy: "If the number of idle instances exceeds 20 for more than 15 minutes, then reduce the fleet capacity by 10 instances" could be implemented as the following rule statement:
If [IdleInstances] is [GreaterThanOrEqualToThreshold] [20] for [15] minutes, then [ChangeInCapacity] by [-10].
To create or update a scaling policy, specify a unique combination of name and fleet ID, and set the rule values. All parameters for this action are required. If successful, the policy name is returned. Scaling policies cannot be suspended or made inactive. To stop enforcing a scaling policy, call DeleteScalingPolicy.
putScalingPolicyAsync
in interface AmazonGameLiftAsync
request
- Represents the input for a request action.public Future<PutScalingPolicyResult> putScalingPolicyAsync(PutScalingPolicyRequest request, AsyncHandler<PutScalingPolicyRequest,PutScalingPolicyResult> asyncHandler)
AmazonGameLiftAsync
Creates or updates a scaling policy for a fleet. An active scaling policy prompts Amazon GameLift to track a certain metric for a fleet and automatically change the fleet's capacity in specific circumstances. Each scaling policy contains one rule statement. Fleets can have multiple scaling policies in force simultaneously.
A scaling policy rule statement has the following structure:
If [MetricName]
is [ComparisonOperator]
[Threshold]
for
[EvaluationPeriods]
minutes, then [ScalingAdjustmentType]
to/by
[ScalingAdjustment]
.
For example, this policy: "If the number of idle instances exceeds 20 for more than 15 minutes, then reduce the fleet capacity by 10 instances" could be implemented as the following rule statement:
If [IdleInstances] is [GreaterThanOrEqualToThreshold] [20] for [15] minutes, then [ChangeInCapacity] by [-10].
To create or update a scaling policy, specify a unique combination of name and fleet ID, and set the rule values. All parameters for this action are required. If successful, the policy name is returned. Scaling policies cannot be suspended or made inactive. To stop enforcing a scaling policy, call DeleteScalingPolicy.
putScalingPolicyAsync
in interface AmazonGameLiftAsync
request
- 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.public Future<RequestUploadCredentialsResult> requestUploadCredentialsAsync(RequestUploadCredentialsRequest request)
AmazonGameLiftAsync
Retrieves a fresh set of upload credentials and the assigned Amazon S3 storage location for a specific build. Valid credentials are required to upload your game build files to Amazon S3.
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.
Upload 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 until the status of that build changes to READY
.
Once this happens, you must create a brand new build.
requestUploadCredentialsAsync
in interface AmazonGameLiftAsync
request
- Represents the input for a request action.public Future<RequestUploadCredentialsResult> requestUploadCredentialsAsync(RequestUploadCredentialsRequest request, AsyncHandler<RequestUploadCredentialsRequest,RequestUploadCredentialsResult> asyncHandler)
AmazonGameLiftAsync
Retrieves a fresh set of upload credentials and the assigned Amazon S3 storage location for a specific build. Valid credentials are required to upload your game build files to Amazon S3.
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.
Upload 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 until the status of that build changes to READY
.
Once this happens, you must create a brand new build.
requestUploadCredentialsAsync
in interface AmazonGameLiftAsync
request
- 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.public Future<ResolveAliasResult> resolveAliasAsync(ResolveAliasRequest request)
AmazonGameLiftAsync
Retrieves the fleet ID that a specified alias is currently pointing to.
resolveAliasAsync
in interface AmazonGameLiftAsync
request
- Represents the input for a request action.public Future<ResolveAliasResult> resolveAliasAsync(ResolveAliasRequest request, AsyncHandler<ResolveAliasRequest,ResolveAliasResult> asyncHandler)
AmazonGameLiftAsync
Retrieves the fleet ID that a specified alias is currently pointing to.
resolveAliasAsync
in interface AmazonGameLiftAsync
request
- 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.public Future<SearchGameSessionsResult> searchGameSessionsAsync(SearchGameSessionsRequest request)
AmazonGameLiftAsync
Retrieves a set of game sessions that match a set of search criteria and sorts them in a specified order. Currently a game session search is limited to a single fleet. Search results include only game sessions that are in ACTIVE status. If you need to retrieve game sessions with a status other than active, use DescribeGameSessions. If you need to retrieve the protection policy for each game session, use DescribeGameSessionDetails.
You can search or sort by the following game session attributes:
gameSessionId -- ID value assigned to a game session. This unique value is returned in a GameSession object when a new game session is created.
gameSessionName -- Name assigned to a game session. This value is set when requesting a new game session with CreateGameSession or updating with UpdateGameSession. Game session names do not need to be unique to 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.
maximumSessions -- Maximum number of player sessions allowed for a game session. This value is set when requesting a new game session with CreateGameSession or updating with UpdateGameSession.
hasAvailablePlayerSessions -- Boolean value indicating whether or not a game session has reached its
maximum number of players. When searching with this attribute, the search value must be true
or
false
. It is highly recommended that all search requests include this filter attribute to optimize
search performance and return only sessions that players can join.
To search or sort, specify either a fleet ID or an alias ID, and provide a search filter expression, a sort expression, or both. Use the pagination parameters to retrieve results as a set of sequential pages. If successful, a collection of GameSession objects matching the request is returned.
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.
searchGameSessionsAsync
in interface AmazonGameLiftAsync
request
- Represents the input for a request action.public Future<SearchGameSessionsResult> searchGameSessionsAsync(SearchGameSessionsRequest request, AsyncHandler<SearchGameSessionsRequest,SearchGameSessionsResult> asyncHandler)
AmazonGameLiftAsync
Retrieves a set of game sessions that match a set of search criteria and sorts them in a specified order. Currently a game session search is limited to a single fleet. Search results include only game sessions that are in ACTIVE status. If you need to retrieve game sessions with a status other than active, use DescribeGameSessions. If you need to retrieve the protection policy for each game session, use DescribeGameSessionDetails.
You can search or sort by the following game session attributes:
gameSessionId -- ID value assigned to a game session. This unique value is returned in a GameSession object when a new game session is created.
gameSessionName -- Name assigned to a game session. This value is set when requesting a new game session with CreateGameSession or updating with UpdateGameSession. Game session names do not need to be unique to 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.
maximumSessions -- Maximum number of player sessions allowed for a game session. This value is set when requesting a new game session with CreateGameSession or updating with UpdateGameSession.
hasAvailablePlayerSessions -- Boolean value indicating whether or not a game session has reached its
maximum number of players. When searching with this attribute, the search value must be true
or
false
. It is highly recommended that all search requests include this filter attribute to optimize
search performance and return only sessions that players can join.
To search or sort, specify either a fleet ID or an alias ID, and provide a search filter expression, a sort expression, or both. Use the pagination parameters to retrieve results as a set of sequential pages. If successful, a collection of GameSession objects matching the request is returned.
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.
searchGameSessionsAsync
in interface AmazonGameLiftAsync
request
- 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.public Future<UpdateAliasResult> updateAliasAsync(UpdateAliasRequest request)
AmazonGameLiftAsync
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.
updateAliasAsync
in interface AmazonGameLiftAsync
request
- Represents the input for a request action.public Future<UpdateAliasResult> updateAliasAsync(UpdateAliasRequest request, AsyncHandler<UpdateAliasRequest,UpdateAliasResult> asyncHandler)
AmazonGameLiftAsync
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.
updateAliasAsync
in interface AmazonGameLiftAsync
request
- 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.public Future<UpdateBuildResult> updateBuildAsync(UpdateBuildRequest request)
AmazonGameLiftAsync
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.
updateBuildAsync
in interface AmazonGameLiftAsync
request
- Represents the input for a request action.public Future<UpdateBuildResult> updateBuildAsync(UpdateBuildRequest request, AsyncHandler<UpdateBuildRequest,UpdateBuildResult> asyncHandler)
AmazonGameLiftAsync
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.
updateBuildAsync
in interface AmazonGameLiftAsync
request
- 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.public Future<UpdateFleetAttributesResult> updateFleetAttributesAsync(UpdateFleetAttributesRequest request)
AmazonGameLiftAsync
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.
updateFleetAttributesAsync
in interface AmazonGameLiftAsync
request
- Represents the input for a request action.public Future<UpdateFleetAttributesResult> updateFleetAttributesAsync(UpdateFleetAttributesRequest request, AsyncHandler<UpdateFleetAttributesRequest,UpdateFleetAttributesResult> asyncHandler)
AmazonGameLiftAsync
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.
updateFleetAttributesAsync
in interface AmazonGameLiftAsync
request
- 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.public Future<UpdateFleetCapacityResult> updateFleetCapacityAsync(UpdateFleetCapacityRequest request)
AmazonGameLiftAsync
Updates capacity settings for a fleet. Use this action to specify the number of EC2 instances (hosts) that 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.
If you're using autoscaling (see PutScalingPolicy), you may want to specify a minimum and/or maximum capacity. If you don't provide these, autoscaling can set capacity anywhere between zero and the service limits.
To update fleet capacity, specify the fleet ID and the number of instances you want the fleet to host. If successful, Amazon GameLift starts or terminates 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 "Limit Exceeded" exception occurs.
updateFleetCapacityAsync
in interface AmazonGameLiftAsync
request
- Represents the input for a request action.public Future<UpdateFleetCapacityResult> updateFleetCapacityAsync(UpdateFleetCapacityRequest request, AsyncHandler<UpdateFleetCapacityRequest,UpdateFleetCapacityResult> asyncHandler)
AmazonGameLiftAsync
Updates capacity settings for a fleet. Use this action to specify the number of EC2 instances (hosts) that 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.
If you're using autoscaling (see PutScalingPolicy), you may want to specify a minimum and/or maximum capacity. If you don't provide these, autoscaling can set capacity anywhere between zero and the service limits.
To update fleet capacity, specify the fleet ID and the number of instances you want the fleet to host. If successful, Amazon GameLift starts or terminates 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 "Limit Exceeded" exception occurs.
updateFleetCapacityAsync
in interface AmazonGameLiftAsync
request
- 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.public Future<UpdateFleetPortSettingsResult> updateFleetPortSettingsAsync(UpdateFleetPortSettingsRequest request)
AmazonGameLiftAsync
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.
updateFleetPortSettingsAsync
in interface AmazonGameLiftAsync
request
- Represents the input for a request action.public Future<UpdateFleetPortSettingsResult> updateFleetPortSettingsAsync(UpdateFleetPortSettingsRequest request, AsyncHandler<UpdateFleetPortSettingsRequest,UpdateFleetPortSettingsResult> asyncHandler)
AmazonGameLiftAsync
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.
updateFleetPortSettingsAsync
in interface AmazonGameLiftAsync
request
- 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.public Future<UpdateGameSessionResult> updateGameSessionAsync(UpdateGameSessionRequest request)
AmazonGameLiftAsync
Updates game session properties. This includes the session name, maximum player count, protection policy, which controls whether or not an active game session can be terminated during a scale-down event, and the player session creation policy, which controls whether or not new players can join 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.
updateGameSessionAsync
in interface AmazonGameLiftAsync
request
- Represents the input for a request action.public Future<UpdateGameSessionResult> updateGameSessionAsync(UpdateGameSessionRequest request, AsyncHandler<UpdateGameSessionRequest,UpdateGameSessionResult> asyncHandler)
AmazonGameLiftAsync
Updates game session properties. This includes the session name, maximum player count, protection policy, which controls whether or not an active game session can be terminated during a scale-down event, and the player session creation policy, which controls whether or not new players can join 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.
updateGameSessionAsync
in interface AmazonGameLiftAsync
request
- 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.public Future<UpdateRuntimeConfigurationResult> updateRuntimeConfigurationAsync(UpdateRuntimeConfigurationRequest request)
AmazonGameLiftAsync
Updates the current runtime configuration for the specified fleet, which tells GameLift how to launch server
processes on instances in the fleet. You can update a fleet's runtime configuration at any time after the fleet
is created; it does not need to be in an ACTIVE
status.
To update runtime configuration, specify the fleet ID and provide a RuntimeConfiguration
object with
the updated collection of server process configurations.
Each instance in a GameLift fleet checks regularly for an updated runtime configuration and changes how it launches server processes to comply with the latest version. Existing server processes are not affected by the update; they continue to run until they end, while GameLift simply adds new server processes to fit the current runtime configuration. As a result, the runtime configuration changes are applied gradually as existing processes shut down and new processes are launched in GameLift's normal process recycling activity.
updateRuntimeConfigurationAsync
in interface AmazonGameLiftAsync
request
- Represents the input for a request action.public Future<UpdateRuntimeConfigurationResult> updateRuntimeConfigurationAsync(UpdateRuntimeConfigurationRequest request, AsyncHandler<UpdateRuntimeConfigurationRequest,UpdateRuntimeConfigurationResult> asyncHandler)
AmazonGameLiftAsync
Updates the current runtime configuration for the specified fleet, which tells GameLift how to launch server
processes on instances in the fleet. You can update a fleet's runtime configuration at any time after the fleet
is created; it does not need to be in an ACTIVE
status.
To update runtime configuration, specify the fleet ID and provide a RuntimeConfiguration
object with
the updated collection of server process configurations.
Each instance in a GameLift fleet checks regularly for an updated runtime configuration and changes how it launches server processes to comply with the latest version. Existing server processes are not affected by the update; they continue to run until they end, while GameLift simply adds new server processes to fit the current runtime configuration. As a result, the runtime configuration changes are applied gradually as existing processes shut down and new processes are launched in GameLift's normal process recycling activity.
updateRuntimeConfigurationAsync
in interface AmazonGameLiftAsync
request
- 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.