Skip to content
AWS for Query.Farm

aws.sagemaker.describe_domain

Example SQL Queries

SELECT * FROM
aws.sagemaker.describe_domain
WHERE
"domain_id" = 'VALUE';

Description

The description of the domain.

Table Definition

Column NameColumn Data Type
domain_id Required Input Column

The domain ID.

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_network_access_type

Specifies the VPC used for non-EFS traffic. The default value is PublicInternetOnly.

  • PublicInternetOnly - Non-EFS traffic is through a VPC managed by Amazon SageMaker, which allows direct internet access

  • VpcOnly - All traffic is through the specified VPC and subnets

VARCHAR
app_security_group_management

The entity that creates and manages the required security groups for inter-app communication in VPCOnly mode. Required when CreateDomain.AppNetworkAccessType is VPCOnly and DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn is provided.

VARCHAR
auth_mode

The domain's authentication mode.

VARCHAR
creation_time

The creation time.

TIMESTAMP_S
default_space_settings

The default settings used to create a space.

STRUCT(
    "execution_role" VARCHAR,
    "security_groups" VARCHAR[],
    "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[]
    ),
    "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
        ),
        "custom_images" STRUCT(
            "image_name" VARCHAR,
            "image_version_number" BIGINT,
            "app_image_config_name" VARCHAR
        )[],
        "lifecycle_config_arns" VARCHAR[],
        "code_repositories" STRUCT(
            "repository_url" VARCHAR
        )[],
        "emr_settings" STRUCT(
            "assumable_role_arns" VARCHAR[],
            "execution_role_arns" VARCHAR[]
        )
    ),
    "space_storage_settings" STRUCT(
        "default_ebs_storage_settings" STRUCT(
            "default_ebs_volume_size_in_gb" BIGINT,
            "maximum_ebs_volume_size_in_gb" BIGINT
        )
    ),
    "custom_posix_user_config" STRUCT(
        "uid" BIGINT,
        "gid" BIGINT
    ),
    "custom_file_system_configs" STRUCT(
        "efs_file_system_config" STRUCT(
            "file_system_id" VARCHAR,
            "file_system_path" VARCHAR
        )
    )[]
)
Show child fields
default_space_settings.custom_file_system_configs[]
Show child fields
default_space_settings.custom_file_system_configs[].efs_file_system_config

The settings for a custom Amazon EFS file system.

Show child fields
default_space_settings.custom_file_system_configs[].efs_file_system_config.file_system_id

The ID of your Amazon EFS file system.

default_space_settings.custom_file_system_configs[].efs_file_system_config.file_system_path

The path to the file system directory that is accessible in Amazon SageMaker Studio. Permitted users can access only this directory and below.

default_space_settings.custom_posix_user_config

Details about the POSIX identity that is used for file system operations.

Show child fields
default_space_settings.custom_posix_user_config.gid

The POSIX group ID.

default_space_settings.custom_posix_user_config.uid

The POSIX user ID.

default_space_settings.execution_role

The ARN of the execution role for the space.

default_space_settings.jupyter_lab_app_settings

The settings for the JupyterLab application.

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

The URL of the Git repository.

default_space_settings.jupyter_lab_app_settings.custom_images[]
Show child fields
default_space_settings.jupyter_lab_app_settings.custom_images[].app_image_config_name

The name of the AppImageConfig.

default_space_settings.jupyter_lab_app_settings.custom_images[].image_name

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

default_space_settings.jupyter_lab_app_settings.custom_images[].image_version_number

The version number of the CustomImage.

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

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

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

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

default_space_settings.jupyter_lab_app_settings.default_resource_spec.sage_maker_image_version_arn

The ARN of the image version created on the instance.

default_space_settings.jupyter_lab_app_settings.emr_settings

The configuration parameters that specify the IAM roles assumed by the execution role of SageMaker (assumable roles) and the cluster instances or job execution environments (execution roles or runtime roles) to manage and access resources required for running Amazon EMR clusters or Amazon EMR Serverless applications.

Show child fields
default_space_settings.jupyter_lab_app_settings.emr_settings.assumable_role_arns[]
default_space_settings.jupyter_lab_app_settings.emr_settings.execution_role_arns[]
default_space_settings.jupyter_lab_app_settings.lifecycle_config_arns[]
default_space_settings.jupyter_server_app_settings

