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 stage from a game, along with the associated game runtime.

Gets details about a specified extension.

Gets details about a 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 a paginated list of snapshot 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 one or more sections of the game configuration.

Updates the metadata of a GameSparks snapshot.

Link to this section Functions

Link to this function

create_game(client, input, options \\ [])

View Source

Creates a new game with an empty configuration.

After creating your game, you can update the configuration using UpdateGameConfiguration or ImportGameConfiguration.

Link to this function

create_snapshot(client, game_name, input, options \\ [])

View Source

Creates a snapshot of the game configuration.

Link to this function

create_stage(client, game_name, input, options \\ [])

View Source

Creates a new stage for stage-by-stage game development and deployment.

Link to this function

delete_game(client, game_name, input, options \\ [])

View Source

Deletes a game.

Link to this function

delete_stage(client, game_name, stage_name, input, options \\ [])

View Source

Deletes a stage from a game, along with the associated game runtime.

Link to this function

disconnect_player(client, game_name, player_id, stage_name, input, options \\ [])

View Source

Disconnects a player from the game runtime.

If a player has multiple connections, this operation attempts to close all of them.

Link to this function

export_snapshot(client, game_name, snapshot_id, options \\ [])

View Source

Exports a game configuration snapshot.

Link to this function

get_extension(client, name, namespace, options \\ [])

View Source

Gets details about a specified extension.

Link to this function

get_extension_version(client, extension_version, name, namespace, options \\ [])

View Source

Gets details about a specified extension version.

Link to this function

get_game(client, game_name, options \\ [])

View Source

Gets details about a game.

Link to this function

get_game_configuration(client, game_name, sections \\ nil, options \\ [])

View Source

Gets the configuration of the game.

Link to this function

get_generated_code_job(client, game_name, job_id, snapshot_id, options \\ [])

View Source

Gets details about a job that is generating code for a snapshot.

Link to this function

get_player_connection_status(client, game_name, player_id, stage_name, options \\ [])

View Source

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.

Link to this function

get_snapshot(client, game_name, snapshot_id, sections \\ nil, options \\ [])

View Source

Gets a copy of the game configuration in a snapshot.

Link to this function

get_stage(client, game_name, stage_name, options \\ [])

View Source

Gets information about a stage.

Link to this function

get_stage_deployment(client, game_name, stage_name, deployment_id \\ nil, options \\ [])

View Source

Gets information about a stage deployment.

Link to this function

import_game_configuration(client, game_name, input, options \\ [])

View Source

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.

Link to this function

list_extension_versions(client, name, namespace, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

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.

Link to this function

list_extensions(client, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Gets a paginated list of available extensions.

Extensions provide features that games can use from scripts.

Link to this function

list_games(client, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Gets a paginated list of games.

Link to this function

list_generated_code_jobs(client, game_name, snapshot_id, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Gets a paginated list of code generation jobs for a snapshot.

Link to this function

list_snapshots(client, game_name, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Gets a paginated list of snapshot summaries from the game.

Link to this function

list_stage_deployments(client, game_name, stage_name, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Gets a paginated list of stage deployment summaries from the game.

Link to this function

list_stages(client, game_name, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Gets a paginated list of stage summaries from the game.

Link to this function

list_tags_for_resource(client, resource_arn, options \\ [])

View Source

Lists the tags associated with a GameSparks resource.

Link to this function

start_generated_code_job(client, game_name, snapshot_id, input, options \\ [])

View Source

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.

Link to this function

start_stage_deployment(client, game_name, stage_name, input, options \\ [])

View Source

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.

Link to this function

tag_resource(client, resource_arn, input, options \\ [])

View Source

Adds tags to a GameSparks resource.

Link to this function

untag_resource(client, resource_arn, input, options \\ [])

View Source

Removes tags from a GameSparks resource.

Link to this function

update_game(client, game_name, input, options \\ [])

View Source

Updates details of the game.

Link to this function

update_game_configuration(client, game_name, input, options \\ [])

View Source

Updates one or more sections of the game configuration.

Link to this function

update_snapshot(client, game_name, snapshot_id, input, options \\ [])

View Source

Updates the metadata of a GameSparks snapshot.

Link to this function

update_stage(client, game_name, stage_name, input, options \\ [])

View Source

Updates the metadata of a stage.