Class: AWS.GameSparks
- Inherits:
-
AWS.Service
- Object
- AWS.Service
- AWS.GameSparks
- Identifier:
- gamesparks
- API Version:
- 2021-08-17
- Defined in:
- (unknown)
Overview
Constructs a service interface object. Each API operation is exposed as a function on service.
Service Description
Sending a Request Using GameSparks
var gamesparks = new AWS.GameSparks();
gamesparks.createGame(params, function (err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Locking the API Version
In order to ensure that the GameSparks object uses this specific API, you can
construct the object by passing the apiVersion
option to the constructor:
var gamesparks = new AWS.GameSparks({apiVersion: '2021-08-17'});
You can also set the API version globally in AWS.config.apiVersions
using
the gamesparks service identifier:
AWS.config.apiVersions = {
gamesparks: '2021-08-17',
// other service API versions
};
var gamesparks = new AWS.GameSparks();
Constructor Summary collapse
-
new AWS.GameSparks(options = {}) ⇒ Object
constructor
Constructs a service object.
Property Summary collapse
-
endpoint ⇒ AWS.Endpoint
readwrite
An Endpoint object representing the endpoint URL for service requests.
Properties inherited from AWS.Service
Method Summary collapse
-
createGame(params = {}, callback) ⇒ AWS.Request
Creates a new game with an empty configuration.
-
createSnapshot(params = {}, callback) ⇒ AWS.Request
Creates a snapshot of the game configuration.
.
-
createStage(params = {}, callback) ⇒ AWS.Request
Creates a new stage for stage-by-stage game development and deployment.
.
-
deleteGame(params = {}, callback) ⇒ AWS.Request
Deletes a game.
.
-
deleteStage(params = {}, callback) ⇒ AWS.Request
Deletes a stage from a game, along with the associated game runtime.
.
-
disconnectPlayer(params = {}, callback) ⇒ AWS.Request
Disconnects a player from the game runtime.
If a player has multiple connections, this operation attempts to close all of them.
-
exportSnapshot(params = {}, callback) ⇒ AWS.Request
Exports a game configuration snapshot.
.
-
getExtension(params = {}, callback) ⇒ AWS.Request
Gets details about a specified extension.
.
-
getExtensionVersion(params = {}, callback) ⇒ AWS.Request
Gets details about a specified extension version.
.
-
getGame(params = {}, callback) ⇒ AWS.Request
Gets details about a game.
.
-
getGameConfiguration(params = {}, callback) ⇒ AWS.Request
Gets the configuration of the game.
.
-
getGeneratedCodeJob(params = {}, callback) ⇒ AWS.Request
Gets details about a job that is generating code for a snapshot.
.
-
getPlayerConnectionStatus(params = {}, callback) ⇒ AWS.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.
-
getSnapshot(params = {}, callback) ⇒ AWS.Request
Gets a copy of the game configuration in a snapshot.
.
-
getStage(params = {}, callback) ⇒ AWS.Request
Gets information about a stage.
.
-
getStageDeployment(params = {}, callback) ⇒ AWS.Request
Gets information about a stage deployment.
.
-
importGameConfiguration(params = {}, callback) ⇒ AWS.Request
Imports a game configuration.
This operation replaces the current configuration of the game with the provided input.
-
listExtensions(params = {}, callback) ⇒ AWS.Request
Gets a paginated list of available extensions.
Extensions provide features that games can use from scripts.
-
listExtensionVersions(params = {}, callback) ⇒ AWS.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.
-
listGames(params = {}, callback) ⇒ AWS.Request
Gets a paginated list of games.
.
-
listGeneratedCodeJobs(params = {}, callback) ⇒ AWS.Request
Gets a paginated list of code generation jobs for a snapshot.
.
-
listSnapshots(params = {}, callback) ⇒ AWS.Request
Gets a paginated list of snapshot summaries from the game.
.
-
listStageDeployments(params = {}, callback) ⇒ AWS.Request
Gets a paginated list of stage deployment summaries from the game.
.
-
listStages(params = {}, callback) ⇒ AWS.Request
Gets a paginated list of stage summaries from the game.
.
-
listTagsForResource(params = {}, callback) ⇒ AWS.Request
Lists the tags associated with a GameSparks resource.
.
-
startGeneratedCodeJob(params = {}, callback) ⇒ AWS.Request
Starts an asynchronous process that generates client code for system-defined and custom messages.
-
startStageDeployment(params = {}, callback) ⇒ AWS.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
. -
tagResource(params = {}, callback) ⇒ AWS.Request
Adds tags to a GameSparks resource.
.
-
untagResource(params = {}, callback) ⇒ AWS.Request
Removes tags from a GameSparks resource.
.
-
updateGame(params = {}, callback) ⇒ AWS.Request
Updates details of the game.
.
-
updateGameConfiguration(params = {}, callback) ⇒ AWS.Request
Updates one or more sections of the game configuration.
.
-
updateSnapshot(params = {}, callback) ⇒ AWS.Request
Updates the metadata of a GameSparks snapshot.
.
-
updateStage(params = {}, callback) ⇒ AWS.Request
Updates the metadata of a stage.
.
Methods inherited from AWS.Service
makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService
Constructor Details
new AWS.GameSparks(options = {}) ⇒ Object
Constructs a service object. This object has one method for each API operation.
Property Details
Method Details
createGame(params = {}, callback) ⇒ AWS.Request
Creates a new game with an empty configuration. After creating your game, you can update the configuration using UpdateGameConfiguration
or ImportGameConfiguration
.
createStage(params = {}, callback) ⇒ AWS.Request
Creates a new stage for stage-by-stage game development and deployment.
deleteStage(params = {}, callback) ⇒ AWS.Request
Deletes a stage from a game, along with the associated game runtime.
disconnectPlayer(params = {}, callback) ⇒ AWS.Request
Disconnects a player from the game runtime.
If a player has multiple connections, this operation attempts to close all of them.
getExtensionVersion(params = {}, callback) ⇒ AWS.Request
Gets details about a specified extension version.
getGeneratedCodeJob(params = {}, callback) ⇒ AWS.Request
Gets details about a job that is generating code for a snapshot.
getPlayerConnectionStatus(params = {}, callback) ⇒ AWS.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.
getSnapshot(params = {}, callback) ⇒ AWS.Request
Gets a copy of the game configuration in a snapshot.
importGameConfiguration(params = {}, callback) ⇒ AWS.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.
listExtensions(params = {}, callback) ⇒ AWS.Request
Gets a paginated list of available extensions.
Extensions provide features that games can use from scripts.
listExtensionVersions(params = {}, callback) ⇒ AWS.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.
listGeneratedCodeJobs(params = {}, callback) ⇒ AWS.Request
Gets a paginated list of code generation jobs for a snapshot.
listSnapshots(params = {}, callback) ⇒ AWS.Request
Gets a paginated list of snapshot summaries from the game.
listStageDeployments(params = {}, callback) ⇒ AWS.Request
Gets a paginated list of stage deployment summaries from the game.
listStages(params = {}, callback) ⇒ AWS.Request
Gets a paginated list of stage summaries from the game.
listTagsForResource(params = {}, callback) ⇒ AWS.Request
Lists the tags associated with a GameSparks resource.
startGeneratedCodeJob(params = {}, callback) ⇒ AWS.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.
startStageDeployment(params = {}, callback) ⇒ AWS.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.