Skip to content

GameSparksClient#

Index > GameSparks > GameSparksClient

Auto-generated documentation for GameSparks type annotations stubs module mypy-boto3-gamesparks.

GameSparksClient#

Type annotations and code completion for boto3.client("gamesparks"). boto3 documentation

# GameSparksClient usage example

from boto3.session import Session
from mypy_boto3_gamesparks.client import GameSparksClient

def get_gamesparks_client() -> GameSparksClient:
    return Session().client("gamesparks")

Exceptions#

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("gamesparks").exceptions structure.

# Exceptions.exceptions usage example

client = boto3.client("gamesparks")

try:
    do_something(client)
except (
    client.exceptions.AccessDeniedException,
    client.exceptions.ClientError,
    client.exceptions.ConflictException,
    client.exceptions.InternalServerException,
    client.exceptions.ResourceNotFoundException,
    client.exceptions.ServiceQuotaExceededException,
    client.exceptions.ThrottlingException,
    client.exceptions.ValidationException,
) as e:
    print(e)
# Exceptions.exceptions type checking example

from mypy_boto3_gamesparks.client import Exceptions

def handle_error(exc: Exceptions.AccessDeniedException) -> None:
    ...

Methods#

can_paginate#

Check if an operation can be paginated.

Type annotations and code completion for boto3.client("gamesparks").can_paginate method. boto3 documentation

# can_paginate method definition

def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

close#

Closes underlying endpoint connections.

Type annotations and code completion for boto3.client("gamesparks").close method. boto3 documentation

# close method definition

def close(
    self,
) -> None:
    ...

create_game#

Creates a new game with an empty configuration.

Type annotations and code completion for boto3.client("gamesparks").create_game method. boto3 documentation

# create_game method definition

def create_game(
    self,
    *,
    GameName: str,
    ClientToken: str = ...,
    Description: str = ...,
    Tags: Mapping[str, str] = ...,
) -> CreateGameResultTypeDef:  # (1)
    ...
  1. See CreateGameResultTypeDef 
# create_game method usage example with argument unpacking

kwargs: CreateGameRequestRequestTypeDef = {  # (1)
    "GameName": ...,
}

parent.create_game(**kwargs)
  1. See CreateGameRequestRequestTypeDef

create_snapshot#

Creates a snapshot of the game configuration.

Type annotations and code completion for boto3.client("gamesparks").create_snapshot method. boto3 documentation

# create_snapshot method definition

def create_snapshot(
    self,
    *,
    GameName: str,
    Description: str = ...,
) -> CreateSnapshotResultTypeDef:  # (1)
    ...
  1. See CreateSnapshotResultTypeDef 
# create_snapshot method usage example with argument unpacking

kwargs: CreateSnapshotRequestRequestTypeDef = {  # (1)
    "GameName": ...,
}

parent.create_snapshot(**kwargs)
  1. See CreateSnapshotRequestRequestTypeDef

create_stage#

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

Type annotations and code completion for boto3.client("gamesparks").create_stage method. boto3 documentation

# create_stage method definition

def create_stage(
    self,
    *,
    GameName: str,
    Role: str,
    StageName: str,
    ClientToken: str = ...,
    Description: str = ...,
    Tags: Mapping[str, str] = ...,
) -> CreateStageResultTypeDef:  # (1)
    ...
  1. See CreateStageResultTypeDef 
# create_stage method usage example with argument unpacking

kwargs: CreateStageRequestRequestTypeDef = {  # (1)
    "GameName": ...,
    "Role": ...,
    "StageName": ...,
}

parent.create_stage(**kwargs)
  1. See CreateStageRequestRequestTypeDef

delete_game#

Deletes a game.

Type annotations and code completion for boto3.client("gamesparks").delete_game method. boto3 documentation

# delete_game method definition

def delete_game(
    self,
    *,
    GameName: str,
) -> Dict[str, Any]:
    ...
# delete_game method usage example with argument unpacking

kwargs: DeleteGameRequestRequestTypeDef = {  # (1)
    "GameName": ...,
}

parent.delete_game(**kwargs)
  1. See DeleteGameRequestRequestTypeDef

delete_stage#

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

Type annotations and code completion for boto3.client("gamesparks").delete_stage method. boto3 documentation

