Skip to content

Type definitions#

Index > SimSpaceWeaver > Type definitions

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

LaunchOverridesUnionTypeDef#

# LaunchOverridesUnionTypeDef Union usage example

from mypy_boto3_simspaceweaver.type_defs import LaunchOverridesUnionTypeDef


def get_value() -> LaunchOverridesUnionTypeDef:
    return ...


# LaunchOverridesUnionTypeDef definition

LaunchOverridesUnionTypeDef = Union[
    LaunchOverridesTypeDef,  # (1)
    LaunchOverridesOutputTypeDef,  # (2)
]
  1. See LaunchOverridesTypeDef
  2. See LaunchOverridesOutputTypeDef

CloudWatchLogsLogGroupTypeDef#

# CloudWatchLogsLogGroupTypeDef TypedDict usage example

from mypy_boto3_simspaceweaver.type_defs import CloudWatchLogsLogGroupTypeDef


def get_value() -> CloudWatchLogsLogGroupTypeDef:
    return {
        "LogGroupArn": ...,
    }


# CloudWatchLogsLogGroupTypeDef definition

class CloudWatchLogsLogGroupTypeDef(TypedDict):
    LogGroupArn: NotRequired[str],

S3DestinationTypeDef#

# S3DestinationTypeDef TypedDict usage example

from mypy_boto3_simspaceweaver.type_defs import S3DestinationTypeDef


def get_value() -> S3DestinationTypeDef:
    return {
        "BucketName": ...,
    }


# S3DestinationTypeDef definition

class S3DestinationTypeDef(TypedDict):
    BucketName: str,
    ObjectKeyPrefix: NotRequired[str],

DeleteAppInputTypeDef#

# DeleteAppInputTypeDef TypedDict usage example

from mypy_boto3_simspaceweaver.type_defs import DeleteAppInputTypeDef


def get_value() -> DeleteAppInputTypeDef:
    return {
        "App": ...,
    }


# DeleteAppInputTypeDef definition

class DeleteAppInputTypeDef(TypedDict):
    App: str,
    Domain: str,
    Simulation: str,

DeleteSimulationInputTypeDef#

# DeleteSimulationInputTypeDef TypedDict usage example

from mypy_boto3_simspaceweaver.type_defs import DeleteSimulationInputTypeDef


def get_value() -> DeleteSimulationInputTypeDef:
    return {
        "Simulation": ...,
    }


# DeleteSimulationInputTypeDef definition

class DeleteSimulationInputTypeDef(TypedDict):
    Simulation: str,

DescribeAppInputTypeDef#

# DescribeAppInputTypeDef TypedDict usage example

from mypy_boto3_simspaceweaver.type_defs import DescribeAppInputTypeDef


def get_value() -> DescribeAppInputTypeDef:
    return {
        "App": ...,
    }


# DescribeAppInputTypeDef definition

class DescribeAppInputTypeDef(TypedDict):
    App: str,
    Domain: str,
    Simulation: str,

LaunchOverridesOutputTypeDef#

# LaunchOverridesOutputTypeDef TypedDict usage example

from mypy_boto3_simspaceweaver.type_defs import LaunchOverridesOutputTypeDef


def get_value() -> LaunchOverridesOutputTypeDef:
    return {
        "LaunchCommands": ...,
    }


# LaunchOverridesOutputTypeDef definition

class LaunchOverridesOutputTypeDef(TypedDict):
    LaunchCommands: NotRequired[List[str]],

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef TypedDict usage example

from mypy_boto3_simspaceweaver.type_defs import ResponseMetadataTypeDef


def get_value() -> ResponseMetadataTypeDef:
    return {
        "RequestId": ...,
    }


# ResponseMetadataTypeDef definition

class ResponseMetadataTypeDef(TypedDict):
    RequestId: str,
    HTTPStatusCode: int,
    HTTPHeaders: Dict[str, str],
    RetryAttempts: int,
    HostId: NotRequired[str],

DescribeSimulationInputTypeDef#

# DescribeSimulationInputTypeDef TypedDict usage example

from mypy_boto3_simspaceweaver.type_defs import DescribeSimulationInputTypeDef


def get_value() -> DescribeSimulationInputTypeDef:
    return {
        "Simulation": ...,
    }


# DescribeSimulationInputTypeDef definition

