Skip to content

DescribeAppOutput

Source code in docs_src/capo_simspaceweaver/types/describe_app_output.py
class DescribeAppOutput(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 name of the domain of the app.</p>"""
    status: NotRequired[
        "capo_simspaceweaver.types.simulation_app_status.SimulationAppStatus"
    ]
    """<p>The current lifecycle state of the custom app.</p>"""
    target_status: NotRequired[
        "capo_simspaceweaver.types.simulation_app_target_status.SimulationAppTargetStatus"
    ]
    """<p>The desired lifecycle state of the custom app.</p>"""
    launch_overrides: NotRequired[
        "capo_simspaceweaver.types.launch_overrides.LaunchOverrides"
    ]
    description: NotRequired["capo_simspaceweaver.types.description.Description"]
    """<p>The description of the app.</p>"""
    endpoint_info: NotRequired[
        "capo_simspaceweaver.types.simulation_app_endpoint_info.SimulationAppEndpointInfo"
    ]
    """<p>Information about the network endpoint for the custom app. You can use the endpoint to connect to the custom app.</p>"""

description instance-attribute

description: NotRequired[Description]

The description of the app.

domain instance-attribute

domain: NotRequired[SimSpaceWeaverResourceName]

The name of the domain of the app.

endpoint_info instance-attribute

endpoint_info: NotRequired[SimulationAppEndpointInfo]

Information about the network endpoint for the custom app. You can use the endpoint to connect to the custom app.

launch_overrides instance-attribute

launch_overrides: NotRequired[LaunchOverrides]

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 lifecycle state of the custom app.

target_status instance-attribute

target_status: NotRequired[SimulationAppTargetStatus]

The desired lifecycle state of the custom app.