SimSpaceWeaver / Client / describe_simulation

describe_simulation#

SimSpaceWeaver.Client.describe_simulation(**kwargs)#

Returns the current state of the given simulation.

See also: AWS API Documentation

Request Syntax

response = client.describe_simulation(
    Simulation='string'
)
Parameters:

Simulation (string) –

[REQUIRED]

The name of the simulation.

Return type:

dict

Returns:

Response Syntax

{
    'Arn': 'string',
    'CreationTime': datetime(2015, 1, 1),
    'Description': 'string',
    'ExecutionId': 'string',
    'LiveSimulationState': {
        'Clocks': [
            {
                'Status': 'UNKNOWN'|'STARTING'|'STARTED'|'STOPPING'|'STOPPED',
                'TargetStatus': 'UNKNOWN'|'STARTED'|'STOPPED'
            },
        ],
        'Domains': [
            {
                'Lifecycle': 'Unknown'|'PerWorker'|'BySpatialSubdivision'|'ByRequest',
                'Name': 'string'
            },
        ]
    },
    'LoggingConfiguration': {
        'Destinations': [
            {
                'CloudWatchLogsLogGroup': {
                    'LogGroupArn': 'string'
                }
            },
        ]
    },
    'MaximumDuration': 'string',
    'Name': 'string',
    'RoleArn': 'string',
    'SchemaError': 'string',
    'SchemaS3Location': {
        'BucketName': 'string',
        'ObjectKey': 'string'
    },
    'SnapshotS3Location': {
        'BucketName': 'string',
        'ObjectKey': 'string'
    },
    'StartError': 'string',
    'Status': 'UNKNOWN'|'STARTING'|'STARTED'|'STOPPING'|'STOPPED'|'FAILED'|'DELETING'|'DELETED'|'SNAPSHOT_IN_PROGRESS',
    'TargetStatus': 'UNKNOWN'|'STARTED'|'STOPPED'|'DELETED'
}

Response Structure

  • (dict) –

    • Arn (string) –

      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.

    • CreationTime (datetime) –

      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 (string) –

      The description of the simulation.

    • ExecutionId (string) –

      A universally unique identifier (UUID) for this simulation.

    • LiveSimulationState (dict) –

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

      • Clocks (list) –

        A list of simulation clocks.

        Note

        At this time, a simulation has only one clock.

        • (dict) –

          Status information about the simulation clock.

          • Status (string) –

            The current status of the simulation clock.

          • TargetStatus (string) –

            The desired status of the simulation clock.

      • Domains (list) –

        A list of domains for the simulation. For more information about domains, see Key concepts: Domains in the SimSpace Weaver User Guide.

        • (dict) –

          A collection of app instances that run the same executable app code and have the same launch options and commands.

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

          • Lifecycle (string) –

            The type of lifecycle management for apps in the domain. Indicates whether apps in this domain are managed (SimSpace Weaver starts and stops the apps) or unmanaged (you must start and stop the apps).

            Lifecycle types

            • PerWorker – Managed: SimSpace Weaver starts one app on each worker.

            • BySpatialSubdivision – Managed: SimSpace Weaver starts one app for each spatial partition.

            • ByRequest – Unmanaged: You use the StartApp API to start the apps and use the StopApp API to stop the apps.

          • Name (string) –

            The name of the domain.

    • LoggingConfiguration (dict) –

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

      • Destinations (list) –

        A list of the locations where SimSpace Weaver sends simulation log data.

        • (dict) –

          The location where SimSpace Weaver sends simulation log data.

          • CloudWatchLogsLogGroup (dict) –

            An Amazon CloudWatch Logs log group that stores simulation log data. For more information about log groups, see Working with log groups and log streams in the Amazon CloudWatch Logs User Guide.

            • LogGroupArn (string) –

              The Amazon Resource Name (ARN) of the Amazon CloudWatch Logs log group for the simulation. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference. For more information about log groups, see Working with log groups and log streams in the Amazon CloudWatch Logs User Guide.

    • MaximumDuration (string) –

      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 (string) –

      The name of the simulation.

    • RoleArn (string) –

      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.

    • SchemaError (string) –

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

    • SchemaS3Location (dict) –

      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.

    • SnapshotS3Location (dict) –

      A location in Amazon Simple Storage Service (Amazon S3) where SimSpace Weaver stores simulation data, such as your app .zip files and schema file. For more information about Amazon S3, see the Amazon Simple Storage Service User Guide.

    • StartError (string) –

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

    • Status (string) –

      The current lifecycle state of the simulation.

    • TargetStatus (string) –

      The desired lifecycle state of the simulation.

Exceptions