Skip to content
AWS for Query.Farm

aws.simspaceweaver.list_apps

Example SQL Queries

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

Description

Lists all custom apps or service apps for the given simulation and domain.

Table Definition

Column NameColumn Data Type
simulation Required Input Column

The name of the simulation that you want to list apps for.

VARCHAR
domain Input Column

The name of the domain that you want to list apps for.

VARCHAR
max_results Input Column

The maximum number of apps to list.

BIGINT
next_token Input Column

If SimSpace Weaver returns nextToken, then there are more results available. The value of nextToken is a unique pagination token for each page. To retrieve the next page, call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, then nextToken is set to null. Each pagination token expires after 24 hours. If you provide a token that isn't valid, then you receive an HTTP 400 ValidationException error.

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
apps

The list of apps for the given simulation and domain.

STRUCT(
    "domain" VARCHAR,
    "name" VARCHAR,
    "simulation" VARCHAR,
    "status" VARCHAR,
    "target_status" VARCHAR
)[]
Show child fields
apps[]
Show child fields
apps[].domain

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

apps[].name

The name of the app.

apps[].simulation

The name of the simulation of the app.

apps[].status

The current status of the app.

apps[].target_status

The desired status of the app.