Skip to content
AWS for Query.Farm

aws.sagemaker.describe_app

Example SQL Queries

SELECT * FROM
aws.sagemaker.describe_app
WHERE
"domain_id" = 'VALUE'
AND "app_type" = 'VALUE'
AND "app_name" = 'VALUE';

Description

Describes the app.

Table Definition

Column NameColumn Data Type
app_name Required Input Column

The name of the app.

VARCHAR
app_type Required Input Column

The type of app.

VARCHAR
domain_id Required Input Column

The domain ID.

VARCHAR
space_name Input Column

The name of the space. If this value is not set, then UserProfileName must be set.

VARCHAR
user_profile_name Input Column

The user profile name.

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.

app_arn

The Amazon Resource Name (ARN) of the app.

VARCHAR
creation_time

The creation time of the application.

After an application has been shut down for 24 hours, SageMaker deletes all metadata for the application. To be considered an update and retain application metadata, applications must be restarted within 24 hours after the previous application has been shut down. After this time window, creation of an application is considered a new application rather than an update of the previous application.

TIMESTAMP_S
failure_reason

The failure reason.

VARCHAR
last_health_check_timestamp

The timestamp of the last health check.

TIMESTAMP_S
last_user_activity_timestamp

The timestamp of the last user's activity. LastUserActivityTimestamp is also updated when SageMaker performs health checks without user activity. As a result, this value is set to the same value as LastHealthCheckTimestamp.

TIMESTAMP_S
resource_spec

The instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance.

STRUCT(
    "sage_maker_image_arn" VARCHAR,
    "sage_maker_image_version_arn" VARCHAR,
    "sage_maker_image_version_alias" VARCHAR,
    "instance_type" VARCHAR,
    "lifecycle_config_arn" VARCHAR
)
Show child fields
resource_spec.instance_type

The instance type that the image version runs on.

JupyterServer apps only support the system value.

For KernelGateway apps, the system value is translated to ml.t3.medium. KernelGateway apps also support all other values for available instance types.

resource_spec.lifecycle_config_arn

The Amazon Resource Name (ARN) of the Lifecycle Configuration attached to the Resource.

resource_spec.sage_maker_image_arn

The ARN of the SageMaker image that the image version belongs to.

resource_spec.sage_maker_image_version_alias

The SageMakerImageVersionAlias of the image to launch with. This value is in SemVer 2.0.0 versioning format.

resource_spec.sage_maker_image_version_arn

The ARN of the image version created on the instance.

status

The status.

VARCHAR