Skip to content
AWS for Query.Farm

aws.sagemaker.describe_space

Example SQL Queries

SELECT * FROM
aws.sagemaker.describe_space
WHERE
"domain_id" = 'VALUE'
AND "space_name" = 'VALUE';

Description

Describes the space.

Table Definition

Column NameColumn Data Type
domain_id Required Input Column

The ID of the associated domain.

VARCHAR
space_name Required Input Column

The name of the space.

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.

creation_time

The creation time.

TIMESTAMP_S
failure_reason

The failure reason.

VARCHAR
home_efs_file_system_uid

The ID of the space's profile in the Amazon EFS volume.

VARCHAR
last_modified_time

The last modified time.

TIMESTAMP_S
ownership_settings

The collection of ownership settings for a space.

STRUCT(
    "owner_user_profile_name" VARCHAR
)
Show child fields
ownership_settings.owner_user_profile_name

The user profile who is the owner of the space.

space_arn

The space's Amazon Resource Name (ARN).

VARCHAR
space_display_name

The name of the space that appears in the Amazon SageMaker Studio UI.

VARCHAR
space_settings

A collection of space settings.

STRUCT(
    "jupyter_server_app_settings" STRUCT(
        "default_resource_spec" 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
        ),
        "lifecycle_config_arns" VARCHAR[],
        "code_repositories" STRUCT(
            "repository_url" VARCHAR
        )[]
    ),
    "kernel_gateway_app_settings" STRUCT(
        "default_resource_spec" 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
        ),
        "custom_images" STRUCT(
            "image_name" VARCHAR,
            "image_version_number" BIGINT,
            "app_image_config_name" VARCHAR
        )[],
        "lifecycle_config_arns" VARCHAR[]
    ),
    "code_editor_app_settings" STRUCT(
        "default_resource_spec" 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
        )
    ),
    "jupyter_lab_app_settings" STRUCT(
        "default_resource_spec" 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
        ),
        "code_repositories" STRUCT(
            "repository_url" VARCHAR
        )[]
    ),
    "app_type" VARCHAR,
    "space_storage_settings" STRUCT(
        "ebs_storage_settings" STRUCT(
            "ebs_volume_size_in_gb" BIGINT
        )
    ),
    "custom_file_systems" STRUCT(
        "efs_file_system" STRUCT(
            "file_system_id" VARCHAR
        )
    )[]
)
Show child fields
space_settings.app_type

The type of app created within the space.

space_settings.code_editor_app_settings

The Code Editor application settings.

Show child fields
space_settings.code_editor_app_settings.default_resource_spec

Specifies the ARN's of a SageMaker image and SageMaker image version, and the instance type that the version runs on.

Show child fields
space_settings.code_editor_app_settings.default_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.

space_settings.code_editor_app_settings.default_resource_spec.lifecycle_config_arn

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

space_settings.code_editor_app_settings.default_resource_spec.sage_maker_image_arn

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

space_settings.code_editor_app_settings.default_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.

space_settings.code_editor_app_settings.default_resource_spec.sage_maker_image_version_arn

The ARN of the image version created on the instance.

space_settings.custom_file_systems[]
Show child fields
space_settings.custom_file_systems[].efs_file_system

A custom file system in Amazon EFS.

Show child fields
space_settings.custom_file_systems[].efs_file_system.file_system_id

The ID of your Amazon EFS file system.

space_settings.jupyter_lab_app_settings

The settings for the JupyterLab application.

Show child fields
space_settings.jupyter_lab_app_settings.code_repositories[]
Show child fields
space_settings.jupyter_lab_app_settings.code_repositories[].repository_url

The URL of the Git repository.

space_settings.jupyter_lab_app_settings.default_resource_spec

Specifies the ARN's of a SageMaker image and SageMaker image version, and the instance type that the version runs on.

Show child fields
space_settings.jupyter_lab_app_settings.default_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.

