Skip to content

SimSpaceWeaverClient#

Index > SimSpaceWeaver > SimSpaceWeaverClient

Auto-generated documentation for SimSpaceWeaver type annotations stubs module mypy-boto3-simspaceweaver.

SimSpaceWeaverClient#

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

# SimSpaceWeaverClient usage example

from boto3.session import Session
from mypy_boto3_simspaceweaver.client import SimSpaceWeaverClient

def get_simspaceweaver_client() -> SimSpaceWeaverClient:
    return Session().client("simspaceweaver")

Exceptions#

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

# Exceptions.exceptions usage example

client = boto3.client("simspaceweaver")

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.TooManyTagsException,
    client.exceptions.ValidationException,
) as e:
    print(e)
# Exceptions.exceptions type checking example

from mypy_boto3_simspaceweaver.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("simspaceweaver").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("simspaceweaver").close method. boto3 documentation

# close method definition

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

create_snapshot#

Creates a snapshot of the specified simulation.

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

# create_snapshot method definition

def create_snapshot(
    self,
    *,
    Destination: S3DestinationTypeDef,  # (1)
    Simulation: str,
) -> Dict[str, Any]:
    ...
  1. See S3DestinationTypeDef
# create_snapshot method usage example with argument unpacking

kwargs: CreateSnapshotInputRequestTypeDef = {  # (1)
    "Destination": ...,
    "Simulation": ...,
}

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

delete_app#

Deletes the instance of the given custom app.

Type annotations and code completion for boto3.client("simspaceweaver").delete_app method. boto3 documentation

# delete_app method definition

def delete_app(
    self,
    *,
    App: str,
    Domain: str,
    Simulation: str,
) -> Dict[str, Any]:
    ...
# delete_app method usage example with argument unpacking

kwargs: DeleteAppInputRequestTypeDef = {  # (1)
    "App": ...,
    "Domain": ...,
    "Simulation": ...,
}

parent.delete_app(**kwargs)
  1. See DeleteAppInputRequestTypeDef

delete_simulation#

Deletes all SimSpace Weaver resources assigned to the given simulation.

Type annotations and code completion for boto3.client("simspaceweaver").delete_simulation method. boto3 documentation

# delete_simulation method definition

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

kwargs: DeleteSimulationInputRequestTypeDef = {  # (1)
    "Simulation": ...,
}

parent.delete_simulation(**kwargs)
  1. See DeleteSimulationInputRequestTypeDef

describe_app#

Returns the state of the given custom app.

Type annotations and code completion for boto3.client("simspaceweaver").describe_app method. boto3 documentation

# describe_app method definition

def describe_app(
    self,
    *,
    App: str,
    Domain: str,
    Simulation: str,
) -> DescribeAppOutputTypeDef:  # (1)
    ...
  1. See DescribeAppOutputTypeDef
# describe_app method usage example with argument unpacking

kwargs: DescribeAppInputRequestTypeDef = {  # (1)
    "App": ...,
    "Domain": ...,
    "Simulation": ...,
}

parent.describe_app(**kwargs)
  1. See DescribeAppInputRequestTypeDef

describe_simulation#

Returns the current state of the given simulation.

Type annotations and code completion for boto3.client("simspaceweaver").describe_simulation method. boto3 documentation

# describe_simulation method definition

def describe_simulation(
    self,
    *,
    Simulation: str,
) -> DescribeSimulationOutputTypeDef:  # (1)
    ...
  1. See DescribeSimulationOutputTypeDef
# describe_simulation method usage example with argument unpacking

kwargs: DescribeSimulationInputRequestTypeDef = {  # (1)
    "Simulation": ...,
}

parent.describe_simulation(**kwargs)
  1. See DescribeSimulationInputRequestTypeDef

generate_presigned_url#

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

Type annotations and code completion for boto3.client("simspaceweaver").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:
    ...

list_apps#

Lists all custom apps or service apps for the given simulation and domain.

Type annotations and code completion for boto3.client("simspaceweaver").list_apps method. boto3 documentation

# list_apps method definition

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

kwargs: ListAppsInputRequestTypeDef = {  # (1)
    "Simulation": ...,
}

