View Source AWS.GameSparks (aws-elixir v0.13.3)
Link to this section Summary
Functions
Creates a new game with an empty configuration.
Creates a snapshot of the game configuration.
Creates a new stage for stage-by-stage game development and deployment.
Deletes a game.
Deletes a stage from a game, along with the associated game runtime.
Disconnects a player from the game runtime.
Exports a game configuration snapshot.
Gets details about a specified extension.
Gets details about a specified extension version.
Gets details about a game.
Gets the configuration of the game.
Gets details about a job that is generating code for a snapshot.
Gets the status of a player's connection to the game runtime.
Gets a copy of the game configuration in a snapshot.
Gets information about a stage.
Gets information about a stage deployment.
Imports a game configuration.
Gets a paginated list of available versions for the extension.
Gets a paginated list of available extensions.
Gets a paginated list of games.
Gets a paginated list of code generation jobs for a snapshot.
Gets a paginated list of snapshot summaries from the game.
Gets a paginated list of stage deployment summaries from the game.
Gets a paginated list of stage summaries from the game.
Lists the tags associated with a GameSparks resource.
Starts an asynchronous process that generates client code for system-defined and custom messages.
Deploys a snapshot to the stage and creates a new game runtime.
Adds tags to a GameSparks resource.
Removes tags from a GameSparks resource.
Updates details of the game.
Updates one or more sections of the game configuration.
Updates the metadata of a GameSparks snapshot.
Updates the metadata of a stage.
Link to this section Functions
Creates a new game with an empty configuration.
After creating your game, you can update the configuration using
UpdateGameConfiguration
or ImportGameConfiguration
.
Creates a snapshot of the game configuration.
Creates a new stage for stage-by-stage game development and deployment.
Deletes a game.
Deletes a stage from a game, along with the associated game runtime.
disconnect_player(client, game_name, player_id, stage_name, input, options \\ [])
View SourceDisconnects a player from the game runtime.
If a player has multiple connections, this operation attempts to close all of them.
Exports a game configuration snapshot.
Gets details about a specified extension.
get_extension_version(client, extension_version, name, namespace, options \\ [])
View SourceGets details about a specified extension version.
Gets details about a game.
get_game_configuration(client, game_name, sections \\ nil, options \\ [])
View SourceGets the configuration of the game.
get_generated_code_job(client, game_name, job_id, snapshot_id, options \\ [])
View SourceGets details about a job that is generating code for a snapshot.
get_player_connection_status(client, game_name, player_id, stage_name, options \\ [])
View SourceGets 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.
get_snapshot(client, game_name, snapshot_id, sections \\ nil, options \\ [])
View SourceGets a copy of the game configuration in a snapshot.
Gets information about a stage.
get_stage_deployment(client, game_name, stage_name, deployment_id \\ nil, options \\ [])
View SourceGets information about a stage deployment.
import_game_configuration(client, game_name, input, options \\ [])
View SourceImports 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.
list_extension_versions(client, name, namespace, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceGets 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.
list_extensions(client, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceGets a paginated list of available extensions.
Extensions provide features that games can use from scripts.
list_games(client, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceGets a paginated list of games.
list_generated_code_jobs(client, game_name, snapshot_id, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceGets a paginated list of code generation jobs for a snapshot.
list_snapshots(client, game_name, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceGets a paginated list of snapshot summaries from the game.
list_stage_deployments(client, game_name, stage_name, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceGets a paginated list of stage deployment summaries from the game.
list_stages(client, game_name, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceGets a paginated list of stage summaries from the game.
Lists the tags associated with a GameSparks resource.
start_generated_code_job(client, game_name, snapshot_id, input, options \\ [])
View SourceStarts 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.
start_stage_deployment(client, game_name, stage_name, input, options \\ [])
View SourceDeploys 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.
Adds tags to a GameSparks resource.
Removes tags from a GameSparks resource.
Updates details of the game.
update_game_configuration(client, game_name, input, options \\ [])
View SourceUpdates one or more sections of the game configuration.
update_snapshot(client, game_name, snapshot_id, input, options \\ [])
View SourceUpdates the metadata of a GameSparks snapshot.
Updates the metadata of a stage.