@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AWSGameSparksClient extends AmazonWebServiceClient implements AWSGameSparks
| Modifier and Type | Field and Description |
|---|---|
protected static ClientConfigurationFactory |
configFactory
Client configuration factory providing ClientConfigurations tailored to this client
|
client, clientConfiguration, endpoint, isEndpointOverridden, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffsetENDPOINT_PREFIX| Modifier and Type | Method and Description |
|---|---|
static AWSGameSparksClientBuilder |
builder() |
CreateGameResult |
createGame(CreateGameRequest request)
Creates a new game with an empty configuration.
|
CreateSnapshotResult |
createSnapshot(CreateSnapshotRequest request)
Creates a snapshot of the game configuration.
|
CreateStageResult |
createStage(CreateStageRequest request)
Creates a new stage for stage-by-stage game development and deployment.
|
DeleteGameResult |
deleteGame(DeleteGameRequest request)
Deletes a game.
|
DeleteStageResult |
deleteStage(DeleteStageRequest request)
Deletes a stage from a game, along with the associated game runtime.
|
DisconnectPlayerResult |
disconnectPlayer(DisconnectPlayerRequest request)
Disconnects a player from the game runtime.
|
ExportSnapshotResult |
exportSnapshot(ExportSnapshotRequest request)
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 request)
Gets details about a specified extension.
|
GetExtensionVersionResult |
getExtensionVersion(GetExtensionVersionRequest request)
Gets details about a specified extension version.
|
GetGameResult |
getGame(GetGameRequest request)
Gets details about a game.
|
GetGameConfigurationResult |
getGameConfiguration(GetGameConfigurationRequest request)
Gets the configuration of the game.
|
GetGeneratedCodeJobResult |
getGeneratedCodeJob(GetGeneratedCodeJobRequest request)
Gets details about a job that is generating code for a snapshot.
|
GetPlayerConnectionStatusResult |
getPlayerConnectionStatus(GetPlayerConnectionStatusRequest request)
Gets the status of a player's connection to the game runtime.
|
GetSnapshotResult |
getSnapshot(GetSnapshotRequest request)
Gets a copy of the game configuration in a snapshot.
|
GetStageResult |
getStage(GetStageRequest request)
Gets information about a stage.
|
GetStageDeploymentResult |
getStageDeployment(GetStageDeploymentRequest request)
Gets information about a stage deployment.
|
ImportGameConfigurationResult |
importGameConfiguration(ImportGameConfigurationRequest request)
Imports a game configuration.
|
ListExtensionsResult |
listExtensions(ListExtensionsRequest request)
Gets a paginated list of available extensions.
|
ListExtensionVersionsResult |
listExtensionVersions(ListExtensionVersionsRequest request)
Gets a paginated list of available versions for the extension.
|
ListGamesResult |
listGames(ListGamesRequest request)
Gets a paginated list of games.
|
ListGeneratedCodeJobsResult |
listGeneratedCodeJobs(ListGeneratedCodeJobsRequest request)
Gets a paginated list of code generation jobs for a snapshot.
|
ListSnapshotsResult |
listSnapshots(ListSnapshotsRequest request)
Gets a paginated list of snapshot summaries from the game.
|
ListStageDeploymentsResult |
listStageDeployments(ListStageDeploymentsRequest request)
Gets a paginated list of stage deployment summaries from the game.
|
ListStagesResult |
listStages(ListStagesRequest request)
Gets a paginated list of stage summaries from the game.
|
ListTagsForResourceResult |
listTagsForResource(ListTagsForResourceRequest request)
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 request)
Starts an asynchronous process that generates client code for system-defined and custom messages.
|
StartStageDeploymentResult |
startStageDeployment(StartStageDeploymentRequest request)
Deploys a snapshot to the stage and creates a new game runtime.
|
TagResourceResult |
tagResource(TagResourceRequest request)
Adds tags to a GameSparks resource.
|
UntagResourceResult |
untagResource(UntagResourceRequest request)
Removes tags from a GameSparks resource.
|
UpdateGameResult |
updateGame(UpdateGameRequest request)
Updates details of the game.
|
UpdateGameConfigurationResult |
updateGameConfiguration(UpdateGameConfigurationRequest request)
Updates one or more sections of the game configuration.
|
UpdateSnapshotResult |
updateSnapshot(UpdateSnapshotRequest request)
Updates the metadata of a GameSparks snapshot.
|
UpdateStageResult |
updateStage(UpdateStageRequest request)
Updates the metadata of a stage.
|
addRequestHandler, addRequestHandler, beforeClientExecution, beforeMarshalling, calculateCRC32FromCompressedData, checkMutability, configureRegion, createExecutionContext, createExecutionContext, createExecutionContext, createSignerProvider, endClientExecution, endClientExecution, getClientConfiguration, getClientId, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerOverride, getSignerProvider, getSignerRegionOverride, getSigningRegion, getTimeOffset, isCsmEnabled, isEndpointOverridden, isProfilingEnabled, isRequestMetricsEnabled, makeImmutable, removeRequestHandler, removeRequestHandler, requestMetricCollector, setEndpoint, setEndpoint, setEndpointPrefix, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shouldGenerateClientSideMonitoringEvents, useStrictHostNameVerification, withEndpoint, withRegion, withRegion, withTimeOffsetprotected static final ClientConfigurationFactory configFactory
public static AWSGameSparksClientBuilder builder()
public CreateGameResult createGame(CreateGameRequest request)
Creates a new game with an empty configuration. After creating your game, you can update the configuration using
UpdateGameConfiguration or ImportGameConfiguration.
createGame in interface AWSGameSparkscreateGameRequest - 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.public CreateSnapshotResult createSnapshot(CreateSnapshotRequest request)
Creates a snapshot of the game configuration.
createSnapshot in interface AWSGameSparkscreateSnapshotRequest - 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.public CreateStageResult createStage(CreateStageRequest request)
Creates a new stage for stage-by-stage game development and deployment.
createStage in interface AWSGameSparkscreateStageRequest - 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.public DeleteGameResult deleteGame(DeleteGameRequest request)
Deletes a game.
deleteGame in interface AWSGameSparksdeleteGameRequest - 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.public DeleteStageResult deleteStage(DeleteStageRequest request)
Deletes a stage from a game, along with the associated game runtime.
deleteStage in interface AWSGameSparksdeleteStageRequest - 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.public DisconnectPlayerResult disconnectPlayer(DisconnectPlayerRequest request)
Disconnects a player from the game runtime.
If a player has multiple connections, this operation attempts to close all of them.
disconnectPlayer in interface AWSGameSparksdisconnectPlayerRequest - 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.public ExportSnapshotResult exportSnapshot(ExportSnapshotRequest request)
Exports a game configuration snapshot.
exportSnapshot in interface AWSGameSparksexportSnapshotRequest - 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.public GetExtensionResult getExtension(GetExtensionRequest request)
Gets details about a specified extension.
getExtension in interface AWSGameSparksgetExtensionRequest - 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.public GetExtensionVersionResult getExtensionVersion(GetExtensionVersionRequest request)
Gets details about a specified extension version.
getExtensionVersion in interface AWSGameSparksgetExtensionVersionRequest - 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.public GetGameResult getGame(GetGameRequest request)
Gets details about a game.
getGame in interface AWSGameSparksgetGameRequest - 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.public GetGameConfigurationResult getGameConfiguration(GetGameConfigurationRequest request)
Gets the configuration of the game.
getGameConfiguration in interface AWSGameSparksgetGameConfigurationRequest - 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.public GetGeneratedCodeJobResult getGeneratedCodeJob(GetGeneratedCodeJobRequest request)
Gets details about a job that is generating code for a snapshot.
getGeneratedCodeJob in interface AWSGameSparksgetGeneratedCodeJobRequest - 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.public GetPlayerConnectionStatusResult getPlayerConnectionStatus(GetPlayerConnectionStatusRequest request)
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.
getPlayerConnectionStatus in interface AWSGameSparksgetPlayerConnectionStatusRequest - 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.public GetSnapshotResult getSnapshot(GetSnapshotRequest request)
Gets a copy of the game configuration in a snapshot.
getSnapshot in interface AWSGameSparksgetSnapshotRequest - 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.public GetStageResult getStage(GetStageRequest request)
Gets information about a stage.
getStage in interface AWSGameSparksgetStageRequest - 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.public GetStageDeploymentResult getStageDeployment(GetStageDeploymentRequest request)
Gets information about a stage deployment.
getStageDeployment in interface AWSGameSparksgetStageDeploymentRequest - 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.public ImportGameConfigurationResult importGameConfiguration(ImportGameConfigurationRequest request)
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.
importGameConfiguration in interface AWSGameSparksimportGameConfigurationRequest - 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.public ListExtensionVersionsResult listExtensionVersions(ListExtensionVersionsRequest request)
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.
listExtensionVersions in interface AWSGameSparkslistExtensionVersionsRequest - 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.public ListExtensionsResult listExtensions(ListExtensionsRequest request)
Gets a paginated list of available extensions.
Extensions provide features that games can use from scripts.
listExtensions in interface AWSGameSparkslistExtensionsRequest - 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.public ListGamesResult listGames(ListGamesRequest request)
Gets a paginated list of games.
listGames in interface AWSGameSparkslistGamesRequest - 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.public ListGeneratedCodeJobsResult listGeneratedCodeJobs(ListGeneratedCodeJobsRequest request)
Gets a paginated list of code generation jobs for a snapshot.
listGeneratedCodeJobs in interface AWSGameSparkslistGeneratedCodeJobsRequest - 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.public ListSnapshotsResult listSnapshots(ListSnapshotsRequest request)
Gets a paginated list of snapshot summaries from the game.
listSnapshots in interface AWSGameSparkslistSnapshotsRequest - 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.public ListStageDeploymentsResult listStageDeployments(ListStageDeploymentsRequest request)
Gets a paginated list of stage deployment summaries from the game.
listStageDeployments in interface AWSGameSparkslistStageDeploymentsRequest - 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.public ListStagesResult listStages(ListStagesRequest request)
Gets a paginated list of stage summaries from the game.
listStages in interface AWSGameSparkslistStagesRequest - 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.public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
Lists the tags associated with a GameSparks resource.
listTagsForResource in interface AWSGameSparkslistTagsForResourceRequest - 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.public StartGeneratedCodeJobResult startGeneratedCodeJob(StartGeneratedCodeJobRequest request)
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.
startGeneratedCodeJob in interface AWSGameSparksstartGeneratedCodeJobRequest - 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.public StartStageDeploymentResult startStageDeployment(StartStageDeploymentRequest request)
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.
startStageDeployment in interface AWSGameSparksstartStageDeploymentRequest - 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.public TagResourceResult tagResource(TagResourceRequest request)
Adds tags to a GameSparks resource.
tagResource in interface AWSGameSparkstagResourceRequest - 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.public UntagResourceResult untagResource(UntagResourceRequest request)
Removes tags from a GameSparks resource.
untagResource in interface AWSGameSparksuntagResourceRequest - 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.public UpdateGameResult updateGame(UpdateGameRequest request)
Updates details of the game.
updateGame in interface AWSGameSparksupdateGameRequest - 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.public UpdateGameConfigurationResult updateGameConfiguration(UpdateGameConfigurationRequest request)
Updates one or more sections of the game configuration.
updateGameConfiguration in interface AWSGameSparksupdateGameConfigurationRequest - 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.public UpdateSnapshotResult updateSnapshot(UpdateSnapshotRequest request)
Updates the metadata of a GameSparks snapshot.
updateSnapshot in interface AWSGameSparksupdateSnapshotRequest - 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.public UpdateStageResult updateStage(UpdateStageRequest request)
Updates the metadata of a stage.
updateStage in interface AWSGameSparksupdateStageRequest - 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.public 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 the request.
getCachedResponseMetadata in interface AWSGameSparksrequest - The originally executed requestpublic void shutdown()
AWSGameSparksshutdown in interface AWSGameSparksshutdown in class AmazonWebServiceClientCopyright © 2022. All rights reserved.