class DescribeSimulationInputTypeDef(TypedDict):
    Simulation: str,

S3LocationTypeDef#

# S3LocationTypeDef TypedDict usage example

from mypy_boto3_simspaceweaver.type_defs import S3LocationTypeDef


def get_value() -> S3LocationTypeDef:
    return {
        "BucketName": ...,
    }


# S3LocationTypeDef definition

class S3LocationTypeDef(TypedDict):
    BucketName: str,
    ObjectKey: str,

DomainTypeDef#

# DomainTypeDef TypedDict usage example

from mypy_boto3_simspaceweaver.type_defs import DomainTypeDef


def get_value() -> DomainTypeDef:
    return {
        "Lifecycle": ...,
    }


# DomainTypeDef definition

class DomainTypeDef(TypedDict):
    Lifecycle: NotRequired[LifecycleManagementStrategyType],  # (1)
    Name: NotRequired[str],
  1. See LifecycleManagementStrategyType

LaunchOverridesTypeDef#

# LaunchOverridesTypeDef TypedDict usage example

from mypy_boto3_simspaceweaver.type_defs import LaunchOverridesTypeDef


def get_value() -> LaunchOverridesTypeDef:
    return {
        "LaunchCommands": ...,
    }


# LaunchOverridesTypeDef definition

class LaunchOverridesTypeDef(TypedDict):
    LaunchCommands: NotRequired[Sequence[str]],

ListAppsInputTypeDef#

# ListAppsInputTypeDef TypedDict usage example

from mypy_boto3_simspaceweaver.type_defs import ListAppsInputTypeDef


def get_value() -> ListAppsInputTypeDef:
    return {
        "Simulation": ...,
    }


# ListAppsInputTypeDef definition

class ListAppsInputTypeDef(TypedDict):
    Simulation: str,
    Domain: NotRequired[str],
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],

SimulationAppMetadataTypeDef#

# SimulationAppMetadataTypeDef TypedDict usage example

from mypy_boto3_simspaceweaver.type_defs import SimulationAppMetadataTypeDef


def get_value() -> SimulationAppMetadataTypeDef:
    return {
        "Domain": ...,
    }


# SimulationAppMetadataTypeDef definition

class SimulationAppMetadataTypeDef(TypedDict):
    Domain: NotRequired[str],
    Name: NotRequired[str],
    Simulation: NotRequired[str],
    Status: NotRequired[SimulationAppStatusType],  # (1)
    TargetStatus: NotRequired[SimulationAppTargetStatusType],  # (2)
  1. See SimulationAppStatusType
  2. See SimulationAppTargetStatusType

ListSimulationsInputTypeDef#

# ListSimulationsInputTypeDef TypedDict usage example

from mypy_boto3_simspaceweaver.type_defs import ListSimulationsInputTypeDef


def get_value() -> ListSimulationsInputTypeDef:
    return {
        "MaxResults": ...,
    }


# ListSimulationsInputTypeDef definition

class ListSimulationsInputTypeDef(TypedDict):
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],

SimulationMetadataTypeDef#

# SimulationMetadataTypeDef TypedDict usage example

from mypy_boto3_simspaceweaver.type_defs import SimulationMetadataTypeDef


def get_value() -> SimulationMetadataTypeDef:
    return {
        "Arn": ...,
    }


# SimulationMetadataTypeDef definition

class SimulationMetadataTypeDef(TypedDict):
    Arn: NotRequired[str],
    CreationTime: NotRequired[datetime.datetime],
    Name: NotRequired[str],
    Status: NotRequired[SimulationStatusType],  # (1)
    TargetStatus: NotRequired[SimulationTargetStatusType],  # (2)
  1. See SimulationStatusType
  2. See SimulationTargetStatusType

ListTagsForResourceInputTypeDef#

# ListTagsForResourceInputTypeDef TypedDict usage example

from mypy_boto3_simspaceweaver.type_defs import ListTagsForResourceInputTypeDef


def get_value() -> ListTagsForResourceInputTypeDef:
    return {
        "ResourceArn": ...,
    }


# ListTagsForResourceInputTypeDef definition

class ListTagsForResourceInputTypeDef(TypedDict):
    ResourceArn: str,

SimulationClockTypeDef#

# SimulationClockTypeDef TypedDict usage example

