Skip to content

DescribeSimulationOutput

Source code in docs_src/capo_simspaceweaver/types/describe_simulation_output.py
class DescribeSimulationOutput(TypedDict, closed=True):
    name: NotRequired[
        "capo_simspaceweaver.types.sim_space_weaver_resource_name.SimSpaceWeaverResourceName"
    ]
    """<p>The name of the simulation.</p>"""
    execution_id: NotRequired["capo_simspaceweaver.types.uuid.UUID"]
    """<p>A universally unique identifier (UUID) for this simulation.</p>"""
    arn: NotRequired["capo_simspaceweaver.types.sim_space_weaver_arn.SimSpaceWeaverArn"]
    """<p>The Amazon Resource Name (ARN) of the simulation. For more information about ARNs, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs)</a> in the <i>Amazon Web Services General Reference</i>.</p>"""
    description: NotRequired["capo_simspaceweaver.types.description.Description"]
    """<p>The description of the simulation.</p>"""
    role_arn: NotRequired["capo_simspaceweaver.types.role_arn.RoleArn"]
    """<p>The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that the simulation assumes to perform actions. For more information about ARNs, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs)</a> in the <i>Amazon Web Services General Reference</i>. For more information about IAM roles, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html">IAM roles</a> in the <i>Identity and Access Management User Guide</i>.</p>"""
    creation_time: NotRequired["capo_simspaceweaver.types.timestamp.Timestamp"]
    """<p>The time when the simulation was created, expressed as the number of seconds and milliseconds in UTC since the Unix epoch (0:0:0.000, January 1, 1970).</p>"""
    status: NotRequired["capo_simspaceweaver.types.simulation_status.SimulationStatus"]
    """<p>The current lifecycle state of the simulation.</p>"""
    target_status: NotRequired[
        "capo_simspaceweaver.types.simulation_target_status.SimulationTargetStatus"
    ]
    """<p>The desired lifecycle state of the simulation.</p>"""
    schema_s3_location: NotRequired["capo_simspaceweaver.types.s3_location.S3Location"]
    """<p>The location of the simulation schema in Amazon Simple Storage Service (Amazon S3). For more information about Amazon S3, see the <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/Welcome.html"> <i>Amazon Simple Storage Service User Guide</i> </a>.</p>"""
    schema_error: NotRequired[
        "capo_simspaceweaver.types.optional_string.OptionalString"
    ]
    """<p>An error message that SimSpace Weaver returns only if there is a problem with the simulation schema.</p>"""
    logging_configuration: NotRequired[
        "capo_simspaceweaver.types.logging_configuration.LoggingConfiguration"
    ]
    """<p>Settings that control how SimSpace Weaver handles your simulation log data.</p>"""
    live_simulation_state: NotRequired[
        "capo_simspaceweaver.types.live_simulation_state.LiveSimulationState"
    ]
    """<p>A collection of additional state information, such as domain and clock configuration.</p>"""
    maximum_duration: NotRequired[
        "capo_simspaceweaver.types.time_to_live_string.TimeToLiveString"
    ]
    """<p>The maximum running time of the simulation, specified as a number of minutes (m or M), hours (h or H), or days (d or D). The simulation stops when it reaches this limit. The maximum value is <code>14D</code>, or its equivalent in the other units. The default value is <code>14D</code>. A value equivalent to <code>0</code> makes the simulation immediately transition to <code>Stopping</code> as soon as it reaches <code>Started</code>.</p>"""
    snapshot_s3_location: NotRequired[
        "capo_simspaceweaver.types.s3_location.S3Location"
    ]
    start_error: NotRequired["capo_simspaceweaver.types.optional_string.OptionalString"]
    """<p>An error message that SimSpace Weaver returns only if a problem occurs when the simulation is in the <code>STARTING</code> state.</p>"""

arn instance-attribute

arn: NotRequired[SimSpaceWeaverArn]

The Amazon Resource Name (ARN) of the simulation. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

creation_time instance-attribute

creation_time: NotRequired[Timestamp]

The time when the simulation was created, expressed as the number of seconds and milliseconds in UTC since the Unix epoch (0:0:0.000, January 1, 1970).

description instance-attribute

description: NotRequired[Description]

The description of the simulation.

execution_id instance-attribute

execution_id: NotRequired[UUID]

A universally unique identifier (UUID) for this simulation.

live_simulation_state instance-attribute

live_simulation_state: NotRequired[LiveSimulationState]

A collection of additional state information, such as domain and clock configuration.

logging_configuration instance-attribute

logging_configuration: NotRequired[LoggingConfiguration]

Settings that control how SimSpace Weaver handles your simulation log data.

maximum_duration instance-attribute

maximum_duration: NotRequired[TimeToLiveString]

The maximum running time of the simulation, specified as a number of minutes (m or M), hours (h or H), or days (d or D). The simulation stops when it reaches this limit. The maximum value is 14D, or its equivalent in the other units. The default value is 14D. A value equivalent to 0 makes the simulation immediately transition to Stopping as soon as it reaches Started.

name instance-attribute

name: NotRequired[SimSpaceWeaverResourceName]

The name of the simulation.

role_arn instance-attribute

role_arn: NotRequired[RoleArn]

The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that the simulation assumes to perform actions. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference. For more information about IAM roles, see IAM roles in the Identity and Access Management User Guide.

schema_error instance-attribute

schema_error: NotRequired[OptionalString]

An error message that SimSpace Weaver returns only if there is a problem with the simulation schema.

schema_s3_location instance-attribute

schema_s3_location: NotRequired[S3Location]

The location of the simulation schema in Amazon Simple Storage Service (Amazon S3). For more information about Amazon S3, see the Amazon Simple Storage Service User Guide .

snapshot_s3_location instance-attribute

snapshot_s3_location: NotRequired[S3Location]

start_error instance-attribute

start_error: NotRequired[OptionalString]

An error message that SimSpace Weaver returns only if a problem occurs when the simulation is in the STARTING state.

status instance-attribute

status: NotRequired[SimulationStatus]

The current lifecycle state of the simulation.

target_status instance-attribute

target_status: NotRequired[SimulationTargetStatus]

The desired lifecycle state of the simulation.