@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AWSGameSparksAsync extends AWSGameSparks
AsyncHandler
can be used to receive
notification when an asynchronous operation completes.
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAWSGameSparksAsync
instead.
ENDPOINT_PREFIX
createGame, createSnapshot, createStage, deleteGame, deleteStage, disconnectPlayer, exportSnapshot, getCachedResponseMetadata, getExtension, getExtensionVersion, getGame, getGameConfiguration, getGeneratedCodeJob, getPlayerConnectionStatus, getSnapshot, getStage, getStageDeployment, importGameConfiguration, listExtensions, listExtensionVersions, listGames, listGeneratedCodeJobs, listSnapshots, listStageDeployments, listStages, listTagsForResource, shutdown, startGeneratedCodeJob, startStageDeployment, tagResource, untagResource, updateGame, updateGameConfiguration, updateSnapshot, updateStage
Future<CreateGameResult> createGameAsync(CreateGameRequest createGameRequest)
Creates a new game with an empty configuration. After creating your game, you can update the configuration using
UpdateGameConfiguration
or ImportGameConfiguration
.
createGameRequest
- Future<CreateGameResult> createGameAsync(CreateGameRequest createGameRequest, AsyncHandler<CreateGameRequest,CreateGameResult> asyncHandler)
Creates a new game with an empty configuration. After creating your game, you can update the configuration using
UpdateGameConfiguration
or ImportGameConfiguration
.
createGameRequest
- 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<CreateSnapshotResult> createSnapshotAsync(CreateSnapshotRequest createSnapshotRequest)
Creates a snapshot of the game configuration.
createSnapshotRequest
- Future<CreateSnapshotResult> createSnapshotAsync(CreateSnapshotRequest createSnapshotRequest, AsyncHandler<CreateSnapshotRequest,CreateSnapshotResult> asyncHandler)
Creates a snapshot of the game configuration.
createSnapshotRequest
- 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<CreateStageResult> createStageAsync(CreateStageRequest createStageRequest)
Creates a new stage for stage-by-stage game development and deployment.
createStageRequest
- Future<CreateStageResult> createStageAsync(CreateStageRequest createStageRequest, AsyncHandler<CreateStageRequest,CreateStageResult> asyncHandler)
Creates a new stage for stage-by-stage game development and deployment.
createStageRequest
- 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<DeleteGameResult> deleteGameAsync(DeleteGameRequest deleteGameRequest)
Deletes a game.
deleteGameRequest
- Future<DeleteGameResult> deleteGameAsync(DeleteGameRequest deleteGameRequest, AsyncHandler<DeleteGameRequest,DeleteGameResult> asyncHandler)
Deletes a game.
deleteGameRequest
- 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<DeleteStageResult> deleteStageAsync(DeleteStageRequest deleteStageRequest)
Deletes a stage from a game, along with the associated game runtime.
deleteStageRequest
- Future<DeleteStageResult> deleteStageAsync(DeleteStageRequest deleteStageRequest, AsyncHandler<DeleteStageRequest,DeleteStageResult> asyncHandler)
Deletes a stage from a game, along with the associated game runtime.
deleteStageRequest
- 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<DisconnectPlayerResult> disconnectPlayerAsync(DisconnectPlayerRequest disconnectPlayerRequest)
Disconnects a player from the game runtime.
If a player has multiple connections, this operation attempts to close all of them.
disconnectPlayerRequest
- Future<DisconnectPlayerResult> disconnectPlayerAsync(DisconnectPlayerRequest disconnectPlayerRequest, AsyncHandler<DisconnectPlayerRequest,DisconnectPlayerResult> asyncHandler)
Disconnects a player from the game runtime.
If a player has multiple connections, this operation attempts to close all of them.
disconnectPlayerRequest
- 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<ExportSnapshotResult> exportSnapshotAsync(ExportSnapshotRequest exportSnapshotRequest)
Exports a game configuration snapshot.
exportSnapshotRequest
- Future<ExportSnapshotResult> exportSnapshotAsync(ExportSnapshotRequest exportSnapshotRequest, AsyncHandler<ExportSnapshotRequest,ExportSnapshotResult> asyncHandler)
Exports a game configuration snapshot.
exportSnapshotRequest
- 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<GetExtensionResult> getExtensionAsync(GetExtensionRequest getExtensionRequest)
Gets details about a specified extension.
getExtensionRequest
- Future<GetExtensionResult> getExtensionAsync(GetExtensionRequest getExtensionRequest, AsyncHandler<GetExtensionRequest,GetExtensionResult> asyncHandler)
Gets details about a specified extension.
getExtensionRequest
- 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<GetExtensionVersionResult> getExtensionVersionAsync(GetExtensionVersionRequest getExtensionVersionRequest)
Gets details about a specified extension version.
getExtensionVersionRequest
- Future<GetExtensionVersionResult> getExtensionVersionAsync(GetExtensionVersionRequest getExtensionVersionRequest, AsyncHandler<GetExtensionVersionRequest,GetExtensionVersionResult> asyncHandler)
Gets details about a specified extension version.
getExtensionVersionRequest
- 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<GetGameResult> getGameAsync(GetGameRequest getGameRequest)
Gets details about a game.
getGameRequest
- Future<GetGameResult> getGameAsync(GetGameRequest getGameRequest, AsyncHandler<GetGameRequest,GetGameResult> asyncHandler)
Gets details about a game.
getGameRequest
- 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<GetGameConfigurationResult> getGameConfigurationAsync(GetGameConfigurationRequest getGameConfigurationRequest)
Gets the configuration of the game.
getGameConfigurationRequest
- Future<GetGameConfigurationResult> getGameConfigurationAsync(GetGameConfigurationRequest getGameConfigurationRequest, AsyncHandler<GetGameConfigurationRequest,GetGameConfigurationResult> asyncHandler)
Gets the configuration of the game.
getGameConfigurationRequest
- 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<GetGeneratedCodeJobResult> getGeneratedCodeJobAsync(GetGeneratedCodeJobRequest getGeneratedCodeJobRequest)
Gets details about a job that is generating code for a snapshot.
getGeneratedCodeJobRequest
- Future<GetGeneratedCodeJobResult> getGeneratedCodeJobAsync(GetGeneratedCodeJobRequest getGeneratedCodeJobRequest, AsyncHandler<GetGeneratedCodeJobRequest,GetGeneratedCodeJobResult> asyncHandler)
Gets details about a job that is generating code for a snapshot.
getGeneratedCodeJobRequest
- 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<GetPlayerConnectionStatusResult> getPlayerConnectionStatusAsync(GetPlayerConnectionStatusRequest getPlayerConnectionStatusRequest)
Gets the status of a player's connection to the game runtime.
It's possible for a single player to have multiple connections to the game runtime. If a player is not connected, this operation returns an empty list.
getPlayerConnectionStatusRequest
- Future<GetPlayerConnectionStatusResult> getPlayerConnectionStatusAsync(GetPlayerConnectionStatusRequest getPlayerConnectionStatusRequest, AsyncHandler<GetPlayerConnectionStatusRequest,GetPlayerConnectionStatusResult> asyncHandler)
Gets the status of a player's connection to the game runtime.
It's possible for a single player to have multiple connections to the game runtime. If a player is not connected, this operation returns an empty list.
getPlayerConnectionStatusRequest
- 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<GetSnapshotResult> getSnapshotAsync(GetSnapshotRequest getSnapshotRequest)
Gets a copy of the game configuration in a snapshot.
getSnapshotRequest
- Future<GetSnapshotResult> getSnapshotAsync(GetSnapshotRequest getSnapshotRequest, AsyncHandler<GetSnapshotRequest,GetSnapshotResult> asyncHandler)
Gets a copy of the game configuration in a snapshot.
getSnapshotRequest
- 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<GetStageResult> getStageAsync(GetStageRequest getStageRequest)
Gets information about a stage.
getStageRequest
- Future<GetStageResult> getStageAsync(GetStageRequest getStageRequest, AsyncHandler<GetStageRequest,GetStageResult> asyncHandler)
Gets information about a stage.
getStageRequest
- 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<GetStageDeploymentResult> getStageDeploymentAsync(GetStageDeploymentRequest getStageDeploymentRequest)
Gets information about a stage deployment.
getStageDeploymentRequest
- Future<GetStageDeploymentResult> getStageDeploymentAsync(GetStageDeploymentRequest getStageDeploymentRequest, AsyncHandler<GetStageDeploymentRequest,GetStageDeploymentResult> asyncHandler)
Gets information about a stage deployment.
getStageDeploymentRequest
- 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<ImportGameConfigurationResult> importGameConfigurationAsync(ImportGameConfigurationRequest importGameConfigurationRequest)
Imports a game configuration.
This operation replaces the current configuration of the game with the provided input. This is not a reversible
operation. If you want to preserve the previous configuration, use CreateSnapshot
to make a new
snapshot before importing.
importGameConfigurationRequest
- Future<ImportGameConfigurationResult> importGameConfigurationAsync(ImportGameConfigurationRequest importGameConfigurationRequest, AsyncHandler<ImportGameConfigurationRequest,ImportGameConfigurationResult> asyncHandler)
Imports a game configuration.
This operation replaces the current configuration of the game with the provided input. This is not a reversible
operation. If you want to preserve the previous configuration, use CreateSnapshot
to make a new
snapshot before importing.
importGameConfigurationRequest
- 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<ListExtensionVersionsResult> listExtensionVersionsAsync(ListExtensionVersionsRequest listExtensionVersionsRequest)
Gets a paginated list of available versions for the extension.
Each time an API change is made to an extension, the version is incremented. The list retrieved by this operation shows the versions that are currently available.
listExtensionVersionsRequest
- Future<ListExtensionVersionsResult> listExtensionVersionsAsync(ListExtensionVersionsRequest listExtensionVersionsRequest, AsyncHandler<ListExtensionVersionsRequest,ListExtensionVersionsResult> asyncHandler)
Gets a paginated list of available versions for the extension.
Each time an API change is made to an extension, the version is incremented. The list retrieved by this operation shows the versions that are currently available.
listExtensionVersionsRequest
- 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<ListExtensionsResult> listExtensionsAsync(ListExtensionsRequest listExtensionsRequest)
Gets a paginated list of available extensions.
Extensions provide features that games can use from scripts.
listExtensionsRequest
- Future<ListExtensionsResult> listExtensionsAsync(ListExtensionsRequest listExtensionsRequest, AsyncHandler<ListExtensionsRequest,ListExtensionsResult> asyncHandler)
Gets a paginated list of available extensions.
Extensions provide features that games can use from scripts.
listExtensionsRequest
- 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<ListGamesResult> listGamesAsync(ListGamesRequest listGamesRequest)
Gets a paginated list of games.
listGamesRequest
- Future<ListGamesResult> listGamesAsync(ListGamesRequest listGamesRequest, AsyncHandler<ListGamesRequest,ListGamesResult> asyncHandler)
Gets a paginated list of games.
listGamesRequest
- 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<ListGeneratedCodeJobsResult> listGeneratedCodeJobsAsync(ListGeneratedCodeJobsRequest listGeneratedCodeJobsRequest)
Gets a paginated list of code generation jobs for a snapshot.
listGeneratedCodeJobsRequest
- Future<ListGeneratedCodeJobsResult> listGeneratedCodeJobsAsync(ListGeneratedCodeJobsRequest listGeneratedCodeJobsRequest, AsyncHandler<ListGeneratedCodeJobsRequest,ListGeneratedCodeJobsResult> asyncHandler)
Gets a paginated list of code generation jobs for a snapshot.
listGeneratedCodeJobsRequest
- 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<ListSnapshotsResult> listSnapshotsAsync(ListSnapshotsRequest listSnapshotsRequest)
Gets a paginated list of snapshot summaries from the game.
listSnapshotsRequest
- Future<ListSnapshotsResult> listSnapshotsAsync(ListSnapshotsRequest listSnapshotsRequest, AsyncHandler<ListSnapshotsRequest,ListSnapshotsResult> asyncHandler)
Gets a paginated list of snapshot summaries from the game.
listSnapshotsRequest
- 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<ListStageDeploymentsResult> listStageDeploymentsAsync(ListStageDeploymentsRequest listStageDeploymentsRequest)
Gets a paginated list of stage deployment summaries from the game.
listStageDeploymentsRequest
- Future<ListStageDeploymentsResult> listStageDeploymentsAsync(ListStageDeploymentsRequest listStageDeploymentsRequest, AsyncHandler<ListStageDeploymentsRequest,ListStageDeploymentsResult> asyncHandler)
Gets a paginated list of stage deployment summaries from the game.
listStageDeploymentsRequest
- 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<ListStagesResult> listStagesAsync(ListStagesRequest listStagesRequest)
Gets a paginated list of stage summaries from the game.
listStagesRequest
- Future<ListStagesResult> listStagesAsync(ListStagesRequest listStagesRequest, AsyncHandler<ListStagesRequest,ListStagesResult> asyncHandler)
Gets a paginated list of stage summaries from the game.
listStagesRequest
- 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<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest)
Lists the tags associated with a GameSparks resource.
listTagsForResourceRequest
- Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest, AsyncHandler<ListTagsForResourceRequest,ListTagsForResourceResult> asyncHandler)
Lists the tags associated with a GameSparks resource.
listTagsForResourceRequest
- 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<StartGeneratedCodeJobResult> startGeneratedCodeJobAsync(StartGeneratedCodeJobRequest startGeneratedCodeJobRequest)
Starts an asynchronous process that generates client code for system-defined and custom messages. The resulting code is collected as a .zip file and uploaded to a pre-signed Amazon S3 URL.
startGeneratedCodeJobRequest
- Future<StartGeneratedCodeJobResult> startGeneratedCodeJobAsync(StartGeneratedCodeJobRequest startGeneratedCodeJobRequest, AsyncHandler<StartGeneratedCodeJobRequest,StartGeneratedCodeJobResult> asyncHandler)
Starts an asynchronous process that generates client code for system-defined and custom messages. The resulting code is collected as a .zip file and uploaded to a pre-signed Amazon S3 URL.
startGeneratedCodeJobRequest
- 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<StartStageDeploymentResult> startStageDeploymentAsync(StartStageDeploymentRequest startStageDeploymentRequest)
Deploys a snapshot to the stage and creates a new game runtime.
After you call this operation, you can check the deployment status by using GetStageDeployment
.
If there are any players connected to the previous game runtime, then both runtimes persist. Existing connections to the previous runtime are maintained. When players disconnect and reconnect, they connect to the new runtime. After there are no connections to the previous game runtime, it is deleted.
startStageDeploymentRequest
- Future<StartStageDeploymentResult> startStageDeploymentAsync(StartStageDeploymentRequest startStageDeploymentRequest, AsyncHandler<StartStageDeploymentRequest,StartStageDeploymentResult> asyncHandler)
Deploys a snapshot to the stage and creates a new game runtime.
After you call this operation, you can check the deployment status by using GetStageDeployment
.
If there are any players connected to the previous game runtime, then both runtimes persist. Existing connections to the previous runtime are maintained. When players disconnect and reconnect, they connect to the new runtime. After there are no connections to the previous game runtime, it is deleted.
startStageDeploymentRequest
- 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<TagResourceResult> tagResourceAsync(TagResourceRequest tagResourceRequest)
Adds tags to a GameSparks resource.
tagResourceRequest
- Future<TagResourceResult> tagResourceAsync(TagResourceRequest tagResourceRequest, AsyncHandler<TagResourceRequest,TagResourceResult> asyncHandler)
Adds tags to a GameSparks resource.
tagResourceRequest
- 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<UntagResourceResult> untagResourceAsync(UntagResourceRequest untagResourceRequest)
Removes tags from a GameSparks resource.
untagResourceRequest
- Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest untagResourceRequest, AsyncHandler<UntagResourceRequest,UntagResourceResult> asyncHandler)
Removes tags from a GameSparks resource.
untagResourceRequest
- 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<UpdateGameResult> updateGameAsync(UpdateGameRequest updateGameRequest)
Updates details of the game.
updateGameRequest
- Future<UpdateGameResult> updateGameAsync(UpdateGameRequest updateGameRequest, AsyncHandler<UpdateGameRequest,UpdateGameResult> asyncHandler)
Updates details of the game.
updateGameRequest
- 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<UpdateGameConfigurationResult> updateGameConfigurationAsync(UpdateGameConfigurationRequest updateGameConfigurationRequest)
Updates one or more sections of the game configuration.
updateGameConfigurationRequest
- Future<UpdateGameConfigurationResult> updateGameConfigurationAsync(UpdateGameConfigurationRequest updateGameConfigurationRequest, AsyncHandler<UpdateGameConfigurationRequest,UpdateGameConfigurationResult> asyncHandler)
Updates one or more sections of the game configuration.
updateGameConfigurationRequest
- 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<UpdateSnapshotResult> updateSnapshotAsync(UpdateSnapshotRequest updateSnapshotRequest)
Updates the metadata of a GameSparks snapshot.
updateSnapshotRequest
- Future<UpdateSnapshotResult> updateSnapshotAsync(UpdateSnapshotRequest updateSnapshotRequest, AsyncHandler<UpdateSnapshotRequest,UpdateSnapshotResult> asyncHandler)
Updates the metadata of a GameSparks snapshot.
updateSnapshotRequest
- 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<UpdateStageResult> updateStageAsync(UpdateStageRequest updateStageRequest)
Updates the metadata of a stage.
updateStageRequest
- Future<UpdateStageResult> updateStageAsync(UpdateStageRequest updateStageRequest, AsyncHandler<UpdateStageRequest,UpdateStageResult> asyncHandler)
Updates the metadata of a stage.
updateStageRequest
- 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.