# delete_stage method definition

def delete_stage(
    self,
    *,
    GameName: str,
    StageName: str,
) -> Dict[str, Any]:
    ...
# delete_stage method usage example with argument unpacking

kwargs: DeleteStageRequestRequestTypeDef = {  # (1)
    "GameName": ...,
    "StageName": ...,
}

parent.delete_stage(**kwargs)
  1. See DeleteStageRequestRequestTypeDef

disconnect_player#

Disconnects a player from the game runtime.

Type annotations and code completion for boto3.client("gamesparks").disconnect_player method. boto3 documentation

# disconnect_player method definition

def disconnect_player(
    self,
    *,
    GameName: str,
    PlayerId: str,
    StageName: str,
) -> DisconnectPlayerResultTypeDef:  # (1)
    ...
  1. See DisconnectPlayerResultTypeDef 
# disconnect_player method usage example with argument unpacking

kwargs: DisconnectPlayerRequestRequestTypeDef = {  # (1)
    "GameName": ...,
    "PlayerId": ...,
    "StageName": ...,
}

parent.disconnect_player(**kwargs)
  1. See DisconnectPlayerRequestRequestTypeDef

export_snapshot#

Exports a game configuration snapshot.

Type annotations and code completion for boto3.client("gamesparks").export_snapshot method. boto3 documentation

# export_snapshot method definition

def export_snapshot(
    self,
    *,
    GameName: str,
    SnapshotId: str,
) -> ExportSnapshotResultTypeDef:  # (1)
    ...
  1. See ExportSnapshotResultTypeDef 
# export_snapshot method usage example with argument unpacking

kwargs: ExportSnapshotRequestRequestTypeDef = {  # (1)
    "GameName": ...,
    "SnapshotId": ...,
}

parent.export_snapshot(**kwargs)
  1. See ExportSnapshotRequestRequestTypeDef

generate_presigned_url#

Generate a presigned url given a client, its method, and arguments.

Type annotations and code completion for boto3.client("gamesparks").generate_presigned_url method. boto3 documentation

# generate_presigned_url method definition

def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

get_extension#

Gets details about a specified extension.

Type annotations and code completion for boto3.client("gamesparks").get_extension method. boto3 documentation

# get_extension method definition

def get_extension(
    self,
    *,
    Name: str,
    Namespace: str,
) -> GetExtensionResultTypeDef:  # (1)
    ...
  1. See GetExtensionResultTypeDef 
# get_extension method usage example with argument unpacking

kwargs: GetExtensionRequestRequestTypeDef = {  # (1)
    "Name": ...,
    "Namespace": ...,
}

parent.get_extension(**kwargs)
  1. See GetExtensionRequestRequestTypeDef

get_extension_version#

Gets details about a specified extension version.

Type annotations and code completion for boto3.client("gamesparks").get_extension_version method. boto3 documentation

# get_extension_version method definition

def get_extension_version(
    self,
    *,
    ExtensionVersion: str,
    Name: str,
    Namespace: str,
) -> GetExtensionVersionResultTypeDef:  # (1)
    ...
  1. See GetExtensionVersionResultTypeDef 
# get_extension_version method usage example with argument unpacking

kwargs: GetExtensionVersionRequestRequestTypeDef = {  # (1)
    "ExtensionVersion": ...,
    "Name": ...,
    "Namespace": ...,
}

parent.get_extension_version(**kwargs)
  1. See GetExtensionVersionRequestRequestTypeDef

get_game#

Gets details about a game.

Type annotations and code completion for boto3.client("gamesparks").get_game method. boto3 documentation

# get_game method definition

def get_game(
    self,
    *,
    GameName: str,
) -> GetGameResultTypeDef:  # (1)
    ...
  1. See GetGameResultTypeDef 
# get_game method usage example with argument unpacking

kwargs: GetGameRequestRequestTypeDef = {  # (1)
    "GameName": ...,
}

parent.get_game(**kwargs)
  1. See GetGameRequestRequestTypeDef

get_game_configuration#

Gets the configuration of the game.

Type annotations and code completion for boto3.client("gamesparks").get_game_configuration method. boto3 documentation

# get_game_configuration method definition