from mypy_boto3_simspaceweaver.type_defs import SimulationClockTypeDef


def get_value() -> SimulationClockTypeDef:
    return {
        "Status": ...,
    }


# SimulationClockTypeDef definition

class SimulationClockTypeDef(TypedDict):
    Status: NotRequired[ClockStatusType],  # (1)
    TargetStatus: NotRequired[ClockTargetStatusType],  # (2)
  1. See ClockStatusType
  2. See ClockTargetStatusType

SimulationAppPortMappingTypeDef#

# SimulationAppPortMappingTypeDef TypedDict usage example

from mypy_boto3_simspaceweaver.type_defs import SimulationAppPortMappingTypeDef


def get_value() -> SimulationAppPortMappingTypeDef:
    return {
        "Actual": ...,
    }


# SimulationAppPortMappingTypeDef definition

class SimulationAppPortMappingTypeDef(TypedDict):
    Actual: NotRequired[int],
    Declared: NotRequired[int],

StartClockInputTypeDef#

# StartClockInputTypeDef TypedDict usage example

from mypy_boto3_simspaceweaver.type_defs import StartClockInputTypeDef


def get_value() -> StartClockInputTypeDef:
    return {
        "Simulation": ...,
    }


# StartClockInputTypeDef definition

class StartClockInputTypeDef(TypedDict):
    Simulation: str,

StopAppInputTypeDef#

# StopAppInputTypeDef TypedDict usage example

from mypy_boto3_simspaceweaver.type_defs import StopAppInputTypeDef


def get_value() -> StopAppInputTypeDef:
    return {
        "App": ...,
    }


# StopAppInputTypeDef definition

class StopAppInputTypeDef(TypedDict):
    App: str,
    Domain: str,
    Simulation: str,

StopClockInputTypeDef#

# StopClockInputTypeDef TypedDict usage example

from mypy_boto3_simspaceweaver.type_defs import StopClockInputTypeDef


def get_value() -> StopClockInputTypeDef:
    return {
        "Simulation": ...,
    }


# StopClockInputTypeDef definition

class StopClockInputTypeDef(TypedDict):
    Simulation: str,

StopSimulationInputTypeDef#

# StopSimulationInputTypeDef TypedDict usage example

from mypy_boto3_simspaceweaver.type_defs import StopSimulationInputTypeDef


def get_value() -> StopSimulationInputTypeDef:
    return {
        "Simulation": ...,
    }


# StopSimulationInputTypeDef definition

class StopSimulationInputTypeDef(TypedDict):
    Simulation: str,

TagResourceInputTypeDef#

# TagResourceInputTypeDef TypedDict usage example

from mypy_boto3_simspaceweaver.type_defs import TagResourceInputTypeDef


def get_value() -> TagResourceInputTypeDef:
    return {
        "ResourceArn": ...,
    }


# TagResourceInputTypeDef definition

class TagResourceInputTypeDef(TypedDict):
    ResourceArn: str,
    Tags: Mapping[str, str],

UntagResourceInputTypeDef#

# UntagResourceInputTypeDef TypedDict usage example

from mypy_boto3_simspaceweaver.type_defs import UntagResourceInputTypeDef


def get_value() -> UntagResourceInputTypeDef:
    return {
        "ResourceArn": ...,
    }


# UntagResourceInputTypeDef definition

class UntagResourceInputTypeDef(TypedDict):
    ResourceArn: str,
    TagKeys: Sequence[str],

LogDestinationTypeDef#

# LogDestinationTypeDef TypedDict usage example

from mypy_boto3_simspaceweaver.type_defs import LogDestinationTypeDef


def get_value() -> LogDestinationTypeDef:
    return {
        "CloudWatchLogsLogGroup": ...,
    }


# LogDestinationTypeDef definition

class LogDestinationTypeDef(TypedDict):
    CloudWatchLogsLogGroup: NotRequired[CloudWatchLogsLogGroupTypeDef],  # (1)
  1. See CloudWatchLogsLogGroupTypeDef

CreateSnapshotInputTypeDef#

# CreateSnapshotInputTypeDef TypedDict usage example

from mypy_boto3_simspaceweaver.type_defs import CreateSnapshotInputTypeDef


