Skip to content

SimulationAppMetadata

Source code in docs_src/capo_simspaceweaver/types/simulation_app_metadata.py
class SimulationAppMetadata(TypedDict, closed=True):
    name: NotRequired[
        "capo_simspaceweaver.types.sim_space_weaver_long_resource_name.SimSpaceWeaverLongResourceName"
    ]
    """<p>The name of the app.</p>"""
    simulation: NotRequired[
        "capo_simspaceweaver.types.sim_space_weaver_resource_name.SimSpaceWeaverResourceName"
    ]
    """<p>The name of the simulation of the app.</p>"""
    domain: NotRequired[
        "capo_simspaceweaver.types.sim_space_weaver_resource_name.SimSpaceWeaverResourceName"
    ]
    """<p>The domain of the app. For more information about domains, see <a href="https://docs.aws.amazon.com/simspaceweaver/latest/userguide/what-is_key-concepts.html#what-is_key-concepts_domains">Key concepts: Domains</a> in the <i>SimSpace Weaver User Guide</i>.</p>"""
    status: NotRequired[
        "capo_simspaceweaver.types.simulation_app_status.SimulationAppStatus"
    ]
    """<p>The current status of the app.</p>"""
    target_status: NotRequired[
        "capo_simspaceweaver.types.simulation_app_target_status.SimulationAppTargetStatus"
    ]
    """<p>The desired status of the app.</p>"""

domain instance-attribute

domain: NotRequired[SimSpaceWeaverResourceName]

The domain of the app. For more information about domains, see Key concepts: Domains in the SimSpace Weaver User Guide.

name instance-attribute

name: NotRequired[SimSpaceWeaverLongResourceName]

The name of the app.

simulation instance-attribute

simulation: NotRequired[SimSpaceWeaverResourceName]

The name of the simulation of the app.

status instance-attribute

status: NotRequired[SimulationAppStatus]

The current status of the app.

target_status instance-attribute

target_status: NotRequired[SimulationAppTargetStatus]

The desired status of the app.