The JupyterServer app settings.

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

The URL of the Git repository.

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

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

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

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

default_space_settings.jupyter_server_app_settings.default_resource_spec.sage_maker_image_version_arn

The ARN of the image version created on the instance.

default_space_settings.jupyter_server_app_settings.lifecycle_config_arns[]
default_space_settings.kernel_gateway_app_settings

The KernelGateway app settings.

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

The name of the AppImageConfig.

default_space_settings.kernel_gateway_app_settings.custom_images[].image_name

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

default_space_settings.kernel_gateway_app_settings.custom_images[].image_version_number

The version number of the CustomImage.

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

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

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

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

default_space_settings.kernel_gateway_app_settings.default_resource_spec.sage_maker_image_version_arn

The ARN of the image version created on the instance.

default_space_settings.kernel_gateway_app_settings.lifecycle_config_arns[]
default_space_settings.security_groups[]
default_space_settings.space_storage_settings

The default storage settings for a space.

Show child fields
default_space_settings.space_storage_settings.default_ebs_storage_settings

The default EBS storage settings for a space.

Show child fields
default_space_settings.space_storage_settings.default_ebs_storage_settings.default_ebs_volume_size_in_gb

The default size of the EBS storage volume for a space.

default_space_settings.space_storage_settings.default_ebs_storage_settings.maximum_ebs_volume_size_in_gb

The maximum size of the EBS storage volume for a space.

default_user_settings

Settings which are applied to UserProfiles in this domain if settings are not explicitly specified in a given UserProfile. 

STRUCT(
    "execution_role" VARCHAR,
    "security_groups" VARCHAR[],
    "sharing_settings" STRUCT(
        "notebook_output_option" VARCHAR,
        "s3_output_path" VARCHAR,
        "s3_kms_key_id" VARCHAR
    ),
    "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[]
    ),
    "tensor_board_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
        )
    ),
    "r_studio_server_pro_app_settings" STRUCT(
        "access_status" VARCHAR,
        "user_group" VARCHAR
    ),
    "r_session_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
        )[]
    ),
    "canvas_app_settings" STRUCT(
        "time_series_forecasting_settings" STRUCT(
            "status" VARCHAR,
            "amazon_forecast_role_arn" VARCHAR
        ),
        "model_register_settings" STRUCT(
            "status" VARCHAR,
            "cross_account_model_register_role_arn" VARCHAR
        ),
        "workspace_settings" STRUCT(
            "s3_artifact_path" VARCHAR,
            "s3_kms_key_id" VARCHAR
        ),
        "identity_provider_o_auth_settings" STRUCT(
            "data_source_name" VARCHAR,
            "status" VARCHAR,
            "secret_arn" VARCHAR
        )[],
        "direct_deploy_settings" STRUCT(
            "status" VARCHAR
        ),
        "kendra_settings" STRUCT(
            "status" VARCHAR
        ),
        "generative_ai_settings" STRUCT(
            "amazon_bedrock_role_arn" VARCHAR
        ),
        "emr_serverless_settings" STRUCT(
            "execution_role_arn" VARCHAR,
            "status" 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
        ),
        "custom_images" STRUCT(
            "image_name" VARCHAR,
            "image_version_number" BIGINT,
            "app_image_config_name" VARCHAR
        )[],
        "lifecycle_config_arns" 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
        ),
        "custom_images" STRUCT(
            "image_name" VARCHAR,
            "image_version_number" BIGINT,
            "app_image_config_name" VARCHAR
        )[],
        "lifecycle_config_arns" VARCHAR[],
        "code_repositories" STRUCT(
            "repository_url" VARCHAR
        )[],
        "emr_settings" STRUCT(
            "assumable_role_arns" VARCHAR[],
            "execution_role_arns" VARCHAR[]
        )
    ),
    "space_storage_settings" STRUCT(
        "default_ebs_storage_settings" STRUCT(
            "default_ebs_volume_size_in_gb" BIGINT,
            "maximum_ebs_volume_size_in_gb" BIGINT
        )
    ),
    "default_landing_uri" VARCHAR,
    "studio_web_portal" VARCHAR,
    "custom_posix_user_config" STRUCT(
        "uid" BIGINT,
        "gid" BIGINT
    ),
    "custom_file_system_configs" STRUCT(
        "efs_file_system_config" STRUCT(
            "file_system_id" VARCHAR,
            "file_system_path" VARCHAR
        )
    )[],
    "studio_web_portal_settings" STRUCT(
        "hidden_ml_tools" VARCHAR[],
        "hidden_app_types" VARCHAR[]
    )
)
Show child fields
default_user_settings.canvas_app_settings

