Skip to content
AWS for Query.Farm

aws.simspaceweaver.describe_simulation

Example SQL Queries

SELECT * FROM
aws.simspaceweaver.describe_simulation
WHERE
"simulation" = 'VALUE';

Description

Returns the current state of the given simulation.

Table Definition

Column NameColumn Data Type
simulation Required Input Column

The name of the simulation.

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
    "type" VARCHAR,
    "name" VARCHAR,
    "account_id" VARCHAR,
    "via_profile_name" VARCHAR,
    "assumed_role_arn" VARCHAR,
    "organization" STRUCT(
        "account_name" VARCHAR,
        "id" VARCHAR,
        "tags" STRUCT(
            "key" VARCHAR,
            "value" VARCHAR
        )[],
        "master_account" STRUCT(
            "id" VARCHAR,
            "email" VARCHAR
        ),
        "parents" STRUCT(
            "type" VARCHAR,
            "id" VARCHAR,
            "name" VARCHAR,
            "tags" STRUCT(
                "key" VARCHAR,
                "value" VARCHAR
            )[]
        )[]
    )
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

_aws_region Input Column

The AWS region to use.

VARCHAR
arn

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.

VARCHAR
creation_time

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).

TIMESTAMP_S
description

The description of the simulation.

VARCHAR
execution_id

A universally unique identifier (UUID) for this simulation.

VARCHAR
live_simulation_state

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

STRUCT(
    "clocks" STRUCT(
        "status" VARCHAR,
        "target_status" VARCHAR
    )[],
    "domains" STRUCT(
        "lifecycle" VARCHAR,
        "name" VARCHAR
    )[]
)
Show child fields
live_simulation_state.clocks[]
Show child fields
live_simulation_state.clocks[].status

The current status of the simulation clock.

live_simulation_state.clocks[].target_status

The desired status of the simulation clock.

live_simulation_state.domains[]
Show child fields
live_simulation_state.domains[].lifecycle

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.

live_simulation_state.domains[].name

The name of the domain.

logging_configuration

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

STRUCT(
    "destinations" STRUCT(
        "cloud_watch_logs_log_group" STRUCT(
            "log_group_arn" VARCHAR
        )
    )[]
)
Show child fields
logging_configuration.destinations[]
Show child fields
logging_configuration.destinations[].cloud_watch_logs_log_group

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.

Show child fields
logging_configuration.destinations[].cloud_watch_logs_log_group.log_group_arn

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.

maximum_duration

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.

VARCHAR
name

The name of the simulation.

VARCHAR
role_arn

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.

VARCHAR
schema_error

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

VARCHAR
schema_s3_location

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 .

STRUCT(
    "bucket_name" VARCHAR,
    "object_key" VARCHAR
)
Show child fields
schema_s3_location.bucket_name

The name of an Amazon S3 bucket. For more information about buckets, see Creating, configuring, and working with Amazon S3 buckets in the Amazon Simple Storage Service User Guide.

schema_s3_location.object_key

The key name of an object in Amazon S3. For more information about Amazon S3 objects and object keys, see Uploading, downloading, and working with objects in Amazon S3 in the Amazon Simple Storage Service User Guide.

snapshot_s3_location

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 .

STRUCT(
    "bucket_name" VARCHAR,
    "object_key" VARCHAR
)
Show child fields
snapshot_s3_location.bucket_name

The name of an Amazon S3 bucket. For more information about buckets, see Creating, configuring, and working with Amazon S3 buckets in the Amazon Simple Storage Service User Guide.

snapshot_s3_location.object_key

The key name of an object in Amazon S3. For more information about Amazon S3 objects and object keys, see Uploading, downloading, and working with objects in Amazon S3 in the Amazon Simple Storage Service User Guide.

start_error

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

VARCHAR
status

The current lifecycle state of the simulation.

VARCHAR
target_status

The desired lifecycle state of the simulation.

VARCHAR