space_settings.jupyter_lab_app_settings.default_resource_spec.lifecycle_config_arn

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

space_settings.jupyter_lab_app_settings.default_resource_spec.sage_maker_image_arn

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

space_settings.jupyter_lab_app_settings.default_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.

space_settings.jupyter_lab_app_settings.default_resource_spec.sage_maker_image_version_arn

The ARN of the image version created on the instance.

space_settings.jupyter_server_app_settings

The JupyterServer app settings.

Show child fields
space_settings.jupyter_server_app_settings.code_repositories[]
Show child fields
space_settings.jupyter_server_app_settings.code_repositories[].repository_url

The URL of the Git repository.

space_settings.jupyter_server_app_settings.default_resource_spec

The default instance type and the Amazon Resource Name (ARN) of the default SageMaker image used by the JupyterServer app. If you use the LifecycleConfigArns parameter, then this parameter is also required.

Show child fields
space_settings.jupyter_server_app_settings.default_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.

space_settings.jupyter_server_app_settings.default_resource_spec.lifecycle_config_arn

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

space_settings.jupyter_server_app_settings.default_resource_spec.sage_maker_image_arn

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

space_settings.jupyter_server_app_settings.default_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.

space_settings.jupyter_server_app_settings.default_resource_spec.sage_maker_image_version_arn

The ARN of the image version created on the instance.

space_settings.jupyter_server_app_settings.lifecycle_config_arns[]
space_settings.kernel_gateway_app_settings

The KernelGateway app settings.

Show child fields
space_settings.kernel_gateway_app_settings.custom_images[]
Show child fields
space_settings.kernel_gateway_app_settings.custom_images[].app_image_config_name

The name of the AppImageConfig.

space_settings.kernel_gateway_app_settings.custom_images[].image_name

The name of the CustomImage. Must be unique to your account.

space_settings.kernel_gateway_app_settings.custom_images[].image_version_number

The version number of the CustomImage.

space_settings.kernel_gateway_app_settings.default_resource_spec

The default instance type and the Amazon Resource Name (ARN) of the default SageMaker image used by the KernelGateway app.

The Amazon SageMaker Studio UI does not use the default instance type value set here. The default instance type set here is used when Apps are created using the CLI or CloudFormation and the instance type parameter value is not passed.

Show child fields
space_settings.kernel_gateway_app_settings.default_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.

space_settings.kernel_gateway_app_settings.default_resource_spec.lifecycle_config_arn

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

space_settings.kernel_gateway_app_settings.default_resource_spec.sage_maker_image_arn

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

space_settings.kernel_gateway_app_settings.default_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.

space_settings.kernel_gateway_app_settings.default_resource_spec.sage_maker_image_version_arn

The ARN of the image version created on the instance.

space_settings.kernel_gateway_app_settings.lifecycle_config_arns[]
space_settings.space_storage_settings

The storage settings for a space.

Show child fields
space_settings.space_storage_settings.ebs_storage_settings

A collection of EBS storage settings for a space.

Show child fields
space_settings.space_storage_settings.ebs_storage_settings.ebs_volume_size_in_gb

The size of an EBS storage volume for a space.

space_sharing_settings

The collection of space sharing settings for a space.

STRUCT(
    "sharing_type" VARCHAR
)
Show child fields
space_sharing_settings.sharing_type

Specifies the sharing type of the space.

status

The status.

VARCHAR
url

Returns the URL of the space. If the space is created with Amazon Web Services IAM Identity Center (Successor to Amazon Web Services Single Sign-On) authentication, users can navigate to the URL after appending the respective redirect parameter for the application type to be federated through Amazon Web Services IAM Identity Center.

The following application types are supported:

  • Studio Classic: &redirect=JupyterServer

  • JupyterLab: &redirect=JupyterLab

  • Code Editor, based on Code-OSS, Visual Studio Code - Open Source: &redirect=CodeEditor 

VARCHAR