The Canvas app settings.

Show child fields
default_user_settings.canvas_app_settings.direct_deploy_settings

The model deployment settings for the SageMaker Canvas application.

Show child fields
default_user_settings.canvas_app_settings.direct_deploy_settings.status

Describes whether model deployment permissions are enabled or disabled in the Canvas application.

default_user_settings.canvas_app_settings.emr_serverless_settings

The settings for running Amazon EMR Serverless data processing jobs in SageMaker Canvas.

Show child fields
default_user_settings.canvas_app_settings.emr_serverless_settings.execution_role_arn

The Amazon Resource Name (ARN) of the Amazon Web Services IAM role that is assumed for running Amazon EMR Serverless jobs in SageMaker Canvas. This role should have the necessary permissions to read and write data attached and a trust relationship with EMR Serverless.

default_user_settings.canvas_app_settings.emr_serverless_settings.status

Describes whether Amazon EMR Serverless job capabilities are enabled or disabled in the SageMaker Canvas application.

default_user_settings.canvas_app_settings.generative_ai_settings

The generative AI settings for the SageMaker Canvas application.

Show child fields
default_user_settings.canvas_app_settings.generative_ai_settings.amazon_bedrock_role_arn

The ARN of an Amazon Web Services IAM role that allows fine-tuning of large language models (LLMs) in Amazon Bedrock. The IAM role should have Amazon S3 read and write permissions, as well as a trust relationship that establishes bedrock.amazonaws.com as a service principal.

default_user_settings.canvas_app_settings.identity_provider_o_auth_settings[]
Show child fields
default_user_settings.canvas_app_settings.identity_provider_o_auth_settings[].data_source_name

The name of the data source that you're connecting to. Canvas currently supports OAuth for Snowflake and Salesforce Data Cloud.

default_user_settings.canvas_app_settings.identity_provider_o_auth_settings[].secret_arn

The ARN of an Amazon Web Services Secrets Manager secret that stores the credentials from your identity provider, such as the client ID and secret, authorization URL, and token URL.

default_user_settings.canvas_app_settings.identity_provider_o_auth_settings[].status

Describes whether OAuth for a data source is enabled or disabled in the Canvas application.

default_user_settings.canvas_app_settings.kendra_settings

The settings for document querying.

Show child fields
default_user_settings.canvas_app_settings.kendra_settings.status

Describes whether the document querying feature is enabled or disabled in the Canvas application.

default_user_settings.canvas_app_settings.model_register_settings

The model registry settings for the SageMaker Canvas application.

Show child fields
default_user_settings.canvas_app_settings.model_register_settings.cross_account_model_register_role_arn

The Amazon Resource Name (ARN) of the SageMaker model registry account. Required only to register model versions created by a different SageMaker Canvas Amazon Web Services account than the Amazon Web Services account in which SageMaker model registry is set up.

default_user_settings.canvas_app_settings.model_register_settings.status

Describes whether the integration to the model registry is enabled or disabled in the Canvas application.

default_user_settings.canvas_app_settings.time_series_forecasting_settings

Time series forecast settings for the SageMaker Canvas application.

Show child fields
default_user_settings.canvas_app_settings.time_series_forecasting_settings.amazon_forecast_role_arn

The IAM role that Canvas passes to Amazon Forecast for time series forecasting. By default, Canvas uses the execution role specified in the UserProfile that launches the Canvas application. If an execution role is not specified in the UserProfile, Canvas uses the execution role specified in the Domain that owns the UserProfile. To allow time series forecasting, this IAM role should have the AmazonSageMakerCanvasForecastAccess policy attached and forecast.amazonaws.com added in the trust relationship as a service principal.

default_user_settings.canvas_app_settings.time_series_forecasting_settings.status

Describes whether time series forecasting is enabled or disabled in the Canvas application.

default_user_settings.canvas_app_settings.workspace_settings

