Skip to content
AWS for Query.Farm

aws.simspaceweaver.describe_app

Example SQL Queries

SELECT * FROM
aws.simspaceweaver.describe_app
WHERE
"app" = 'VALUE'
AND "domain" = 'VALUE'
AND "simulation" = 'VALUE';

Description

Returns the state of the given custom app.

Table Definition

Column NameColumn Data Type
app Required Input Column

The name of the app.

VARCHAR
domain Required Input Column

The name of the domain of the app.

VARCHAR
simulation Required Input Column

The name of the simulation of the app.

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
description

The description of the app.

VARCHAR
endpoint_info

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

STRUCT(
    "address" VARCHAR,
    "ingress_port_mappings" STRUCT(
        "actual" BIGINT,
        "declared" BIGINT
    )[]
)
Show child fields
endpoint_info.address

The IP address of the app. SimSpace Weaver dynamically assigns this IP address when the app starts.

endpoint_info.ingress_port_mappings[]
Show child fields
endpoint_info.ingress_port_mappings[].actual

The TCP/UDP port number of the running app. SimSpace Weaver dynamically assigns this port number when the app starts. SimSpace Weaver maps the Declared port to the Actual port. Clients connect to the app using the app's IP address and the Actual port number.

endpoint_info.ingress_port_mappings[].declared

The TCP/UDP port number of the app, declared in the simulation schema. SimSpace Weaver maps the Declared port to the Actual port. The source code for the app should bind to the Declared port.

launch_overrides

Options that apply when the app starts. These options override default behavior.

STRUCT(
    "launch_commands" VARCHAR[]
)
Show child fields
launch_overrides.launch_commands[]
name

The name of the app.

VARCHAR
status

The current lifecycle state of the custom app.

VARCHAR
target_status

The desired lifecycle state of the custom app.

VARCHAR