_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
)[]
)[]
)
) |
user_settings
A collection of settings. | 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- user_settings.canvas_app_settings
The Canvas app settings. Show child fields- user_settings.canvas_app_settings.direct_deploy_settings
The model deployment settings for the SageMaker Canvas application. Show child fields- user_settings.canvas_app_settings.direct_deploy_settings.status
Describes whether model deployment permissions are enabled or disabled in the Canvas application.
- user_settings.canvas_app_settings.emr_serverless_settings
The settings for running Amazon EMR Serverless data processing jobs in SageMaker Canvas. Show child fields- 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. - 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.
- user_settings.canvas_app_settings.generative_ai_settings
The generative AI settings for the SageMaker Canvas application. Show child fields- 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.
- user_settings.canvas_app_settings.identity_provider_o_auth_settings[]
Show child fields- 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. - 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. - 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.
- user_settings.canvas_app_settings.kendra_settings
The settings for document querying. Show child fields- user_settings.canvas_app_settings.kendra_settings.status
Describes whether the document querying feature is enabled or disabled in the Canvas application.
- user_settings.canvas_app_settings.model_register_settings
The model registry settings for the SageMaker Canvas application. Show child fields- 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. - 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.
- user_settings.canvas_app_settings.time_series_forecasting_settings
Time series forecast settings for the SageMaker Canvas application. Show child fields- 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. - user_settings.canvas_app_settings.time_series_forecasting_settings.status
Describes whether time series forecasting is enabled or disabled in the Canvas application.
- user_settings.canvas_app_settings.workspace_settings
The workspace settings for the SageMaker Canvas application. Show child fields- 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. - 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.
- user_settings.code_editor_app_settings
The Code Editor application settings. Show child fields- user_settings.code_editor_app_settings.custom_images[]
Show child fields- user_settings.code_editor_app_settings.custom_images[].app_image_config_name
The name of the AppImageConfig. - user_settings.code_editor_app_settings.custom_images[].image_name
The name of the CustomImage. Must be unique to your account. - user_settings.code_editor_app_settings.custom_images[].image_version_number
The version number of the CustomImage.
- 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- 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. - 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. - 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. - 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. - user_settings.code_editor_app_settings.default_resource_spec.sage_maker_image_version_arn
The ARN of the image version created on the instance.
- user_settings.code_editor_app_settings.lifecycle_config_arns[]
- user_settings.custom_file_system_configs[]
Show child fields- user_settings.custom_file_system_configs[].efs_file_system_config
The settings for a custom Amazon EFS file system. Show child fields- user_settings.custom_file_system_configs[].efs_file_system_config.file_system_id
The ID of your Amazon EFS file system. - 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.
- user_settings.custom_posix_user_config
Details about the POSIX identity that is used for file system operations. Show child fields- user_settings.custom_posix_user_config.gid
The POSIX group ID. - user_settings.custom_posix_user_config.uid
The POSIX user ID.
- 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. - user_settings.execution_role
The execution role for the user. - user_settings.jupyter_lab_app_settings
The settings for the JupyterLab application. Show child fields- user_settings.jupyter_lab_app_settings.code_repositories[]
Show child fields- user_settings.jupyter_lab_app_settings.code_repositories[].repository_url
The URL of the Git repository.
- user_settings.jupyter_lab_app_settings.custom_images[]
Show child fields- user_settings.jupyter_lab_app_settings.custom_images[].app_image_config_name
The name of the AppImageConfig. - user_settings.jupyter_lab_app_settings.custom_images[].image_name
The name of the CustomImage. Must be unique to your account. - user_settings.jupyter_lab_app_settings.custom_images[].image_version_number
The version number of the CustomImage.
- 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- 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. - 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. - 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. - 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. - user_settings.jupyter_lab_app_settings.default_resource_spec.sage_maker_image_version_arn
The ARN of the image version created on the instance.
- 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- user_settings.jupyter_lab_app_settings.emr_settings.assumable_role_arns[]
- user_settings.jupyter_lab_app_settings.emr_settings.execution_role_arns[]
- user_settings.jupyter_lab_app_settings.lifecycle_config_arns[]
- user_settings.jupyter_server_app_settings
The Jupyter server's app settings. Show child fields- user_settings.jupyter_server_app_settings.code_repositories[]
Show child fields- user_settings.jupyter_server_app_settings.code_repositories[].repository_url
The URL of the Git repository.
- 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- 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. - 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. - 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. - 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. - user_settings.jupyter_server_app_settings.default_resource_spec.sage_maker_image_version_arn
The ARN of the image version created on the instance.
- user_settings.jupyter_server_app_settings.lifecycle_config_arns[]
- user_settings.kernel_gateway_app_settings
The kernel gateway app settings. Show child fields- user_settings.kernel_gateway_app_settings.custom_images[]
Show child fields- user_settings.kernel_gateway_app_settings.custom_images[].app_image_config_name
The name of the AppImageConfig. - user_settings.kernel_gateway_app_settings.custom_images[].image_name
The name of the CustomImage. Must be unique to your account. - user_settings.kernel_gateway_app_settings.custom_images[].image_version_number
The version number of the CustomImage.
- 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- 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. - 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. - 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. - 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. - user_settings.kernel_gateway_app_settings.default_resource_spec.sage_maker_image_version_arn
The ARN of the image version created on the instance.
- user_settings.kernel_gateway_app_settings.lifecycle_config_arns[]
- user_settings.r_session_app_settings
A collection of settings that configure the RSessionGateway app. Show child fields- user_settings.r_session_app_settings.custom_images[]
Show child fields- user_settings.r_session_app_settings.custom_images[].app_image_config_name
The name of the AppImageConfig. - user_settings.r_session_app_settings.custom_images[].image_name
The name of the CustomImage. Must be unique to your account. - user_settings.r_session_app_settings.custom_images[].image_version_number
The version number of the CustomImage.
- 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- 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. - 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. - 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. - 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. - user_settings.r_session_app_settings.default_resource_spec.sage_maker_image_version_arn
The ARN of the image version created on the instance.
- user_settings.r_studio_server_pro_app_settings
A collection of settings that configure user interaction with the RStudioServerPro app. Show child fields- user_settings.r_studio_server_pro_app_settings.access_status
Indicates whether the current user has access to the RStudioServerPro app. - 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.
- user_settings.security_groups[]
- user_settings.sharing_settings
Specifies options for sharing Amazon SageMaker Studio notebooks. Show child fields- user_settings.sharing_settings.notebook_output_option
Whether to include the notebook cell output when sharing the notebook. The default is Disabled. - 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. - user_settings.sharing_settings.s3_output_path
When NotebookOutputOption is Allowed, the Amazon S3 bucket used to store the shared notebook snapshots.
- user_settings.space_storage_settings
The storage settings for a space. Show child fields- user_settings.space_storage_settings.default_ebs_storage_settings
The default EBS storage settings for a space. Show child fields- 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. - 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.
- 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. - 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- user_settings.studio_web_portal_settings.hidden_app_types[]
- user_settings.studio_web_portal_settings.hidden_ml_tools[]
- user_settings.tensor_board_app_settings
The TensorBoard app settings. Show child fields- 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- 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. - 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. - 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. - 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. - user_settings.tensor_board_app_settings.default_resource_spec.sage_maker_image_version_arn
The ARN of the image version created on the instance.
|