The workspace settings for the SageMaker Canvas application.

Show child fields
default_user_settings.canvas_app_settings.workspace_settings.s3_artifact_path

The Amazon S3 bucket used to store artifacts generated by Canvas. Updating the Amazon S3 location impacts existing configuration settings, and Canvas users no longer have access to their artifacts. Canvas users must log out and log back in to apply the new location.

default_user_settings.canvas_app_settings.workspace_settings.s3_kms_key_id

The Amazon Web Services Key Management Service (KMS) encryption key ID that is used to encrypt artifacts generated by Canvas in the Amazon S3 bucket.

default_user_settings.code_editor_app_settings

The Code Editor application settings.

Show child fields
default_user_settings.code_editor_app_settings.custom_images[]
Show child fields
default_user_settings.code_editor_app_settings.custom_images[].app_image_config_name

The name of the AppImageConfig.

default_user_settings.code_editor_app_settings.custom_images[].image_name

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

default_user_settings.code_editor_app_settings.custom_images[].image_version_number

The version number of the CustomImage.

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

default_user_settings.code_editor_app_settings.default_resource_spec.lifecycle_config_arn

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

default_user_settings.code_editor_app_settings.default_resource_spec.sage_maker_image_arn

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

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

default_user_settings.code_editor_app_settings.default_resource_spec.sage_maker_image_version_arn

The ARN of the image version created on the instance.

default_user_settings.code_editor_app_settings.lifecycle_config_arns[]
default_user_settings.custom_file_system_configs[]
Show child fields
default_user_settings.custom_file_system_configs[].efs_file_system_config

The settings for a custom Amazon EFS file system.

Show child fields
default_user_settings.custom_file_system_configs[].efs_file_system_config.file_system_id

The ID of your Amazon EFS file system.

default_user_settings.custom_file_system_configs[].efs_file_system_config.file_system_path

The path to the file system directory that is accessible in Amazon SageMaker Studio. Permitted users can access only this directory and below.

default_user_settings.custom_posix_user_config

Details about the POSIX identity that is used for file system operations.

Show child fields
default_user_settings.custom_posix_user_config.gid

The POSIX group ID.

default_user_settings.custom_posix_user_config.uid

The POSIX user ID.

default_user_settings.default_landing_uri

The default experience that the user is directed to when accessing the domain. The supported values are:

  • studio::: Indicates that Studio is the default experience. This value can only be passed if StudioWebPortal is set to ENABLED.

  • app:JupyterServer:: Indicates that Studio Classic is the default experience.

default_user_settings.execution_role

The execution role for the user.

default_user_settings.jupyter_lab_app_settings

The settings for the JupyterLab application.

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

The URL of the Git repository.

default_user_settings.jupyter_lab_app_settings.custom_images[]
Show child fields
default_user_settings.jupyter_lab_app_settings.custom_images[].app_image_config_name

The name of the AppImageConfig.

default_user_settings.jupyter_lab_app_settings.custom_images[].image_name

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

default_user_settings.jupyter_lab_app_settings.custom_images[].image_version_number

The version number of the CustomImage.

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

default_user_settings.jupyter_lab_app_settings.default_resource_spec.lifecycle_config_arn

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

default_user_settings.jupyter_lab_app_settings.default_resource_spec.sage_maker_image_arn

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

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

default_user_settings.jupyter_lab_app_settings.default_resource_spec.sage_maker_image_version_arn

The ARN of the image version created on the instance.

default_user_settings.jupyter_lab_app_settings.emr_settings

The configuration parameters that specify the IAM roles assumed by the execution role of SageMaker (assumable roles) and the cluster instances or job execution environments (execution roles or runtime roles) to manage and access resources required for running Amazon EMR clusters or Amazon EMR Serverless applications.

Show child fields
default_user_settings.jupyter_lab_app_settings.emr_settings.assumable_role_arns[]
default_user_settings.jupyter_lab_app_settings.emr_settings.execution_role_arns[]
default_user_settings.jupyter_lab_app_settings.lifecycle_config_arns[]
default_user_settings.jupyter_server_app_settings

The Jupyter server's app settings.

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

The URL of the Git repository.

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

default_user_settings.jupyter_server_app_settings.default_resource_spec.lifecycle_config_arn

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