parent.list_apps(**kwargs)
  1. See ListAppsInputRequestTypeDef

list_simulations#

Lists the SimSpace Weaver simulations in the Amazon Web Services account used to make the API call.

Type annotations and code completion for boto3.client("simspaceweaver").list_simulations method. boto3 documentation

# list_simulations method definition

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

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

parent.list_simulations(**kwargs)
  1. See ListSimulationsInputRequestTypeDef

list_tags_for_resource#

Lists all tags on a SimSpace Weaver resource.

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

# list_tags_for_resource method definition

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

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

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

start_app#

Starts a custom app with the configuration specified in the simulation schema.

Type annotations and code completion for boto3.client("simspaceweaver").start_app method. boto3 documentation

# start_app method definition

def start_app(
    self,
    *,
    Domain: str,
    Name: str,
    Simulation: str,
    ClientToken: str = ...,
    Description: str = ...,
    LaunchOverrides: LaunchOverridesTypeDef = ...,  # (1)
) -> StartAppOutputTypeDef:  # (2)
    ...
  1. See LaunchOverridesTypeDef
  2. See StartAppOutputTypeDef
# start_app method usage example with argument unpacking

kwargs: StartAppInputRequestTypeDef = {  # (1)
    "Domain": ...,
    "Name": ...,
    "Simulation": ...,
}

parent.start_app(**kwargs)
  1. See StartAppInputRequestTypeDef

start_clock#

Starts the simulation clock.

Type annotations and code completion for boto3.client("simspaceweaver").start_clock method. boto3 documentation

# start_clock method definition

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

kwargs: StartClockInputRequestTypeDef = {  # (1)
    "Simulation": ...,
}

parent.start_clock(**kwargs)
  1. See StartClockInputRequestTypeDef

start_simulation#

Starts a simulation with the given name.

Type annotations and code completion for boto3.client("simspaceweaver").start_simulation method. boto3 documentation

# start_simulation method definition

def start_simulation(
    self,
    *,
    Name: str,
    RoleArn: str,
    ClientToken: str = ...,
    Description: str = ...,
    MaximumDuration: str = ...,
    SchemaS3Location: S3LocationTypeDef = ...,  # (1)
    SnapshotS3Location: S3LocationTypeDef = ...,  # (1)
    Tags: Mapping[str, str] = ...,
) -> StartSimulationOutputTypeDef:  # (3)
    ...
  1. See S3LocationTypeDef
  2. See S3LocationTypeDef
  3. See StartSimulationOutputTypeDef
# start_simulation method usage example with argument unpacking

kwargs: StartSimulationInputRequestTypeDef = {  # (1)
    "Name": ...,
    "RoleArn": ...,
}

parent.start_simulation(**kwargs)
  1. See StartSimulationInputRequestTypeDef

stop_app#

Stops the given custom app and shuts down all of its allocated compute resources.

Type annotations and code completion for boto3.client("simspaceweaver").stop_app method. boto3 documentation

# stop_app method definition

def stop_app(
    self,
    *,
    App: str,
    Domain: str,
    Simulation: str,
) -> Dict[str, Any]:
    ...
# stop_app method usage example with argument unpacking

kwargs: StopAppInputRequestTypeDef = {  # (1)
    "App": ...,
    "Domain": ...,
    "Simulation": ...,
}

parent.stop_app(**kwargs)
  1. See StopAppInputRequestTypeDef

stop_clock#

Stops the simulation clock.

Type annotations and code completion for boto3.client("simspaceweaver").stop_clock method. boto3 documentation

# stop_clock method definition

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

kwargs: StopClockInputRequestTypeDef = {  # (1)
    "Simulation": ...,
}

parent.stop_clock(**kwargs)
  1. See StopClockInputRequestTypeDef

stop_simulation#

Stops the given simulation.

Type annotations and code completion for boto3.client("simspaceweaver").stop_simulation method. boto3 documentation

# stop_simulation method definition

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

kwargs: StopSimulationInputRequestTypeDef = {  # (1)
    "Simulation": ...,
}

parent.stop_simulation(**kwargs)
  1. See StopSimulationInputRequestTypeDef

tag_resource#

Adds tags to a SimSpace Weaver resource.

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