def get_value() -> CreateSnapshotInputTypeDef:
    return {
        "Destination": ...,
    }


# CreateSnapshotInputTypeDef definition

class CreateSnapshotInputTypeDef(TypedDict):
    Destination: S3DestinationTypeDef,  # (1)
    Simulation: str,
  1. See S3DestinationTypeDef

ListTagsForResourceOutputTypeDef#

# ListTagsForResourceOutputTypeDef TypedDict usage example

from mypy_boto3_simspaceweaver.type_defs import ListTagsForResourceOutputTypeDef


def get_value() -> ListTagsForResourceOutputTypeDef:
    return {
        "Tags": ...,
    }


# ListTagsForResourceOutputTypeDef definition

class ListTagsForResourceOutputTypeDef(TypedDict):
    Tags: Dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

StartAppOutputTypeDef#

# StartAppOutputTypeDef TypedDict usage example

from mypy_boto3_simspaceweaver.type_defs import StartAppOutputTypeDef


def get_value() -> StartAppOutputTypeDef:
    return {
        "Domain": ...,
    }


# StartAppOutputTypeDef definition

class StartAppOutputTypeDef(TypedDict):
    Domain: str,
    Name: str,
    Simulation: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

StartSimulationOutputTypeDef#

# StartSimulationOutputTypeDef TypedDict usage example

from mypy_boto3_simspaceweaver.type_defs import StartSimulationOutputTypeDef


def get_value() -> StartSimulationOutputTypeDef:
    return {
        "Arn": ...,
    }


# StartSimulationOutputTypeDef definition

class StartSimulationOutputTypeDef(TypedDict):
    Arn: str,
    CreationTime: datetime.datetime,
    ExecutionId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

StartSimulationInputTypeDef#

# StartSimulationInputTypeDef TypedDict usage example

from mypy_boto3_simspaceweaver.type_defs import StartSimulationInputTypeDef


def get_value() -> StartSimulationInputTypeDef:
    return {
        "Name": ...,
    }


# StartSimulationInputTypeDef definition

class StartSimulationInputTypeDef(TypedDict):
    Name: str,
    RoleArn: str,
    ClientToken: NotRequired[str],
    Description: NotRequired[str],
    MaximumDuration: NotRequired[str],
    SchemaS3Location: NotRequired[S3LocationTypeDef],  # (1)
    SnapshotS3Location: NotRequired[S3LocationTypeDef],  # (1)
    Tags: NotRequired[Mapping[str, str]],
  1. See S3LocationTypeDef
  2. See S3LocationTypeDef

ListAppsOutputTypeDef#

# ListAppsOutputTypeDef TypedDict usage example

from mypy_boto3_simspaceweaver.type_defs import ListAppsOutputTypeDef


def get_value() -> ListAppsOutputTypeDef:
    return {
        "Apps": ...,
    }


# ListAppsOutputTypeDef definition

