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.