def get_game_configuration(
    self,
    *,
    GameName: str,
    Sections: Sequence[str] = ...,
) -> GetGameConfigurationResultTypeDef:  # (1)
    ...
  1. See GetGameConfigurationResultTypeDef 
# get_game_configuration method usage example with argument unpacking

kwargs: GetGameConfigurationRequestRequestTypeDef = {  # (1)
    "GameName": ...,
}

parent.get_game_configuration(**kwargs)
  1. See GetGameConfigurationRequestRequestTypeDef

get_generated_code_job#

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

Type annotations and code completion for boto3.client("gamesparks").get_generated_code_job method. boto3 documentation

# get_generated_code_job method definition

def get_generated_code_job(
    self,
    *,
    GameName: str,
    JobId: str,
    SnapshotId: str,
) -> GetGeneratedCodeJobResultTypeDef:  # (1)
    ...
  1. See GetGeneratedCodeJobResultTypeDef 
# get_generated_code_job method usage example with argument unpacking

kwargs: GetGeneratedCodeJobRequestRequestTypeDef = {  # (1)
    "GameName": ...,
    "JobId": ...,
    "SnapshotId": ...,
}

parent.get_generated_code_job(**kwargs)
  1. See GetGeneratedCodeJobRequestRequestTypeDef

get_player_connection_status#

Gets the status of a player's connection to the game runtime.

Type annotations and code completion for boto3.client("gamesparks").get_player_connection_status method. boto3 documentation

# get_player_connection_status method definition

def get_player_connection_status(
    self,
    *,
    GameName: str,
    PlayerId: str,
    StageName: str,
) -> GetPlayerConnectionStatusResultTypeDef:  # (1)
    ...
  1. See GetPlayerConnectionStatusResultTypeDef 
# get_player_connection_status method usage example with argument unpacking

kwargs: GetPlayerConnectionStatusRequestRequestTypeDef = {  # (1)
    "GameName": ...,
    "PlayerId": ...,
    "StageName": ...,
}

parent.get_player_connection_status(**kwargs)
  1. See GetPlayerConnectionStatusRequestRequestTypeDef

get_snapshot#

Gets a copy of the game configuration in a snapshot.

Type annotations and code completion for boto3.client("gamesparks").get_snapshot method. boto3 documentation

# get_snapshot method definition

def get_snapshot(
    self,
    *,
    GameName: str,
    SnapshotId: str,
    Sections: Sequence[str] = ...,
) -> GetSnapshotResultTypeDef:  # (1)
    ...
  1. See GetSnapshotResultTypeDef 
# get_snapshot method usage example with argument unpacking

kwargs: GetSnapshotRequestRequestTypeDef = {  # (1)
    "GameName": ...,
    "SnapshotId": ...,
}

parent.get_snapshot(**kwargs)
  1. See GetSnapshotRequestRequestTypeDef

get_stage#

Gets information about a stage.

Type annotations and code completion for boto3.client("gamesparks").get_stage method. boto3 documentation

# get_stage method definition

def get_stage(
    self,
    *,
    GameName: str,
    StageName: str,
) -> GetStageResultTypeDef:  # (1)
    ...
  1. See GetStageResultTypeDef 
# get_stage method usage example with argument unpacking

kwargs: GetStageRequestRequestTypeDef = {  # (1)
    "GameName": ...,
    "StageName": ...,
}

parent.get_stage(**kwargs)
  1. See GetStageRequestRequestTypeDef

get_stage_deployment#

Gets information about a stage deployment.

Type annotations and code completion for boto3.client("gamesparks").get_stage_deployment method. boto3 documentation

# get_stage_deployment method definition

def get_stage_deployment(
    self,
    *,
    GameName: str,
    StageName: str,
    DeploymentId: str = ...,
) -> GetStageDeploymentResultTypeDef:  # (1)
    ...
  1. See GetStageDeploymentResultTypeDef 
# get_stage_deployment method usage example with argument unpacking

kwargs: GetStageDeploymentRequestRequestTypeDef = {  # (1)
    "GameName": ...,
    "StageName": ...,
}

parent.get_stage_deployment(**kwargs)
  1. See GetStageDeploymentRequestRequestTypeDef

import_game_configuration#

Imports a game configuration.

