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
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.
client = boto3.client("gamesparks")
try:
do_something(client)
except (
client.AccessDeniedException,
client.ClientError,
client.ConflictException,
client.InternalServerException,
client.ResourceNotFoundException,
client.ServiceQuotaExceededException,
client.ThrottlingException,
client.ValidationException,
) as e:
print(e)
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
close
Closes underlying endpoint connections.
Type annotations and code completion for boto3.client("gamesparks").close
method.
boto3 documentation
create_game
Creates a new game with an empty configuration.
Type annotations and code completion for boto3.client("gamesparks").create_game
method.
boto3 documentation
def create_game(
self,
*,
GameName: str,
ClientToken: str = ...,
Description: str = ...,
Tags: Mapping[str, str] = ...,
) -> CreateGameResultTypeDef: # (1)
...
kwargs: CreateGameRequestRequestTypeDef = { # (1)
"GameName": ...,
}
parent.create_game(**kwargs)
create_snapshot
Creates a snapshot of the game configuration.
Type annotations and code completion for boto3.client("gamesparks").create_snapshot
method.
boto3 documentation
def create_snapshot(
self,
*,
GameName: str,
Description: str = ...,
) -> CreateSnapshotResultTypeDef: # (1)
...
kwargs: CreateSnapshotRequestRequestTypeDef = { # (1)
"GameName": ...,
}
parent.create_snapshot(**kwargs)
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
def create_stage(
self,
*,
GameName: str,
Role: str,
StageName: str,
ClientToken: str = ...,
Description: str = ...,
Tags: Mapping[str, str] = ...,
) -> CreateStageResultTypeDef: # (1)
...
kwargs: CreateStageRequestRequestTypeDef = { # (1)
"GameName": ...,
"Role": ...,
"StageName": ...,
}
parent.create_stage(**kwargs)
delete_game
Deletes a game.
Type annotations and code completion for boto3.client("gamesparks").delete_game
method.
boto3 documentation
kwargs: DeleteGameRequestRequestTypeDef = { # (1)
"GameName": ...,
}
parent.delete_game(**kwargs)
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
kwargs: DeleteStageRequestRequestTypeDef = { # (1)
"GameName": ...,
"StageName": ...,
}
parent.delete_stage(**kwargs)
disconnect_player
Disconnects a player from the game runtime.
Type annotations and code completion for boto3.client("gamesparks").disconnect_player
method.
boto3 documentation
def disconnect_player(
self,
*,
GameName: str,
PlayerId: str,
StageName: str,
) -> DisconnectPlayerResultTypeDef: # (1)
...
kwargs: DisconnectPlayerRequestRequestTypeDef = { # (1)
"GameName": ...,
"PlayerId": ...,
"StageName": ...,
}
parent.disconnect_player(**kwargs)
export_snapshot
Exports a game configuration snapshot.
Type annotations and code completion for boto3.client("gamesparks").export_snapshot
method.
boto3 documentation
def export_snapshot(
self,
*,
GameName: str,
SnapshotId: str,
) -> ExportSnapshotResultTypeDef: # (1)
...
kwargs: ExportSnapshotRequestRequestTypeDef = { # (1)
"GameName": ...,
"SnapshotId": ...,
}
parent.export_snapshot(**kwargs)
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
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
def get_extension(
self,
*,
Name: str,
Namespace: str,
) -> GetExtensionResultTypeDef: # (1)
...
kwargs: GetExtensionRequestRequestTypeDef = { # (1)
"Name": ...,
"Namespace": ...,
}
parent.get_extension(**kwargs)
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
def get_extension_version(
self,
*,
ExtensionVersion: str,
Name: str,
Namespace: str,
) -> GetExtensionVersionResultTypeDef: # (1)
...
kwargs: GetExtensionVersionRequestRequestTypeDef = { # (1)
"ExtensionVersion": ...,
"Name": ...,
"Namespace": ...,
}
parent.get_extension_version(**kwargs)
get_game
Gets details about a game.
Type annotations and code completion for boto3.client("gamesparks").get_game
method.
boto3 documentation
kwargs: GetGameRequestRequestTypeDef = { # (1)
"GameName": ...,
}
parent.get_game(**kwargs)
get_game_configuration
Gets the configuration of the game.
Type annotations and code completion for boto3.client("gamesparks").get_game_configuration
method.
boto3 documentation
def get_game_configuration(
self,
*,
GameName: str,
Sections: Sequence[str] = ...,
) -> GetGameConfigurationResultTypeDef: # (1)
...
kwargs: GetGameConfigurationRequestRequestTypeDef = { # (1)
"GameName": ...,
}
parent.get_game_configuration(**kwargs)
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
def get_generated_code_job(
self,
*,
GameName: str,
JobId: str,
SnapshotId: str,
) -> GetGeneratedCodeJobResultTypeDef: # (1)
...
kwargs: GetGeneratedCodeJobRequestRequestTypeDef = { # (1)
"GameName": ...,
"JobId": ...,
"SnapshotId": ...,
}
parent.get_generated_code_job(**kwargs)
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
def get_player_connection_status(
self,
*,
GameName: str,
PlayerId: str,
StageName: str,
) -> GetPlayerConnectionStatusResultTypeDef: # (1)
...
kwargs: GetPlayerConnectionStatusRequestRequestTypeDef = { # (1)
"GameName": ...,
"PlayerId": ...,
"StageName": ...,
}
parent.get_player_connection_status(**kwargs)
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
def get_snapshot(
self,
*,
GameName: str,
SnapshotId: str,
Sections: Sequence[str] = ...,
) -> GetSnapshotResultTypeDef: # (1)
...
kwargs: GetSnapshotRequestRequestTypeDef = { # (1)
"GameName": ...,
"SnapshotId": ...,
}
parent.get_snapshot(**kwargs)
get_stage
Gets information about a stage.
Type annotations and code completion for boto3.client("gamesparks").get_stage
method.
boto3 documentation
def get_stage(
self,
*,
GameName: str,
StageName: str,
) -> GetStageResultTypeDef: # (1)
...
kwargs: GetStageRequestRequestTypeDef = { # (1)
"GameName": ...,
"StageName": ...,
}
parent.get_stage(**kwargs)
get_stage_deployment
Gets information about a stage deployment.
Type annotations and code completion for boto3.client("gamesparks").get_stage_deployment
method.
boto3 documentation
def get_stage_deployment(
self,
*,
GameName: str,
StageName: str,
DeploymentId: str = ...,
) -> GetStageDeploymentResultTypeDef: # (1)
...
kwargs: GetStageDeploymentRequestRequestTypeDef = { # (1)
"GameName": ...,
"StageName": ...,
}
parent.get_stage_deployment(**kwargs)
import_game_configuration
Imports a game configuration.
Type annotations and code completion for boto3.client("gamesparks").import_game_configuration
method.
boto3 documentation
def import_game_configuration(
self,
*,
GameName: str,
ImportSource: ImportGameConfigurationSourceTypeDef, # (1)
) -> ImportGameConfigurationResultTypeDef: # (2)
...
kwargs: ImportGameConfigurationRequestRequestTypeDef = { # (1)
"GameName": ...,
"ImportSource": ...,
}
parent.import_game_configuration(**kwargs)
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
def list_extension_versions(
self,
*,
Name: str,
Namespace: str,
MaxResults: int = ...,
NextToken: str = ...,
) -> ListExtensionVersionsResultTypeDef: # (1)
...
kwargs: ListExtensionVersionsRequestRequestTypeDef = { # (1)
"Name": ...,
"Namespace": ...,
}
parent.list_extension_versions(**kwargs)
list_extensions
Gets a paginated list of available extensions.
Type annotations and code completion for boto3.client("gamesparks").list_extensions
method.
boto3 documentation
def list_extensions(
self,
*,
MaxResults: int = ...,
NextToken: str = ...,
) -> ListExtensionsResultTypeDef: # (1)
...
kwargs: ListExtensionsRequestRequestTypeDef = { # (1)
"MaxResults": ...,
}
parent.list_extensions(**kwargs)
list_games
Gets a paginated list of games.
Type annotations and code completion for boto3.client("gamesparks").list_games
method.
boto3 documentation
def list_games(
self,
*,
MaxResults: int = ...,
NextToken: str = ...,
) -> ListGamesResultTypeDef: # (1)
...
kwargs: ListGamesRequestRequestTypeDef = { # (1)
"MaxResults": ...,
}
parent.list_games(**kwargs)
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
def list_generated_code_jobs(
self,
*,
GameName: str,
SnapshotId: str,
MaxResults: int = ...,
NextToken: str = ...,
) -> ListGeneratedCodeJobsResultTypeDef: # (1)
...
kwargs: ListGeneratedCodeJobsRequestRequestTypeDef = { # (1)
"GameName": ...,
"SnapshotId": ...,
}
parent.list_generated_code_jobs(**kwargs)
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
def list_snapshots(
self,
*,
GameName: str,
MaxResults: int = ...,
NextToken: str = ...,
) -> ListSnapshotsResultTypeDef: # (1)
...
kwargs: ListSnapshotsRequestRequestTypeDef = { # (1)
"GameName": ...,
}
parent.list_snapshots(**kwargs)
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
def list_stage_deployments(
self,
*,
GameName: str,
StageName: str,
MaxResults: int = ...,
NextToken: str = ...,
) -> ListStageDeploymentsResultTypeDef: # (1)
...
kwargs: ListStageDeploymentsRequestRequestTypeDef = { # (1)
"GameName": ...,
"StageName": ...,
}
parent.list_stage_deployments(**kwargs)
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
def list_stages(
self,
*,
GameName: str,
MaxResults: int = ...,
NextToken: str = ...,
) -> ListStagesResultTypeDef: # (1)
...
kwargs: ListStagesRequestRequestTypeDef = { # (1)
"GameName": ...,
}
parent.list_stages(**kwargs)
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
def list_tags_for_resource(
self,
*,
ResourceArn: str,
) -> ListTagsForResourceResultTypeDef: # (1)
...
kwargs: ListTagsForResourceRequestRequestTypeDef = { # (1)
"ResourceArn": ...,
}
parent.list_tags_for_resource(**kwargs)
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
def start_generated_code_job(
self,
*,
GameName: str,
Generator: GeneratorTypeDef, # (1)
SnapshotId: str,
) -> StartGeneratedCodeJobResultTypeDef: # (2)
...
kwargs: StartGeneratedCodeJobRequestRequestTypeDef = { # (1)
"GameName": ...,
"Generator": ...,
"SnapshotId": ...,
}
parent.start_generated_code_job(**kwargs)
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
def start_stage_deployment(
self,
*,
GameName: str,
SnapshotId: str,
StageName: str,
ClientToken: str = ...,
) -> StartStageDeploymentResultTypeDef: # (1)
...
kwargs: StartStageDeploymentRequestRequestTypeDef = { # (1)
"GameName": ...,
"SnapshotId": ...,
"StageName": ...,
}
parent.start_stage_deployment(**kwargs)
tag_resource
Adds tags to a GameSparks resource.
Type annotations and code completion for boto3.client("gamesparks").tag_resource
method.
boto3 documentation
def tag_resource(
self,
*,
ResourceArn: str,
tags: Mapping[str, str],
) -> Dict[str, Any]:
...
kwargs: TagResourceRequestRequestTypeDef = { # (1)
"ResourceArn": ...,
"tags": ...,
}
parent.tag_resource(**kwargs)
untag_resource
Removes tags from a GameSparks resource.
Type annotations and code completion for boto3.client("gamesparks").untag_resource
method.
boto3 documentation
def untag_resource(
self,
*,
ResourceArn: str,
tagKeys: Sequence[str],
) -> Dict[str, Any]:
...
kwargs: UntagResourceRequestRequestTypeDef = { # (1)
"ResourceArn": ...,
"tagKeys": ...,
}
parent.untag_resource(**kwargs)
update_game
Updates details of the game.
Type annotations and code completion for boto3.client("gamesparks").update_game
method.
boto3 documentation
def update_game(
self,
*,
GameName: str,
Description: str = ...,
) -> UpdateGameResultTypeDef: # (1)
...
kwargs: UpdateGameRequestRequestTypeDef = { # (1)
"GameName": ...,
}
parent.update_game(**kwargs)
update_game_configuration
Updates one or more sections of the game configuration.
Type annotations and code completion for boto3.client("gamesparks").update_game_configuration
method.
boto3 documentation
def update_game_configuration(
self,
*,
GameName: str,
Modifications: Sequence[SectionModificationTypeDef], # (1)
) -> UpdateGameConfigurationResultTypeDef: # (2)
...
kwargs: UpdateGameConfigurationRequestRequestTypeDef = { # (1)
"GameName": ...,
"Modifications": ...,
}
parent.update_game_configuration(**kwargs)
update_snapshot
Updates the metadata of a GameSparks snapshot.
Type annotations and code completion for boto3.client("gamesparks").update_snapshot
method.
boto3 documentation
def update_snapshot(
self,
*,
GameName: str,
SnapshotId: str,
Description: str = ...,
) -> UpdateSnapshotResultTypeDef: # (1)
...
kwargs: UpdateSnapshotRequestRequestTypeDef = { # (1)
"GameName": ...,
"SnapshotId": ...,
}
parent.update_snapshot(**kwargs)
update_stage
Updates the metadata of a stage.
Type annotations and code completion for boto3.client("gamesparks").update_stage
method.
boto3 documentation
def update_stage(
self,
*,
GameName: str,
StageName: str,
Description: str = ...,
Role: str = ...,
) -> UpdateStageResultTypeDef: # (1)
...
kwargs: UpdateStageRequestRequestTypeDef = { # (1)
"GameName": ...,
"StageName": ...,
}
parent.update_stage(**kwargs)
get_paginator
Type annotations and code completion for boto3.client("gamesparks").get_paginator
method with overloads.
client.get_paginator("list_extension_versions")
-> ListExtensionVersionsPaginatorclient.get_paginator("list_extensions")
-> ListExtensionsPaginatorclient.get_paginator("list_games")
-> ListGamesPaginatorclient.get_paginator("list_generated_code_jobs")
-> ListGeneratedCodeJobsPaginatorclient.get_paginator("list_snapshots")
-> ListSnapshotsPaginatorclient.get_paginator("list_stage_deployments")
-> ListStageDeploymentsPaginatorclient.get_paginator("list_stages")
-> ListStagesPaginator