Skip to content

Type definitions#

Index > SimSpaceWeaver > Type definitions

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

CloudWatchLogsLogGroupTypeDef#

# CloudWatchLogsLogGroupTypeDef definition

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

S3DestinationTypeDef#

# S3DestinationTypeDef definition

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

DeleteAppInputRequestTypeDef#

# DeleteAppInputRequestTypeDef definition

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

DeleteSimulationInputRequestTypeDef#

# DeleteSimulationInputRequestTypeDef definition

class DeleteSimulationInputRequestTypeDef(TypedDict):
    Simulation: str,

DescribeAppInputRequestTypeDef#

# DescribeAppInputRequestTypeDef definition

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

LaunchOverridesOutputTypeDef#

# LaunchOverridesOutputTypeDef definition

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

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

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

DescribeSimulationInputRequestTypeDef#

# DescribeSimulationInputRequestTypeDef definition

class DescribeSimulationInputRequestTypeDef(TypedDict):
    Simulation: str,

S3LocationTypeDef#

# S3LocationTypeDef definition

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

DomainTypeDef#

# DomainTypeDef definition

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

LaunchOverridesTypeDef#

# LaunchOverridesTypeDef definition

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

ListAppsInputRequestTypeDef#

# ListAppsInputRequestTypeDef definition

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

SimulationAppMetadataTypeDef#

# 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

ListSimulationsInputRequestTypeDef#

# ListSimulationsInputRequestTypeDef definition

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

SimulationMetadataTypeDef#

# SimulationMetadataTypeDef definition

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

ListTagsForResourceInputRequestTypeDef#

# ListTagsForResourceInputRequestTypeDef definition

class ListTagsForResourceInputRequestTypeDef(TypedDict):
    ResourceArn: str,

SimulationClockTypeDef#

# SimulationClockTypeDef definition

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

SimulationAppPortMappingTypeDef#

# SimulationAppPortMappingTypeDef definition

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

StartClockInputRequestTypeDef#

# StartClockInputRequestTypeDef definition

class StartClockInputRequestTypeDef(TypedDict):
    Simulation: str,

StopAppInputRequestTypeDef#

# StopAppInputRequestTypeDef definition

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

StopClockInputRequestTypeDef#

# StopClockInputRequestTypeDef definition

class StopClockInputRequestTypeDef(TypedDict):
    Simulation: str,

StopSimulationInputRequestTypeDef#

# StopSimulationInputRequestTypeDef definition

class StopSimulationInputRequestTypeDef(TypedDict):
    Simulation: str,

TagResourceInputRequestTypeDef#

# TagResourceInputRequestTypeDef definition

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

UntagResourceInputRequestTypeDef#

# UntagResourceInputRequestTypeDef definition

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

LogDestinationTypeDef#

# LogDestinationTypeDef definition

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

CreateSnapshotInputRequestTypeDef#

# CreateSnapshotInputRequestTypeDef definition

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

ListTagsForResourceOutputTypeDef#

# ListTagsForResourceOutputTypeDef definition

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

StartAppOutputTypeDef#

# StartAppOutputTypeDef definition

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

StartSimulationOutputTypeDef#

# StartSimulationOutputTypeDef definition

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

StartSimulationInputRequestTypeDef#

# StartSimulationInputRequestTypeDef definition

class StartSimulationInputRequestTypeDef(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

StartAppInputRequestTypeDef#

# StartAppInputRequestTypeDef definition

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

ListAppsOutputTypeDef#

# ListAppsOutputTypeDef definition

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

ListSimulationsOutputTypeDef#

# ListSimulationsOutputTypeDef definition

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

LiveSimulationStateTypeDef#

# LiveSimulationStateTypeDef definition

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

SimulationAppEndpointInfoTypeDef#

# SimulationAppEndpointInfoTypeDef definition

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

LoggingConfigurationTypeDef#

# LoggingConfigurationTypeDef definition

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

DescribeAppOutputTypeDef#

# 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 definition

class DescribeSimulationOutputTypeDef(TypedDict):
    Arn: str,
    CreationTime: 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