Type annotations and code completion for boto3.client("gamesparks").import_game_configuration method. boto3 documentation

# import_game_configuration method definition

def import_game_configuration(
    self,
    *,
    GameName: str,
    ImportSource: ImportGameConfigurationSourceTypeDef,  # (1)
) -> ImportGameConfigurationResultTypeDef:  # (2)
    ...
  1. See ImportGameConfigurationSourceTypeDef
  2. See ImportGameConfigurationResultTypeDef 
# import_game_configuration method usage example with argument unpacking

kwargs: ImportGameConfigurationRequestRequestTypeDef = {  # (1)
    "GameName": ...,
    "ImportSource": ...,
}

parent.import_game_configuration(**kwargs)
  1. See ImportGameConfigurationRequestRequestTypeDef

list_extension_versions#

Gets a paginated list of available versions for the extension.

Type annotations and code completion for boto3.client("gamesparks").list_extension_versions method. boto3 documentation

# list_extension_versions method definition

def list_extension_versions(
    self,
    *,
    Name: str,
    Namespace: str,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListExtensionVersionsResultTypeDef:  # (1)
    ...
  1. See ListExtensionVersionsResultTypeDef 
# list_extension_versions method usage example with argument unpacking

kwargs: ListExtensionVersionsRequestRequestTypeDef = {  # (1)
    "Name": ...,
    "Namespace": ...,
}

parent.list_extension_versions(**kwargs)
  1. See ListExtensionVersionsRequestRequestTypeDef

list_extensions#

Gets a paginated list of available extensions.

Type annotations and code completion for boto3.client("gamesparks").list_extensions method. boto3 documentation

# list_extensions method definition

def list_extensions(
    self,
    *,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListExtensionsResultTypeDef:  # (1)
    ...
  1. See ListExtensionsResultTypeDef 
# list_extensions method usage example with argument unpacking

kwargs: ListExtensionsRequestRequestTypeDef = {  # (1)
    "MaxResults": ...,
}

parent.list_extensions(**kwargs)
  1. See ListExtensionsRequestRequestTypeDef

list_games#

Gets a paginated list of games.

Type annotations and code completion for boto3.client("gamesparks").list_games method. boto3 documentation

# list_games method definition

def list_games(
    self,
    *,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListGamesResultTypeDef:  # (1)
    ...
  1. See ListGamesResultTypeDef 
# list_games method usage example with argument unpacking

kwargs: ListGamesRequestRequestTypeDef = {  # (1)
    "MaxResults": ...,
}

parent.list_games(**kwargs)
  1. See ListGamesRequestRequestTypeDef

list_generated_code_jobs#

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

Type annotations and code completion for boto3.client("gamesparks").list_generated_code_jobs method. boto3 documentation

# list_generated_code_jobs method definition

def list_generated_code_jobs(
    self,
    *,
    GameName: str,
    SnapshotId: str,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListGeneratedCodeJobsResultTypeDef:  # (1)
    ...
  1. See ListGeneratedCodeJobsResultTypeDef 
# list_generated_code_jobs method usage example with argument unpacking

kwargs: ListGeneratedCodeJobsRequestRequestTypeDef = {  # (1)
    "GameName": ...,
    "SnapshotId": ...,
}

parent.list_generated_code_jobs(**kwargs)
  1. See ListGeneratedCodeJobsRequestRequestTypeDef

list_snapshots#

Gets a paginated list of snapshot summaries from the game.

Type annotations and code completion for boto3.client("gamesparks").list_snapshots method. boto3 documentation

# list_snapshots method definition

def list_snapshots(
    self,
    *,
    GameName: str,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListSnapshotsResultTypeDef:  # (1)
    ...
  1. See ListSnapshotsResultTypeDef 
# list_snapshots method usage example with argument unpacking

kwargs: ListSnapshotsRequestRequestTypeDef = {  # (1)
    "GameName": ...,
}

parent.list_snapshots(**kwargs)
  1. See ListSnapshotsRequestRequestTypeDef

list_stage_deployments#

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

Type annotations and code completion for boto3.client("gamesparks").list_stage_deployments method. boto3 documentation

# list_stage_deployments method definition

def list_stage_deployments(
    self,
    *,
    GameName: str,
    StageName: str,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListStageDeploymentsResultTypeDef:  # (1)
    ...
  1. See ListStageDeploymentsResultTypeDef 
# list_stage_deployments method usage example with argument unpacking

kwargs: ListStageDeploymentsRequestRequestTypeDef = {  # (1)
    "GameName": ...,
    "StageName": ...,
}

parent.list_stage_deployments(**kwargs)
  1. See ListStageDeploymentsRequestRequestTypeDef

list_stages#

Gets a paginated list of stage summaries from the game.

Type annotations and code completion for boto3.client("gamesparks").list_stages method. boto3 documentation

# list_stages method definition

def list_stages(
    self,
    *,
    GameName: str,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListStagesResultTypeDef:  # (1)
    ...
  1. See ListStagesResultTypeDef 
# list_stages method usage example with argument unpacking

kwargs: ListStagesRequestRequestTypeDef = {  # (1)
    "GameName": ...,
}

parent.list_stages(**kwargs)
  1. See ListStagesRequestRequestTypeDef

list_tags_for_resource#

Lists the tags associated with a GameSparks resource.

Type annotations and code completion for boto3.client("gamesparks").list_tags_for_resource method. boto3 documentation

# list_tags_for_resource method definition

def list_tags_for_resource(
    self,
    *,
    ResourceArn: str,
) -> ListTagsForResourceResultTypeDef:  # (1)
    ...
  1. See ListTagsForResourceResultTypeDef 
# list_tags_for_resource method usage example with argument unpacking

kwargs: ListTagsForResourceRequestRequestTypeDef = {  # (1)
    "ResourceArn": ...,
}

parent.list_tags_for_resource(**kwargs)
  1. See ListTagsForResourceRequestRequestTypeDef

start_generated_code_job#

Starts an asynchronous process that generates client code for system-defined and custom messages.

Type annotations and code completion for boto3.client("gamesparks").start_generated_code_job method. boto3 documentation

# start_generated_code_job method definition

def start_generated_code_job(
    self,
    *,
    GameName: str,
    Generator: GeneratorTypeDef,  # (1)
    SnapshotId: str,
) -> StartGeneratedCodeJobResultTypeDef:  # (2)
    ...
  1. See GeneratorTypeDef
  2. See StartGeneratedCodeJobResultTypeDef 
# start_generated_code_job method usage example with argument unpacking

kwargs: StartGeneratedCodeJobRequestRequestTypeDef = {  # (1)
    "GameName": ...,
    "Generator": ...,
    "SnapshotId": ...,
}

parent.start_generated_code_job(**kwargs)
  1. See StartGeneratedCodeJobRequestRequestTypeDef

start_stage_deployment#

Deploys a snapshot to the stage and creates a new game runtime.

Type annotations and code completion for boto3.client("gamesparks").start_stage_deployment method. boto3 documentation

# start_stage_deployment method definition

def start_stage_deployment(
    self,
    *,
    GameName: str,
    SnapshotId: str,
    StageName: str,
    ClientToken: str = ...,
) -> StartStageDeploymentResultTypeDef:  # (1)
    ...
  1. See StartStageDeploymentResultTypeDef 
# start_stage_deployment method usage example with argument unpacking

kwargs: StartStageDeploymentRequestRequestTypeDef = {  # (1)
    "GameName": ...,
    "SnapshotId": ...,
    "StageName": ...,
}

parent.start_stage_deployment(**kwargs)
  1. See StartStageDeploymentRequestRequestTypeDef

tag_resource#

Adds tags to a GameSparks resource.

Type annotations and code completion for boto3.client("gamesparks").tag_resource method. boto3 documentation

# tag_resource method definition

def tag_resource(
    self,
    *,
    ResourceArn: str,
    tags: Mapping[str, str],
) -> Dict[str, Any]:
    ...
# tag_resource method usage example with argument unpacking

kwargs: TagResourceRequestRequestTypeDef = {  # (1)
    "ResourceArn": ...,
    "tags": ...,
}

parent.tag_resource(**kwargs)
  1. See TagResourceRequestRequestTypeDef

untag_resource#

Removes tags from a GameSparks resource.

Type annotations and code completion for boto3.client("gamesparks").untag_resource method.