GameSparksClient

Index > GameSparks > GameSparksClient

Auto-generated documentation for GameSparks type annotations stubs module types-aiobotocore-gamesparks.

GameSparksClient

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

Usage example

from aioboto3.session import Session
from types_aiobotocore_gamesparks.client import GameSparksClient

session = Session()
async with session.client("gamesparks") as client:
    client: GameSparksClient

Exceptions

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

Usage example

async with session.client("gamesparks") as client:
    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)

Type checking example

from types_aiobotocore_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 session.client("gamesparks").can_paginate method. boto3 documentation

Method definition

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

close

Closes underlying endpoint connections.

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

Method definition

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

create_game

Creates a new game with an empty configuration.

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

Method definition

await def create_game(
    self,
    *,
    GameName: str,
    ClientToken: str = ...,
    Description: str = ...,
    Tags: Mapping[str, str] = ...,
) -> CreateGameResultTypeDef:  # (1)
    ...

1. See CreateGameResultTypeDef

Usage example with kwargs

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 session.client("gamesparks").create_snapshot method. boto3 documentation

Method definition

await def create_snapshot(
    self,
    *,
    GameName: str,
    Description: str = ...,
) -> CreateSnapshotResultTypeDef:  # (1)
    ...

1. See CreateSnapshotResultTypeDef

Usage example with kwargs

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 session.client("gamesparks").create_stage method. boto3 documentation

Method definition

await def create_stage(
    self,
    *,
    GameName: str,
    Role: str,
    StageName: str,
    ClientToken: str = ...,
    Description: str = ...,
    Tags: Mapping[str, str] = ...,
) -> CreateStageResultTypeDef:  # (1)
    ...

1. See CreateStageResultTypeDef

Usage example with kwargs

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

parent.create_stage(**kwargs)

1. See CreateStageRequestRequestTypeDef

delete_game

Deletes a game.

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

Method definition

