Typed dictionaries

Index > SimSpaceWeaver > Typed dictionaries

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

CloudWatchLogsLogGroupTypeDef

Usage Example

from mypy_boto3_simspaceweaver.type_defs import CloudWatchLogsLogGroupTypeDef

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

Definition

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

DeleteAppInputRequestTypeDef

Usage Example

from mypy_boto3_simspaceweaver.type_defs import DeleteAppInputRequestTypeDef

def get_value() -> DeleteAppInputRequestTypeDef:
    return {
        "App": ...,
        "Domain": ...,
        "Simulation": ...,
    }

Definition

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

DeleteSimulationInputRequestTypeDef

Usage Example

from mypy_boto3_simspaceweaver.type_defs import DeleteSimulationInputRequestTypeDef

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

Definition

class DeleteSimulationInputRequestTypeDef(TypedDict):
    Simulation: str,

DescribeAppInputRequestTypeDef

Usage Example

from mypy_boto3_simspaceweaver.type_defs import DescribeAppInputRequestTypeDef

def get_value() -> DescribeAppInputRequestTypeDef:
    return {
        "App": ...,
        "Domain": ...,
        "Simulation": ...,
    }

Definition

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

LaunchOverridesTypeDef

Usage Example

from mypy_boto3_simspaceweaver.type_defs import LaunchOverridesTypeDef

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

Definition

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

ResponseMetadataTypeDef

Usage Example

from mypy_boto3_simspaceweaver.type_defs import ResponseMetadataTypeDef

def get_value() -> ResponseMetadataTypeDef:
    return {
        "RequestId": ...,
        "HostId": ...,
        "HTTPStatusCode": ...,
        "HTTPHeaders": ...,
        "RetryAttempts": ...,
    }

Definition

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

DescribeSimulationInputRequestTypeDef

Usage Example

from mypy_boto3_simspaceweaver.type_defs import DescribeSimulationInputRequestTypeDef

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

Definition

class DescribeSimulationInputRequestTypeDef(TypedDict):
    Simulation: str,

S3LocationTypeDef

Usage Example

from mypy_boto3_simspaceweaver.type_defs import S3LocationTypeDef

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

Definition

class S3LocationTypeDef(TypedDict):
    BucketName: NotRequired[str],
    ObjectKey: NotRequired[str],

DomainTypeDef

Usage Example

from mypy_boto3_simspaceweaver.type_defs import DomainTypeDef

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

Definition

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

1. See LifecycleManagementStrategyType

ListAppsInputRequestTypeDef

Usage Example

from mypy_boto3_simspaceweaver.type_defs import ListAppsInputRequestTypeDef

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

Definition

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

SimulationAppMetadataTypeDef

Usage Example

from mypy_boto3_simspaceweaver.type_defs import SimulationAppMetadataTypeDef

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

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

Usage Example

from mypy_boto3_simspaceweaver.type_defs import ListSimulationsInputRequestTypeDef

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

Definition

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

SimulationMetadataTypeDef

Usage Example

from mypy_boto3_simspaceweaver.type_defs import SimulationMetadataTypeDef

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

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

Usage Example

from mypy_boto3_simspaceweaver.type_defs import ListTagsForResourceInputRequestTypeDef

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

Definition

class ListTagsForResourceInputRequestTypeDef(TypedDict):
    ResourceArn: str,

SimulationClockTypeDef

Usage Example

from mypy_boto3_simspaceweaver.type_defs import SimulationClockTypeDef

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

Definition

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

1. See ClockStatusType
2. See ClockTargetStatusType

SimulationAppPortMappingTypeDef

Usage Example

from mypy_boto3_simspaceweaver.type_defs import SimulationAppPortMappingTypeDef

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

Definition

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

StartClockInputRequestTypeDef

Usage Example

from mypy_boto3_simspaceweaver.type_defs import StartClockInputRequestTypeDef

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

Definition

class StartClockInputRequestTypeDef(TypedDict):
    Simulation: str,

StopAppInputRequestTypeDef

Usage Example

from mypy_boto3_simspaceweaver.type_defs import StopAppInputRequestTypeDef

def get_value() -> StopAppInputRequestTypeDef:
    return {
        "App": ...,
        "Domain": ...,
        "Simulation": ...,
    }

Definition

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

StopClockInputRequestTypeDef

Usage Example

from mypy_boto3_simspaceweaver.type_defs import StopClockInputRequestTypeDef

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

Definition

class StopClockInputRequestTypeDef(TypedDict):
    Simulation: str,

StopSimulationInputRequestTypeDef

Usage Example

from mypy_boto3_simspaceweaver.type_defs import StopSimulationInputRequestTypeDef

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

Definition

class StopSimulationInputRequestTypeDef(TypedDict):
    Simulation: str,

TagResourceInputRequestTypeDef

Usage Example

from mypy_boto3_simspaceweaver.type_defs import TagResourceInputRequestTypeDef

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

Definition

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

UntagResourceInputRequestTypeDef

Usage Example