default_user_settings.jupyter_server_app_settings.default_resource_spec.sage_maker_image_arn

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

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

default_user_settings.jupyter_server_app_settings.default_resource_spec.sage_maker_image_version_arn

The ARN of the image version created on the instance.

default_user_settings.jupyter_server_app_settings.lifecycle_config_arns[]
default_user_settings.kernel_gateway_app_settings

The kernel gateway app settings.

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

The name of the AppImageConfig.

default_user_settings.kernel_gateway_app_settings.custom_images[].image_name

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

default_user_settings.kernel_gateway_app_settings.custom_images[].image_version_number

The version number of the CustomImage.

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

default_user_settings.kernel_gateway_app_settings.default_resource_spec.lifecycle_config_arn

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

default_user_settings.kernel_gateway_app_settings.default_resource_spec.sage_maker_image_arn

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

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

default_user_settings.kernel_gateway_app_settings.default_resource_spec.sage_maker_image_version_arn

The ARN of the image version created on the instance.

default_user_settings.kernel_gateway_app_settings.lifecycle_config_arns[]
default_user_settings.r_session_app_settings

A collection of settings that configure the RSessionGateway app.

Show child fields
default_user_settings.r_session_app_settings.custom_images[]
Show child fields
default_user_settings.r_session_app_settings.custom_images[].app_image_config_name

The name of the AppImageConfig.

default_user_settings.r_session_app_settings.custom_images[].image_name

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

default_user_settings.r_session_app_settings.custom_images[].image_version_number

The version number of the CustomImage.

default_user_settings.r_session_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
default_user_settings.r_session_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.

default_user_settings.r_session_app_settings.default_resource_spec.lifecycle_config_arn

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

default_user_settings.r_session_app_settings.default_resource_spec.sage_maker_image_arn

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

default_user_settings.r_session_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.

default_user_settings.r_session_app_settings.default_resource_spec.sage_maker_image_version_arn

The ARN of the image version created on the instance.

default_user_settings.r_studio_server_pro_app_settings

A collection of settings that configure user interaction with the RStudioServerPro app.

Show child fields
default_user_settings.r_studio_server_pro_app_settings.access_status

Indicates whether the current user has access to the RStudioServerPro app.

default_user_settings.r_studio_server_pro_app_settings.user_group

The level of permissions that the user has within the RStudioServerPro app. This value defaults to `User`. The `Admin` value allows the user access to the RStudio Administrative Dashboard.

default_user_settings.security_groups[]
default_user_settings.sharing_settings

Specifies options for sharing Amazon SageMaker Studio notebooks.

Show child fields
default_user_settings.sharing_settings.notebook_output_option

Whether to include the notebook cell output when sharing the notebook. The default is Disabled.

default_user_settings.sharing_settings.s3_kms_key_id

When NotebookOutputOption is Allowed, the Amazon Web Services Key Management Service (KMS) encryption key ID used to encrypt the notebook cell output in the Amazon S3 bucket.

default_user_settings.sharing_settings.s3_output_path

When NotebookOutputOption is Allowed, the Amazon S3 bucket used to store the shared notebook snapshots.

default_user_settings.space_storage_settings

The storage settings for a space.

Show child fields
default_user_settings.space_storage_settings.default_ebs_storage_settings

The default EBS storage settings for a space.

Show child fields
default_user_settings.space_storage_settings.default_ebs_storage_settings.default_ebs_volume_size_in_gb

The default size of the EBS storage volume for a space.

default_user_settings.space_storage_settings.default_ebs_storage_settings.maximum_ebs_volume_size_in_gb

The maximum size of the EBS storage volume for a space.

default_user_settings.studio_web_portal

Whether the user can access Studio. If this value is set to DISABLED, the user cannot access Studio, even if that is the default experience for the domain.

default_user_settings.studio_web_portal_settings

Studio settings. If these settings are applied on a user level, they take priority over the settings applied on a domain level.

Show child fields
default_user_settings.studio_web_portal_settings.hidden_app_types[]
default_user_settings.studio_web_portal_settings.hidden_ml_tools[]
default_user_settings.tensor_board_app_settings

The TensorBoard app settings.

Show child fields
default_user_settings.tensor_board_app_settings.default_resource_spec

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

Show child fields
default_user_settings.tensor_board_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.