await def delete_game(
    self,
    *,
    GameName: str,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

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 session.client("gamesparks").delete_stage method. boto3 documentation

Method definition

await def delete_stage(
    self,
    *,
    GameName: str,
    StageName: str,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

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 session.client("gamesparks").disconnect_player method. boto3 documentation

Method definition

await def disconnect_player(
    self,
    *,
    GameName: str,
    PlayerId: str,
    StageName: str,
) -> DisconnectPlayerResultTypeDef:  # (1)
    ...

1. See DisconnectPlayerResultTypeDef

Usage example with kwargs

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 session.client("gamesparks").export_snapshot method. boto3 documentation

Method definition

await def export_snapshot(
    self,
    *,
    GameName: str,
    SnapshotId: str,
) -> ExportSnapshotResultTypeDef:  # (1)
    ...

1. See ExportSnapshotResultTypeDef

Usage example with kwargs

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 session.client("gamesparks").generate_presigned_url method. boto3 documentation

Method definition

await 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 session.client("gamesparks").get_extension method. boto3 documentation

Method definition

await def get_extension(
    self,
    *,
    Name: str,
    Namespace: str,
) -> GetExtensionResultTypeDef:  # (1)
    ...

1. See GetExtensionResultTypeDef

Usage example with kwargs

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 session.client("gamesparks").get_extension_version method. boto3 documentation

Method definition

await def get_extension_version(
    self,
    *,
    ExtensionVersion: str,
    Name: str,
    Namespace: str,
) -> GetExtensionVersionResultTypeDef:  # (1)
    ...

1. See GetExtensionVersionResultTypeDef

Usage example with kwargs

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 session.client("gamesparks").get_game method. boto3 documentation

Method definition

await def get_game(
    self,
    *,
    GameName: str,
) -> GetGameResultTypeDef:  # (1)
    ...

1. See GetGameResultTypeDef

Usage example with kwargs

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 session.client("gamesparks").get_game_configuration method. boto3 documentation

Method definition

await def get_game_configuration(
    self,
    *,
    GameName: str,
    Sections: Sequence[str] = ...,
) -> GetGameConfigurationResultTypeDef:  # (1)
    ...

1. See GetGameConfigurationResultTypeDef

Usage example with kwargs

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 session.client("gamesparks").get_generated_code_job method. boto3 documentation

Method definition

await def get_generated_code_job(
    self,
    *,
    GameName: str,
    JobId: str,
    SnapshotId: str,
) -> GetGeneratedCodeJobResultTypeDef:  # (1)
    ...

1. See GetGeneratedCodeJobResultTypeDef

Usage example with kwargs

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 session.client("gamesparks").get_player_connection_status method. boto3 documentation

Method definition

await def get_player_connection_status(
    self,
    *,
    GameName: str,
    PlayerId: str,
    StageName: str,
) -> GetPlayerConnectionStatusResultTypeDef:  # (1)
    ...

1. See GetPlayerConnectionStatusResultTypeDef

Usage example with kwargs

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 session.client("gamesparks").get_snapshot method. boto3 documentation

Method definition

await def get_snapshot(
    self,
    *,
    GameName: str,
    SnapshotId: str,
    Sections: Sequence[str] = ...,
) -> GetSnapshotResultTypeDef:  # (1)
    ...

1. See GetSnapshotResultTypeDef

Usage example with kwargs

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 session.client("gamesparks").get_stage method. boto3 documentation

Method definition

await def get_stage(
    self,
    *,
    GameName: str,
    StageName: str,
) -> GetStageResultTypeDef:  # (1)
    ...

1. See GetStageResultTypeDef

Usage example with kwargs

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 session.client("gamesparks").get_stage_deployment method. boto3 documentation

Method definition

await def get_stage_deployment(
    self,
    *,
    GameName: str,
    StageName: str,
    DeploymentId: str = ...,
) -> GetStageDeploymentResultTypeDef:  # (1)
    ...

1. See GetStageDeploymentResultTypeDef

Usage example with kwargs

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 session.client("gamesparks").import_game_configuration method. boto3 documentation

Method definition

await def import_game_configuration(
    self,
    *,
    GameName: str,
    ImportSource: ImportGameConfigurationSourceTypeDef,  # (1)
) -> ImportGameConfigurationResultTypeDef:  # (2)
    ...

1. See ImportGameConfigurationSourceTypeDef
2. See ImportGameConfigurationResultTypeDef

Usage example with kwargs

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 session.client("gamesparks").list_extension_versions method. boto3 documentation

Method definition

await def list_extension_versions(
    self,
    *,
    Name: str,
    Namespace: str,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListExtensionVersionsResultTypeDef:  # (1)
    ...

1. See ListExtensionVersionsResultTypeDef

Usage example with kwargs

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 session.client("gamesparks").list_extensions method. boto3 documentation

Method definition

await def list_extensions(
    self,
    *,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListExtensionsResultTypeDef:  # (1)
    ...

1. See ListExtensionsResultTypeDef

Usage example with kwargs

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 session.client("gamesparks").list_games method. boto3 documentation

Method definition

await def list_games(
    self,
    *,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListGamesResultTypeDef:  # (1)
    ...

1. See ListGamesResultTypeDef

Usage example with kwargs

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 session.client("gamesparks").list_generated_code_jobs method. boto3 documentation

Method definition

await def list_generated_code_jobs(
    self,
    *,
    GameName: str,
    SnapshotId: str,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListGeneratedCodeJobsResultTypeDef:  # (1)
    ...

1. See ListGeneratedCodeJobsResultTypeDef

Usage example with kwargs

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 session.client("gamesparks").list_snapshots method. boto3 documentation

Method definition

await def list_snapshots(
    self,
    *,
    GameName: str,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListSnapshotsResultTypeDef:  # (1)
    ...

1. See ListSnapshotsResultTypeDef

Usage example with kwargs

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 session.client("gamesparks").list_stage_deployments method. boto3 documentation

Method definition

await def list_stage_deployments(
    self,
    *,
    GameName: str,
    StageName: str,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListStageDeploymentsResultTypeDef:  # (1)
    ...

1. See ListStageDeploymentsResultTypeDef

Usage example with kwargs

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 session.client("gamesparks").list_stages method. boto3 documentation

Method definition

await def list_stages(
    self,
    *,
    GameName: str,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListStagesResultTypeDef:  # (1)
    ...

1. See ListStagesResultTypeDef

Usage example with kwargs

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 session.client("gamesparks").list_tags_for_resource method. boto3 documentation

Method definition

await def list_tags_for_resource(
    self,
    *,
    ResourceArn: str,
) -> ListTagsForResourceResultTypeDef:  # (1)
    ...

1. See ListTagsForResourceResultTypeDef

Usage example with kwargs

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 session.client("gamesparks").start_generated_code_job method. boto3 documentation

Method definition

await def start_generated_code_job(
    self,
    *,
    GameName: str,
    Generator: GeneratorTypeDef,  # (1)
    SnapshotId: str,
) -> StartGeneratedCodeJobResultTypeDef:  # (2)
    ...

1. See GeneratorTypeDef
2. See StartGeneratedCodeJobResultTypeDef

Usage example with kwargs

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 session.client("gamesparks").start_stage_deployment method. boto3 documentation

Method definition

await def start_stage_deployment(
    self,
    *,
    GameName: str,
    SnapshotId: str,
    StageName: str,
    ClientToken: str = ...,
) -> StartStageDeploymentResultTypeDef:  # (1)
    ...

1. See StartStageDeploymentResultTypeDef

Usage example with kwargs

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 session.client("gamesparks").tag_resource method. boto3 documentation

Method definition

await def tag_resource(
    self,
    *,
    ResourceArn: str,
    tags: Mapping[str, str],
) -> Dict[str, Any]:
    ...

Usage example with kwargs

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 session.client("gamesparks").untag_resource method. boto3 documentation

Method definition

await def untag_resource(
    self,
    *,
    ResourceArn: str,
    tagKeys: Sequence[str],
) -> Dict[str, Any]:
    ...

Usage example with kwargs

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

parent.untag_resource(**kwargs)

1. See UntagResourceRequestRequestTypeDef

update_game

Updates details of the game.

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

Method definition

await def update_game(
    self,
    *,
    GameName: str,
    Description: str = ...,
) -> UpdateGameResultTypeDef:  # (1)
    ...

1. See UpdateGameResultTypeDef

Usage example with kwargs

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

parent.update_game(**kwargs)

1. See UpdateGameRequestRequestTypeDef

update_game_configuration

Updates one or more sections of the game configuration.

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

Method definition

await def update_game_configuration(
    self,
    *,
    GameName: str,
    Modifications: Sequence[SectionModificationTypeDef],  # (1)
) -> UpdateGameConfigurationResultTypeDef:  # (2)
    ...

1. See SectionModificationTypeDef
2. See UpdateGameConfigurationResultTypeDef

Usage example with kwargs

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

parent.update_game_configuration(**kwargs)

1. See UpdateGameConfigurationRequestRequestTypeDef

update_snapshot

Updates the metadata of a GameSparks snapshot.

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

Method definition

await def update_snapshot(
    self,
    *,
    GameName: str,
    SnapshotId: str,
    Description: str = ...,
) -> UpdateSnapshotResultTypeDef:  # (1)
    ...

1. See UpdateSnapshotResultTypeDef

Usage example with kwargs

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

parent.update_snapshot(**kwargs)

1. See UpdateSnapshotRequestRequestTypeDef

update_stage

Updates the metadata of a stage.

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

Method definition

await def update_stage(
    self,
    *,
    GameName: str,
    StageName: str,
    Description: str = ...,
    Role: str = ...,
) -> UpdateStageResultTypeDef:  # (1)
    ...

1. See UpdateStageResultTypeDef

Usage example with kwargs

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

parent.update_stage(**kwargs)

1. See UpdateStageRequestRequestTypeDef

__aenter__

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

Method definition

await def __aenter__(
    self,
) -> GameSparksClient:
    ...

__aexit__

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

Method definition

await def __aexit__(
    self,
    exc_type: Any,
    exc_val: Any,
    exc_tb: Any,
) -> Any:
    ...

get_paginator

Type annotations and code completion for session.client("gamesparks").get_paginator method with overloads.

• client.get_paginator("list_extension_versions") -> ListExtensionVersionsPaginator
• client.get_paginator("list_extensions") -> ListExtensionsPaginator
• client.get_paginator("list_games") -> ListGamesPaginator
• client.get_paginator("list_generated_code_jobs") -> ListGeneratedCodeJobsPaginator
• client.get_paginator("list_snapshots") -> ListSnapshotsPaginator
• client.get_paginator("list_stage_deployments") -> ListStageDeploymentsPaginator
• client.get_paginator("list_stages") -> ListStagesPaginator