@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AWSGameSparks
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAWSGameSparks instead.
| Modifier and Type | Field and Description |
|---|---|
static String |
ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.
|
| Modifier and Type | Method and Description |
|---|---|
CreateGameResult |
createGame(CreateGameRequest createGameRequest)
Creates a new game with an empty configuration.
|
CreateSnapshotResult |
createSnapshot(CreateSnapshotRequest createSnapshotRequest)
Creates a snapshot of the game configuration.
|
CreateStageResult |
createStage(CreateStageRequest createStageRequest)
Creates a new stage for stage-by-stage game development and deployment.
|
DeleteGameResult |
deleteGame(DeleteGameRequest deleteGameRequest)
Deletes a game.
|
DeleteStageResult |
deleteStage(DeleteStageRequest deleteStageRequest)
Deletes a stage from a game, along with the associated game runtime.
|
DisconnectPlayerResult |
disconnectPlayer(DisconnectPlayerRequest disconnectPlayerRequest)
Disconnects a player from the game runtime.
|
ExportSnapshotResult |
exportSnapshot(ExportSnapshotRequest exportSnapshotRequest)
Exports a game configuration snapshot.
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful request, typically used for debugging issues
where a service isn't acting as expected.
|
GetExtensionResult |
getExtension(GetExtensionRequest getExtensionRequest)
Gets details about a specified extension.
|
GetExtensionVersionResult |
getExtensionVersion(GetExtensionVersionRequest getExtensionVersionRequest)
Gets details about a specified extension version.
|
GetGameResult |
getGame(GetGameRequest getGameRequest)
Gets details about a game.
|
GetGameConfigurationResult |
getGameConfiguration(GetGameConfigurationRequest getGameConfigurationRequest)
Gets the configuration of the game.
|
GetGeneratedCodeJobResult |
getGeneratedCodeJob(GetGeneratedCodeJobRequest getGeneratedCodeJobRequest)
Gets details about a job that is generating code for a snapshot.
|
GetPlayerConnectionStatusResult |
getPlayerConnectionStatus(GetPlayerConnectionStatusRequest getPlayerConnectionStatusRequest)
Gets the status of a player's connection to the game runtime.
|
GetSnapshotResult |
getSnapshot(GetSnapshotRequest getSnapshotRequest)
Gets a copy of the game configuration in a snapshot.
|
GetStageResult |
getStage(GetStageRequest getStageRequest)
Gets information about a stage.
|
GetStageDeploymentResult |
getStageDeployment(GetStageDeploymentRequest getStageDeploymentRequest)
Gets information about a stage deployment.
|
ImportGameConfigurationResult |
importGameConfiguration(ImportGameConfigurationRequest importGameConfigurationRequest)
Imports a game configuration.
|
ListExtensionsResult |
listExtensions(ListExtensionsRequest listExtensionsRequest)
Gets a paginated list of available extensions.
|
ListExtensionVersionsResult |
listExtensionVersions(ListExtensionVersionsRequest listExtensionVersionsRequest)
Gets a paginated list of available versions for the extension.
|
ListGamesResult |
listGames(ListGamesRequest listGamesRequest)
Gets a paginated list of games.
|
ListGeneratedCodeJobsResult |
listGeneratedCodeJobs(ListGeneratedCodeJobsRequest listGeneratedCodeJobsRequest)
Gets a paginated list of code generation jobs for a snapshot.
|
ListSnapshotsResult |
listSnapshots(ListSnapshotsRequest listSnapshotsRequest)
Gets a paginated list of snapshot summaries from the game.
|
ListStageDeploymentsResult |
listStageDeployments(ListStageDeploymentsRequest listStageDeploymentsRequest)
Gets a paginated list of stage deployment summaries from the game.
|
ListStagesResult |
listStages(ListStagesRequest listStagesRequest)
Gets a paginated list of stage summaries from the game.
|
ListTagsForResourceResult |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Lists the tags associated with a GameSparks resource.
|
void |
shutdown()
Shuts down this client object, releasing any resources that might be held open.
|
StartGeneratedCodeJobResult |
startGeneratedCodeJob(StartGeneratedCodeJobRequest startGeneratedCodeJobRequest)
Starts an asynchronous process that generates client code for system-defined and custom messages.
|
StartStageDeploymentResult |
startStageDeployment(StartStageDeploymentRequest startStageDeploymentRequest)
Deploys a snapshot to the stage and creates a new game runtime.
|
TagResourceResult |
tagResource(TagResourceRequest tagResourceRequest)
Adds tags to a GameSparks resource.
|
UntagResourceResult |
untagResource(UntagResourceRequest untagResourceRequest)
Removes tags from a GameSparks resource.
|
UpdateGameResult |
updateGame(UpdateGameRequest updateGameRequest)
Updates details of the game.
|
UpdateGameConfigurationResult |
updateGameConfiguration(UpdateGameConfigurationRequest updateGameConfigurationRequest)
Updates one or more sections of the game configuration.
|
UpdateSnapshotResult |
updateSnapshot(UpdateSnapshotRequest updateSnapshotRequest)
Updates the metadata of a GameSparks snapshot.
|
UpdateStageResult |
updateStage(UpdateStageRequest updateStageRequest)
Updates the metadata of a stage.
|
static final String ENDPOINT_PREFIX
CreateGameResult createGame(CreateGameRequest createGameRequest)
Creates a new game with an empty configuration. After creating your game, you can update the configuration using
UpdateGameConfiguration or ImportGameConfiguration.
createGameRequest - ValidationException - One of the parameters in the request is invalid.AccessDeniedException - You do not have sufficient access to perform this action.ThrottlingException - The request throughput limit was exceeded.ConflictException - The resource already exists, or another operation is in progress.InternalServerException - The service encountered an internal error.ServiceQuotaExceededException - The request would result in exceeding service quota.CreateSnapshotResult createSnapshot(CreateSnapshotRequest createSnapshotRequest)
Creates a snapshot of the game configuration.
createSnapshotRequest - ValidationException - One of the parameters in the request is invalid.AccessDeniedException - You do not have sufficient access to perform this action.ThrottlingException - The request throughput limit was exceeded.ConflictException - The resource already exists, or another operation is in progress.ResourceNotFoundException - The resource specified in the request does not exist.InternalServerException - The service encountered an internal error.CreateStageResult createStage(CreateStageRequest createStageRequest)
Creates a new stage for stage-by-stage game development and deployment.
createStageRequest - ValidationException - One of the parameters in the request is invalid.AccessDeniedException - You do not have sufficient access to perform this action.ThrottlingException - The request throughput limit was exceeded.ConflictException - The resource already exists, or another operation is in progress.ResourceNotFoundException - The resource specified in the request does not exist.InternalServerException - The service encountered an internal error.DeleteGameResult deleteGame(DeleteGameRequest deleteGameRequest)
Deletes a game.
deleteGameRequest - ValidationException - One of the parameters in the request is invalid.AccessDeniedException - You do not have sufficient access to perform this action.ThrottlingException - The request throughput limit was exceeded.ConflictException - The resource already exists, or another operation is in progress.InternalServerException - The service encountered an internal error.DeleteStageResult deleteStage(DeleteStageRequest deleteStageRequest)
Deletes a stage from a game, along with the associated game runtime.
deleteStageRequest - ValidationException - One of the parameters in the request is invalid.AccessDeniedException - You do not have sufficient access to perform this action.ThrottlingException - The request throughput limit was exceeded.ConflictException - The resource already exists, or another operation is in progress.ResourceNotFoundException - The resource specified in the request does not exist.InternalServerException - The service encountered an internal error.DisconnectPlayerResult disconnectPlayer(DisconnectPlayerRequest disconnectPlayerRequest)
Disconnects a player from the game runtime.
If a player has multiple connections, this operation attempts to close all of them.
disconnectPlayerRequest - ValidationException - One of the parameters in the request is invalid.AccessDeniedException - You do not have sufficient access to perform this action.ThrottlingException - The request throughput limit was exceeded.ResourceNotFoundException - The resource specified in the request does not exist.InternalServerException - The service encountered an internal error.ExportSnapshotResult exportSnapshot(ExportSnapshotRequest exportSnapshotRequest)
Exports a game configuration snapshot.
exportSnapshotRequest - ValidationException - One of the parameters in the request is invalid.AccessDeniedException - You do not have sufficient access to perform this action.ThrottlingException - The request throughput limit was exceeded.ResourceNotFoundException - The resource specified in the request does not exist.InternalServerException - The service encountered an internal error.GetExtensionResult getExtension(GetExtensionRequest getExtensionRequest)
Gets details about a specified extension.
getExtensionRequest - ValidationException - One of the parameters in the request is invalid.AccessDeniedException - You do not have sufficient access to perform this action.ThrottlingException - The request throughput limit was exceeded.ResourceNotFoundException - The resource specified in the request does not exist.InternalServerException - The service encountered an internal error.GetExtensionVersionResult getExtensionVersion(GetExtensionVersionRequest getExtensionVersionRequest)
Gets details about a specified extension version.
getExtensionVersionRequest - ValidationException - One of the parameters in the request is invalid.AccessDeniedException - You do not have sufficient access to perform this action.ThrottlingException - The request throughput limit was exceeded.ResourceNotFoundException - The resource specified in the request does not exist.InternalServerException - The service encountered an internal error.GetGameResult getGame(GetGameRequest getGameRequest)
Gets details about a game.
getGameRequest - ValidationException - One of the parameters in the request is invalid.AccessDeniedException - You do not have sufficient access to perform this action.ThrottlingException - The request throughput limit was exceeded.ResourceNotFoundException - The resource specified in the request does not exist.InternalServerException - The service encountered an internal error.GetGameConfigurationResult getGameConfiguration(GetGameConfigurationRequest getGameConfigurationRequest)
Gets the configuration of the game.
getGameConfigurationRequest - ValidationException - One of the parameters in the request is invalid.AccessDeniedException - You do not have sufficient access to perform this action.ThrottlingException - The request throughput limit was exceeded.ResourceNotFoundException - The resource specified in the request does not exist.InternalServerException - The service encountered an internal error.GetGeneratedCodeJobResult getGeneratedCodeJob(GetGeneratedCodeJobRequest getGeneratedCodeJobRequest)
Gets details about a job that is generating code for a snapshot.
getGeneratedCodeJobRequest - ValidationException - One of the parameters in the request is invalid.AccessDeniedException - You do not have sufficient access to perform this action.ThrottlingException - The request throughput limit was exceeded.ResourceNotFoundException - The resource specified in the request does not exist.InternalServerException - The service encountered an internal error.GetPlayerConnectionStatusResult getPlayerConnectionStatus(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 - ValidationException - One of the parameters in the request is invalid.AccessDeniedException - You do not have sufficient access to perform this action.ThrottlingException - The request throughput limit was exceeded.ResourceNotFoundException - The resource specified in the request does not exist.InternalServerException - The service encountered an internal error.GetSnapshotResult getSnapshot(GetSnapshotRequest getSnapshotRequest)
Gets a copy of the game configuration in a snapshot.
getSnapshotRequest - ValidationException - One of the parameters in the request is invalid.AccessDeniedException - You do not have sufficient access to perform this action.ThrottlingException - The request throughput limit was exceeded.ResourceNotFoundException - The resource specified in the request does not exist.InternalServerException - The service encountered an internal error.GetStageResult getStage(GetStageRequest getStageRequest)
Gets information about a stage.
getStageRequest - ValidationException - One of the parameters in the request is invalid.AccessDeniedException - You do not have sufficient access to perform this action.ThrottlingException - The request throughput limit was exceeded.ResourceNotFoundException - The resource specified in the request does not exist.InternalServerException - The service encountered an internal error.GetStageDeploymentResult getStageDeployment(GetStageDeploymentRequest getStageDeploymentRequest)
Gets information about a stage deployment.
getStageDeploymentRequest - ValidationException - One of the parameters in the request is invalid.AccessDeniedException - You do not have sufficient access to perform this action.ThrottlingException - The request throughput limit was exceeded.ResourceNotFoundException - The resource specified in the request does not exist.InternalServerException - The service encountered an internal error.ImportGameConfigurationResult importGameConfiguration(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 - ValidationException - One of the parameters in the request is invalid.AccessDeniedException - You do not have sufficient access to perform this action.ThrottlingException - The request throughput limit was exceeded.ResourceNotFoundException - The resource specified in the request does not exist.InternalServerException - The service encountered an internal error.ServiceQuotaExceededException - The request would result in exceeding service quota.ListExtensionVersionsResult listExtensionVersions(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 - ValidationException - One of the parameters in the request is invalid.AccessDeniedException - You do not have sufficient access to perform this action.ThrottlingException - The request throughput limit was exceeded.ResourceNotFoundException - The resource specified in the request does not exist.InternalServerException - The service encountered an internal error.ListExtensionsResult listExtensions(ListExtensionsRequest listExtensionsRequest)
Gets a paginated list of available extensions.
Extensions provide features that games can use from scripts.
listExtensionsRequest - ValidationException - One of the parameters in the request is invalid.AccessDeniedException - You do not have sufficient access to perform this action.ThrottlingException - The request throughput limit was exceeded.InternalServerException - The service encountered an internal error.ListGamesResult listGames(ListGamesRequest listGamesRequest)
Gets a paginated list of games.
listGamesRequest - ValidationException - One of the parameters in the request is invalid.AccessDeniedException - You do not have sufficient access to perform this action.ThrottlingException - The request throughput limit was exceeded.InternalServerException - The service encountered an internal error.ListGeneratedCodeJobsResult listGeneratedCodeJobs(ListGeneratedCodeJobsRequest listGeneratedCodeJobsRequest)
Gets a paginated list of code generation jobs for a snapshot.
listGeneratedCodeJobsRequest - ValidationException - One of the parameters in the request is invalid.AccessDeniedException - You do not have sufficient access to perform this action.ThrottlingException - The request throughput limit was exceeded.ResourceNotFoundException - The resource specified in the request does not exist.InternalServerException - The service encountered an internal error.ListSnapshotsResult listSnapshots(ListSnapshotsRequest listSnapshotsRequest)
Gets a paginated list of snapshot summaries from the game.
listSnapshotsRequest - ValidationException - One of the parameters in the request is invalid.AccessDeniedException - You do not have sufficient access to perform this action.ThrottlingException - The request throughput limit was exceeded.ResourceNotFoundException - The resource specified in the request does not exist.InternalServerException - The service encountered an internal error.ListStageDeploymentsResult listStageDeployments(ListStageDeploymentsRequest listStageDeploymentsRequest)
Gets a paginated list of stage deployment summaries from the game.
listStageDeploymentsRequest - ValidationException - One of the parameters in the request is invalid.AccessDeniedException - You do not have sufficient access to perform this action.ThrottlingException - The request throughput limit was exceeded.ResourceNotFoundException - The resource specified in the request does not exist.InternalServerException - The service encountered an internal error.ListStagesResult listStages(ListStagesRequest listStagesRequest)
Gets a paginated list of stage summaries from the game.
listStagesRequest - ValidationException - One of the parameters in the request is invalid.AccessDeniedException - You do not have sufficient access to perform this action.ThrottlingException - The request throughput limit was exceeded.ResourceNotFoundException - The resource specified in the request does not exist.InternalServerException - The service encountered an internal error.ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Lists the tags associated with a GameSparks resource.
listTagsForResourceRequest - ValidationException - One of the parameters in the request is invalid.ResourceNotFoundException - The resource specified in the request does not exist.InternalServerException - The service encountered an internal error.StartGeneratedCodeJobResult startGeneratedCodeJob(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 - ValidationException - One of the parameters in the request is invalid.AccessDeniedException - You do not have sufficient access to perform this action.ThrottlingException - The request throughput limit was exceeded.ResourceNotFoundException - The resource specified in the request does not exist.InternalServerException - The service encountered an internal error.StartStageDeploymentResult startStageDeployment(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 - ValidationException - One of the parameters in the request is invalid.AccessDeniedException - You do not have sufficient access to perform this action.ThrottlingException - The request throughput limit was exceeded.ConflictException - The resource already exists, or another operation is in progress.ResourceNotFoundException - The resource specified in the request does not exist.InternalServerException - The service encountered an internal error.TagResourceResult tagResource(TagResourceRequest tagResourceRequest)
Adds tags to a GameSparks resource.
tagResourceRequest - ValidationException - One of the parameters in the request is invalid.ResourceNotFoundException - The resource specified in the request does not exist.InternalServerException - The service encountered an internal error.UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)
Removes tags from a GameSparks resource.
untagResourceRequest - ValidationException - One of the parameters in the request is invalid.ResourceNotFoundException - The resource specified in the request does not exist.InternalServerException - The service encountered an internal error.UpdateGameResult updateGame(UpdateGameRequest updateGameRequest)
Updates details of the game.
updateGameRequest - ValidationException - One of the parameters in the request is invalid.AccessDeniedException - You do not have sufficient access to perform this action.ThrottlingException - The request throughput limit was exceeded.ResourceNotFoundException - The resource specified in the request does not exist.InternalServerException - The service encountered an internal error.UpdateGameConfigurationResult updateGameConfiguration(UpdateGameConfigurationRequest updateGameConfigurationRequest)
Updates one or more sections of the game configuration.
updateGameConfigurationRequest - ValidationException - One of the parameters in the request is invalid.AccessDeniedException - You do not have sufficient access to perform this action.ThrottlingException - The request throughput limit was exceeded.ResourceNotFoundException - The resource specified in the request does not exist.InternalServerException - The service encountered an internal error.ServiceQuotaExceededException - The request would result in exceeding service quota.UpdateSnapshotResult updateSnapshot(UpdateSnapshotRequest updateSnapshotRequest)
Updates the metadata of a GameSparks snapshot.
updateSnapshotRequest - ValidationException - One of the parameters in the request is invalid.AccessDeniedException - You do not have sufficient access to perform this action.ThrottlingException - The request throughput limit was exceeded.ResourceNotFoundException - The resource specified in the request does not exist.InternalServerException - The service encountered an internal error.UpdateStageResult updateStage(UpdateStageRequest updateStageRequest)
Updates the metadata of a stage.
updateStageRequest - ValidationException - One of the parameters in the request is invalid.AccessDeniedException - You do not have sufficient access to perform this action.ThrottlingException - The request throughput limit was exceeded.ResourceNotFoundException - The resource specified in the request does not exist.InternalServerException - The service encountered an internal error.void shutdown()
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
request - The originally executed request.Copyright © 2022. All rights reserved.