class ListAppsOutputTypeDef(TypedDict):
    Apps: List[SimulationAppMetadataTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See List[SimulationAppMetadataTypeDef]
  2. See ResponseMetadataTypeDef

ListSimulationsOutputTypeDef#

# ListSimulationsOutputTypeDef TypedDict usage example

from mypy_boto3_simspaceweaver.type_defs import ListSimulationsOutputTypeDef


def get_value() -> ListSimulationsOutputTypeDef:
    return {
        "NextToken": ...,
    }


# ListSimulationsOutputTypeDef definition

class ListSimulationsOutputTypeDef(TypedDict):
    Simulations: List[SimulationMetadataTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See List[SimulationMetadataTypeDef]
  2. See ResponseMetadataTypeDef

LiveSimulationStateTypeDef#

# LiveSimulationStateTypeDef TypedDict usage example

from mypy_boto3_simspaceweaver.type_defs import LiveSimulationStateTypeDef


def get_value() -> LiveSimulationStateTypeDef:
    return {
        "Clocks": ...,
    }


# LiveSimulationStateTypeDef definition

class LiveSimulationStateTypeDef(TypedDict):
    Clocks: NotRequired[List[SimulationClockTypeDef]],  # (1)
    Domains: NotRequired[List[DomainTypeDef]],  # (2)
  1. See List[SimulationClockTypeDef]
  2. See List[DomainTypeDef]

SimulationAppEndpointInfoTypeDef#

# SimulationAppEndpointInfoTypeDef TypedDict usage example

from mypy_boto3_simspaceweaver.type_defs import SimulationAppEndpointInfoTypeDef


def get_value() -> SimulationAppEndpointInfoTypeDef:
    return {
        "Address": ...,
    }


# SimulationAppEndpointInfoTypeDef definition

class SimulationAppEndpointInfoTypeDef(TypedDict):
    Address: NotRequired[str],
    IngressPortMappings: NotRequired[List[SimulationAppPortMappingTypeDef]],  # (1)
  1. See List[SimulationAppPortMappingTypeDef]

LoggingConfigurationTypeDef#

# LoggingConfigurationTypeDef TypedDict usage example

from mypy_boto3_simspaceweaver.type_defs import LoggingConfigurationTypeDef


def get_value() -> LoggingConfigurationTypeDef:
    return {
        "Destinations": ...,
    }


# LoggingConfigurationTypeDef definition

class LoggingConfigurationTypeDef(TypedDict):
    Destinations: NotRequired[List[LogDestinationTypeDef]],  # (1)
  1. See List[LogDestinationTypeDef]

StartAppInputTypeDef#

# StartAppInputTypeDef TypedDict usage example

from mypy_boto3_simspaceweaver.type_defs import StartAppInputTypeDef


def get_value() -> StartAppInputTypeDef:
    return {
        "Domain": ...,
    }


# StartAppInputTypeDef definition

class StartAppInputTypeDef(TypedDict):
    Domain: str,
    Name: str,
    Simulation: str,
    ClientToken: NotRequired[str],
    Description: NotRequired[str],
    LaunchOverrides: NotRequired[LaunchOverridesUnionTypeDef],  # (1)
  1. See LaunchOverridesUnionTypeDef

DescribeAppOutputTypeDef#

# DescribeAppOutputTypeDef TypedDict usage example

from mypy_boto3_simspaceweaver.type_defs import DescribeAppOutputTypeDef


def get_value() -> DescribeAppOutputTypeDef:
    return {
        "Description": ...,
    }


# DescribeAppOutputTypeDef definition

class DescribeAppOutputTypeDef(TypedDict):
    Description: str,
    Domain: str,
    EndpointInfo: SimulationAppEndpointInfoTypeDef,  # (1)
    LaunchOverrides: LaunchOverridesOutputTypeDef,  # (2)
    Name: str,
    Simulation: str,
    Status: SimulationAppStatusType,  # (3)
    TargetStatus: SimulationAppTargetStatusType,  # (4)
    ResponseMetadata: ResponseMetadataTypeDef,  # (5)
  1. See SimulationAppEndpointInfoTypeDef
  2. See LaunchOverridesOutputTypeDef
  3. See SimulationAppStatusType
  4. See SimulationAppTargetStatusType
  5. See ResponseMetadataTypeDef

DescribeSimulationOutputTypeDef#

# DescribeSimulationOutputTypeDef TypedDict usage example

from mypy_boto3_simspaceweaver.type_defs import DescribeSimulationOutputTypeDef


def get_value() -> DescribeSimulationOutputTypeDef:
    return {
        "Arn": ...,
    }


# DescribeSimulationOutputTypeDef definition

class DescribeSimulationOutputTypeDef(TypedDict):
    Arn: str,
    CreationTime: datetime.datetime,
    Description: str,
    ExecutionId: str,
    LiveSimulationState: LiveSimulationStateTypeDef,  # (1)
    LoggingConfiguration: LoggingConfigurationTypeDef,  # (2)
    MaximumDuration: str,
    Name: str,
    RoleArn: str,
    SchemaError: str,
    SchemaS3Location: S3LocationTypeDef,  # (3)
    SnapshotS3Location: S3LocationTypeDef,  # (3)
    StartError: str,
    Status: SimulationStatusType,  # (5)
    TargetStatus: SimulationTargetStatusType,  # (6)
    ResponseMetadata: ResponseMetadataTypeDef,  # (7)
  1. See LiveSimulationStateTypeDef
  2. See LoggingConfigurationTypeDef
  3. See S3LocationTypeDef
  4. See S3LocationTypeDef
  5. See SimulationStatusType
  6. See SimulationTargetStatusType
  7. See ResponseMetadataTypeDef