default_user_settings.tensor_board_app_settings.default_resource_spec.lifecycle_config_arn

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

default_user_settings.tensor_board_app_settings.default_resource_spec.sage_maker_image_arn

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

default_user_settings.tensor_board_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.

default_user_settings.tensor_board_app_settings.default_resource_spec.sage_maker_image_version_arn

The ARN of the image version created on the instance.

domain_arn

The domain's Amazon Resource Name (ARN).

VARCHAR
domain_name

The domain name.

VARCHAR
domain_settings

A collection of Domain settings.

STRUCT(
    "security_group_ids" VARCHAR[],
    "r_studio_server_pro_domain_settings" STRUCT(
        "domain_execution_role_arn" VARCHAR,
        "r_studio_connect_url" VARCHAR,
        "r_studio_package_manager_url" VARCHAR,
        "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
        )
    ),
    "execution_role_identity_config" VARCHAR,
    "docker_settings" STRUCT(
        "enable_docker_access" VARCHAR,
        "vpc_only_trusted_accounts" VARCHAR[]
    ),
    "amazon_q_settings" STRUCT(
        "status" VARCHAR,
        "q_profile_arn" VARCHAR
    )
)
Show child fields
domain_settings.amazon_q_settings

A collection of settings that configure the Amazon Q experience within the domain. The AuthMode that you use to create the domain must be SSO.

Show child fields
domain_settings.amazon_q_settings.q_profile_arn

The ARN of the Amazon Q profile used within the domain.

domain_settings.amazon_q_settings.status

Whether Amazon Q has been enabled within the domain.

domain_settings.docker_settings

A collection of settings that configure the domain's Docker interaction.

Show child fields
domain_settings.docker_settings.enable_docker_access

Indicates whether the domain can access Docker.

domain_settings.docker_settings.vpc_only_trusted_accounts[]
domain_settings.execution_role_identity_config

The configuration for attaching a SageMaker user profile name to the execution role as a sts:SourceIdentity key.

domain_settings.r_studio_server_pro_domain_settings

A collection of settings that configure the RStudioServerPro Domain-level app.

Show child fields
domain_settings.r_studio_server_pro_domain_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
domain_settings.r_studio_server_pro_domain_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.

domain_settings.r_studio_server_pro_domain_settings.default_resource_spec.lifecycle_config_arn

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

domain_settings.r_studio_server_pro_domain_settings.default_resource_spec.sage_maker_image_arn

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

domain_settings.r_studio_server_pro_domain_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.

domain_settings.r_studio_server_pro_domain_settings.default_resource_spec.sage_maker_image_version_arn

The ARN of the image version created on the instance.

domain_settings.r_studio_server_pro_domain_settings.domain_execution_role_arn

The ARN of the execution role for the RStudioServerPro Domain-level app.

domain_settings.r_studio_server_pro_domain_settings.r_studio_connect_url

A URL pointing to an RStudio Connect server.

domain_settings.r_studio_server_pro_domain_settings.r_studio_package_manager_url

A URL pointing to an RStudio Package Manager server.

domain_settings.security_group_ids[]
failure_reason

The failure reason.

VARCHAR
home_efs_file_system_id

The ID of the Amazon Elastic File System managed by this Domain.

VARCHAR
home_efs_file_system_kms_key_id

Use KmsKeyId.

VARCHAR
kms_key_id

The Amazon Web Services KMS customer managed key used to encrypt the EFS volume attached to the domain.

VARCHAR
last_modified_time

The last modified time.

TIMESTAMP_S
security_group_id_for_domain_boundary

The ID of the security group that authorizes traffic between the RSessionGateway apps and the RStudioServerPro app.

VARCHAR
single_sign_on_application_arn

The ARN of the application managed by SageMaker in IAM Identity Center. This value is only returned for domains created after October 1, 2023.

VARCHAR
single_sign_on_managed_application_instance_id

The IAM Identity Center managed application instance ID.

VARCHAR
status

The status.

VARCHAR
subnet_ids

The VPC subnets that the domain uses for communication.

VARCHAR[]
Show child fields
subnet_ids[]
url

The domain's URL.

VARCHAR
vpc_id

The ID of the Amazon Virtual Private Cloud (VPC) that the domain uses for communication.

VARCHAR