from mypy_boto3_simspaceweaver.type_defs import UntagResourceInputRequestTypeDef

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

Definition

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

LogDestinationTypeDef

Usage Example

from mypy_boto3_simspaceweaver.type_defs import LogDestinationTypeDef

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

Definition

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

1. See CloudWatchLogsLogGroupTypeDef

StartAppInputRequestTypeDef

Usage Example

from mypy_boto3_simspaceweaver.type_defs import StartAppInputRequestTypeDef

def get_value() -> StartAppInputRequestTypeDef:
    return {
        "Domain": ...,
        "Name": ...,
        "Simulation": ...,
    }

Definition

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

1. See LaunchOverridesTypeDef

ListTagsForResourceOutputTypeDef

Usage Example

from mypy_boto3_simspaceweaver.type_defs import ListTagsForResourceOutputTypeDef

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

Definition

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

1. See ResponseMetadataTypeDef

StartAppOutputTypeDef

Usage Example

from mypy_boto3_simspaceweaver.type_defs import StartAppOutputTypeDef

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

Definition

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

1. See ResponseMetadataTypeDef

StartSimulationOutputTypeDef

Usage Example

from mypy_boto3_simspaceweaver.type_defs import StartSimulationOutputTypeDef

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

Definition

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

1. See ResponseMetadataTypeDef

StartSimulationInputRequestTypeDef

Usage Example

from mypy_boto3_simspaceweaver.type_defs import StartSimulationInputRequestTypeDef

def get_value() -> StartSimulationInputRequestTypeDef:
    return {
        "Name": ...,
        "RoleArn": ...,
        "SchemaS3Location": ...,
    }

Definition

class StartSimulationInputRequestTypeDef(TypedDict):
    Name: str,
    RoleArn: str,
    SchemaS3Location: S3LocationTypeDef,  # (1)
    ClientToken: NotRequired[str],
    Description: NotRequired[str],
    MaximumDuration: NotRequired[str],
    Tags: NotRequired[Mapping[str, str]],

1. See S3LocationTypeDef

ListAppsOutputTypeDef

Usage Example

from mypy_boto3_simspaceweaver.type_defs import ListAppsOutputTypeDef

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

Definition

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

1. See SimulationAppMetadataTypeDef
2. See ResponseMetadataTypeDef

ListSimulationsOutputTypeDef

Usage Example

from mypy_boto3_simspaceweaver.type_defs import ListSimulationsOutputTypeDef

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

Definition

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

1. See SimulationMetadataTypeDef
2. See ResponseMetadataTypeDef

LiveSimulationStateTypeDef

Usage Example

from mypy_boto3_simspaceweaver.type_defs import LiveSimulationStateTypeDef

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

Definition

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

1. See SimulationClockTypeDef
2. See DomainTypeDef

SimulationAppEndpointInfoTypeDef

Usage Example

from mypy_boto3_simspaceweaver.type_defs import SimulationAppEndpointInfoTypeDef

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

Definition

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

1. See SimulationAppPortMappingTypeDef

LoggingConfigurationTypeDef

Usage Example

from mypy_boto3_simspaceweaver.type_defs import LoggingConfigurationTypeDef

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

Definition

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

1. See LogDestinationTypeDef

DescribeAppOutputTypeDef

Usage Example

from mypy_boto3_simspaceweaver.type_defs import DescribeAppOutputTypeDef

def get_value() -> DescribeAppOutputTypeDef:
    return {
        "Description": ...,
        "Domain": ...,
        "EndpointInfo": ...,
        "LaunchOverrides": ...,
        "Name": ...,
        "Simulation": ...,
        "Status": ...,
        "TargetStatus": ...,
        "ResponseMetadata": ...,
    }

Definition

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

1. See SimulationAppEndpointInfoTypeDef
2. See LaunchOverridesTypeDef
3. See SimulationAppStatusType
4. See SimulationAppTargetStatusType
5. See ResponseMetadataTypeDef

DescribeSimulationOutputTypeDef

Usage Example

from mypy_boto3_simspaceweaver.type_defs import DescribeSimulationOutputTypeDef

def get_value() -> DescribeSimulationOutputTypeDef:
    return {
        "Arn": ...,
        "CreationTime": ...,
        "Description": ...,
        "ExecutionId": ...,
        "LiveSimulationState": ...,
        "LoggingConfiguration": ...,
        "MaximumDuration": ...,
        "Name": ...,
        "RoleArn": ...,
        "SchemaError": ...,
        "SchemaS3Location": ...,
        "Status": ...,
        "TargetStatus": ...,
        "ResponseMetadata": ...,
    }

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)
    Status: SimulationStatusType,  # (4)
    TargetStatus: SimulationTargetStatusType,  # (5)
    ResponseMetadata: ResponseMetadataTypeDef,  # (6)

1. See LiveSimulationStateTypeDef
2. See LoggingConfigurationTypeDef
3. See S3LocationTypeDef
4. See SimulationStatusType
5. See SimulationTargetStatusType
6. See ResponseMetadataTypeDef