Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . sagemaker ]

describe-domain

Description

The description of the domain.

See also: AWS API Documentation

Synopsis

  describe-domain
--domain-id <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options

--domain-id (string)

The domain ID.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Output

DomainArn -> (string)

The domain's Amazon Resource Name (ARN).

DomainId -> (string)

The domain ID.

DomainName -> (string)

The domain name.

HomeEfsFileSystemId -> (string)

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

SingleSignOnManagedApplicationInstanceId -> (string)

The IAM Identity Center managed application instance ID.

SingleSignOnApplicationArn -> (string)

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

Status -> (string)

The status.

CreationTime -> (timestamp)

The creation time.

LastModifiedTime -> (timestamp)

The last modified time.

FailureReason -> (string)

The failure reason.

SecurityGroupIdForDomainBoundary -> (string)

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

AuthMode -> (string)

The domain's authentication mode.

DefaultUserSettings -> (structure)

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

ExecutionRole -> (string)

The execution role for the user.

SecurityGroups -> (list)

The security groups for the Amazon Virtual Private Cloud (VPC) that the domain uses for communication.

Optional when the CreateDomain.AppNetworkAccessType parameter is set to PublicInternetOnly .

Required when the CreateDomain.AppNetworkAccessType parameter is set to VpcOnly , unless specified as part of the DefaultUserSettings for the domain.

Amazon SageMaker adds a security group to allow NFS traffic from Amazon SageMaker Studio. Therefore, the number of security groups that you can specify is one less than the maximum number shown.

(string)

SharingSettings -> (structure)

Specifies options for sharing Amazon SageMaker Studio notebooks.

NotebookOutputOption -> (string)

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

S3OutputPath -> (string)

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

S3KmsKeyId -> (string)

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.

JupyterServerAppSettings -> (structure)

The Jupyter server's app settings.

DefaultResourceSpec -> (structure)

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.

SageMakerImageArn -> (string)

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

SageMakerImageVersionArn -> (string)

The ARN of the image version created on the instance.

SageMakerImageVersionAlias -> (string)

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

InstanceType -> (string)

The instance type that the image version runs on.

Note

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.

LifecycleConfigArn -> (string)

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

LifecycleConfigArns -> (list)

The Amazon Resource Name (ARN) of the Lifecycle Configurations attached to the JupyterServerApp. If you use this parameter, the DefaultResourceSpec parameter is also required.

Note

To remove a Lifecycle Config, you must set LifecycleConfigArns to an empty list.

(string)

CodeRepositories -> (list)

A list of Git repositories that SageMaker automatically displays to users for cloning in the JupyterServer application.

(structure)

A Git repository that SageMaker automatically displays to users for cloning in the JupyterServer application.

RepositoryUrl -> (string)

The URL of the Git repository.

KernelGatewayAppSettings -> (structure)

The kernel gateway app settings.

DefaultResourceSpec -> (structure)

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

Note

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.

SageMakerImageArn -> (string)

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

SageMakerImageVersionArn -> (string)

The ARN of the image version created on the instance.

SageMakerImageVersionAlias -> (string)

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

InstanceType -> (string)

The instance type that the image version runs on.

Note

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.

LifecycleConfigArn -> (string)

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

CustomImages -> (list)

A list of custom SageMaker images that are configured to run as a KernelGateway app.

(structure)

A custom SageMaker image. For more information, see Bring your own SageMaker image .

ImageName -> (string)

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

ImageVersionNumber -> (integer)

The version number of the CustomImage.

AppImageConfigName -> (string)

The name of the AppImageConfig.

LifecycleConfigArns -> (list)

The Amazon Resource Name (ARN) of the Lifecycle Configurations attached to the the user profile or domain.

Note

To remove a Lifecycle Config, you must set LifecycleConfigArns to an empty list.

(string)

TensorBoardAppSettings -> (structure)

The TensorBoard app settings.

DefaultResourceSpec -> (structure)

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

SageMakerImageArn -> (string)

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

SageMakerImageVersionArn -> (string)

The ARN of the image version created on the instance.

SageMakerImageVersionAlias -> (string)

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

InstanceType -> (string)

The instance type that the image version runs on.

Note

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.

LifecycleConfigArn -> (string)

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

RStudioServerProAppSettings -> (structure)

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

AccessStatus -> (string)

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

UserGroup -> (string)

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.

RSessionAppSettings -> (structure)

A collection of settings that configure the RSessionGateway app.

DefaultResourceSpec -> (structure)

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

SageMakerImageArn -> (string)

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

SageMakerImageVersionArn -> (string)

The ARN of the image version created on the instance.

SageMakerImageVersionAlias -> (string)

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

InstanceType -> (string)

The instance type that the image version runs on.

Note

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.

LifecycleConfigArn -> (string)

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

CustomImages -> (list)

A list of custom SageMaker images that are configured to run as a RSession app.

(structure)

A custom SageMaker image. For more information, see Bring your own SageMaker image .

ImageName -> (string)

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

ImageVersionNumber -> (integer)

The version number of the CustomImage.

AppImageConfigName -> (string)

The name of the AppImageConfig.

CanvasAppSettings -> (structure)

The Canvas app settings.

TimeSeriesForecastingSettings -> (structure)

Time series forecast settings for the SageMaker Canvas application.

Status -> (string)

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

AmazonForecastRoleArn -> (string)

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.

ModelRegisterSettings -> (structure)

The model registry settings for the SageMaker Canvas application.

Status -> (string)

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

CrossAccountModelRegisterRoleArn -> (string)

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.

WorkspaceSettings -> (structure)

The workspace settings for the SageMaker Canvas application.

S3ArtifactPath -> (string)

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.

S3KmsKeyId -> (string)

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.

IdentityProviderOAuthSettings -> (list)

The settings for connecting to an external data source with OAuth.

(structure)

The Amazon SageMaker Canvas application setting where you configure OAuth for connecting to an external data source, such as Snowflake.

DataSourceName -> (string)

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

Status -> (string)

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

SecretArn -> (string)

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.

DirectDeploySettings -> (structure)

The model deployment settings for the SageMaker Canvas application.

Status -> (string)

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

KendraSettings -> (structure)

The settings for document querying.

Status -> (string)

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

GenerativeAiSettings -> (structure)

The generative AI settings for the SageMaker Canvas application.

AmazonBedrockRoleArn -> (string)

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.

CodeEditorAppSettings -> (structure)

The Code Editor application settings.

DefaultResourceSpec -> (structure)

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

SageMakerImageArn -> (string)

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

SageMakerImageVersionArn -> (string)

The ARN of the image version created on the instance.

SageMakerImageVersionAlias -> (string)

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

InstanceType -> (string)

The instance type that the image version runs on.

Note

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.

LifecycleConfigArn -> (string)

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

CustomImages -> (list)

A list of custom SageMaker images that are configured to run as a Code Editor app.

(structure)

A custom SageMaker image. For more information, see Bring your own SageMaker image .

ImageName -> (string)

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

ImageVersionNumber -> (integer)

The version number of the CustomImage.

AppImageConfigName -> (string)

The name of the AppImageConfig.

LifecycleConfigArns -> (list)

The Amazon Resource Name (ARN) of the Code Editor application lifecycle configuration.

(string)

JupyterLabAppSettings -> (structure)

The settings for the JupyterLab application.

DefaultResourceSpec -> (structure)

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

SageMakerImageArn -> (string)

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

SageMakerImageVersionArn -> (string)

The ARN of the image version created on the instance.

SageMakerImageVersionAlias -> (string)

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

InstanceType -> (string)

The instance type that the image version runs on.

Note

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.

LifecycleConfigArn -> (string)

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

CustomImages -> (list)

A list of custom SageMaker images that are configured to run as a JupyterLab app.

(structure)

A custom SageMaker image. For more information, see Bring your own SageMaker image .

ImageName -> (string)

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

ImageVersionNumber -> (integer)

The version number of the CustomImage.

AppImageConfigName -> (string)

The name of the AppImageConfig.

LifecycleConfigArns -> (list)

The Amazon Resource Name (ARN) of the lifecycle configurations attached to the user profile or domain. To remove a lifecycle config, you must set LifecycleConfigArns to an empty list.

(string)

CodeRepositories -> (list)

A list of Git repositories that SageMaker automatically displays to users for cloning in the JupyterLab application.

(structure)

A Git repository that SageMaker automatically displays to users for cloning in the JupyterServer application.

RepositoryUrl -> (string)

The URL of the Git repository.

SpaceStorageSettings -> (structure)

The storage settings for a space.

DefaultEbsStorageSettings -> (structure)

The default EBS storage settings for a space.

DefaultEbsVolumeSizeInGb -> (integer)

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

MaximumEbsVolumeSizeInGb -> (integer)

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

DefaultLandingUri -> (string)

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.

StudioWebPortal -> (string)

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.

CustomPosixUserConfig -> (structure)

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

Uid -> (long)

The POSIX user ID.

Gid -> (long)

The POSIX group ID.

CustomFileSystemConfigs -> (list)

The settings for assigning a custom file system to a user profile. Permitted users can access this file system in Amazon SageMaker Studio.

(tagged union structure)

The settings for assigning a custom file system to a user profile or space for an Amazon SageMaker Domain. Permitted users can access this file system in Amazon SageMaker Studio.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: EFSFileSystemConfig.

EFSFileSystemConfig -> (structure)

The settings for a custom Amazon EFS file system.

FileSystemId -> (string)

The ID of your Amazon EFS file system.

FileSystemPath -> (string)

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

DomainSettings -> (structure)

A collection of Domain settings.

SecurityGroupIds -> (list)

The security groups for the Amazon Virtual Private Cloud that the Domain uses for communication between Domain-level apps and user apps.

(string)

RStudioServerProDomainSettings -> (structure)

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

DomainExecutionRoleArn -> (string)

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

RStudioConnectUrl -> (string)

A URL pointing to an RStudio Connect server.

RStudioPackageManagerUrl -> (string)

A URL pointing to an RStudio Package Manager server.

DefaultResourceSpec -> (structure)

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

SageMakerImageArn -> (string)

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

SageMakerImageVersionArn -> (string)

The ARN of the image version created on the instance.

SageMakerImageVersionAlias -> (string)

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

InstanceType -> (string)

The instance type that the image version runs on.

Note

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.

LifecycleConfigArn -> (string)

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

ExecutionRoleIdentityConfig -> (string)

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

DockerSettings -> (structure)

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

EnableDockerAccess -> (string)

Indicates whether the domain can access Docker.

VpcOnlyTrustedAccounts -> (list)

The list of Amazon Web Services accounts that are trusted when the domain is created in VPC-only mode.

(string)

AppNetworkAccessType -> (string)

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

HomeEfsFileSystemKmsKeyId -> (string)

Use KmsKeyId .

SubnetIds -> (list)

The VPC subnets that the domain uses for communication.

(string)

Url -> (string)

The domain's URL.

VpcId -> (string)

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

KmsKeyId -> (string)

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

AppSecurityGroupManagement -> (string)

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.

DefaultSpaceSettings -> (structure)

The default settings used to create a space.

ExecutionRole -> (string)

The ARN of the execution role for the space.

SecurityGroups -> (list)

The security group IDs for the Amazon VPC that the space uses for communication.

(string)

JupyterServerAppSettings -> (structure)

The JupyterServer app settings.

DefaultResourceSpec -> (structure)

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.

SageMakerImageArn -> (string)

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

SageMakerImageVersionArn -> (string)

The ARN of the image version created on the instance.

SageMakerImageVersionAlias -> (string)

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

InstanceType -> (string)

The instance type that the image version runs on.

Note

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.

LifecycleConfigArn -> (string)

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

LifecycleConfigArns -> (list)

The Amazon Resource Name (ARN) of the Lifecycle Configurations attached to the JupyterServerApp. If you use this parameter, the DefaultResourceSpec parameter is also required.

Note

To remove a Lifecycle Config, you must set LifecycleConfigArns to an empty list.

(string)

CodeRepositories -> (list)

A list of Git repositories that SageMaker automatically displays to users for cloning in the JupyterServer application.

(structure)

A Git repository that SageMaker automatically displays to users for cloning in the JupyterServer application.

RepositoryUrl -> (string)

The URL of the Git repository.

KernelGatewayAppSettings -> (structure)

The KernelGateway app settings.

DefaultResourceSpec -> (structure)

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

Note

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.

SageMakerImageArn -> (string)

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

SageMakerImageVersionArn -> (string)

The ARN of the image version created on the instance.

SageMakerImageVersionAlias -> (string)

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

InstanceType -> (string)

The instance type that the image version runs on.

Note

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.

LifecycleConfigArn -> (string)

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

CustomImages -> (list)

A list of custom SageMaker images that are configured to run as a KernelGateway app.

(structure)

A custom SageMaker image. For more information, see Bring your own SageMaker image .

ImageName -> (string)

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

ImageVersionNumber -> (integer)

The version number of the CustomImage.

AppImageConfigName -> (string)

The name of the AppImageConfig.

LifecycleConfigArns -> (list)

The Amazon Resource Name (ARN) of the Lifecycle Configurations attached to the the user profile or domain.

Note

To remove a Lifecycle Config, you must set LifecycleConfigArns to an empty list.

(string)

JupyterLabAppSettings -> (structure)

The settings for the JupyterLab application.

DefaultResourceSpec -> (structure)

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

SageMakerImageArn -> (string)

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

SageMakerImageVersionArn -> (string)

The ARN of the image version created on the instance.

SageMakerImageVersionAlias -> (string)

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

InstanceType -> (string)

The instance type that the image version runs on.

Note

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.

LifecycleConfigArn -> (string)

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

CustomImages -> (list)

A list of custom SageMaker images that are configured to run as a JupyterLab app.

(structure)

A custom SageMaker image. For more information, see Bring your own SageMaker image .

ImageName -> (string)

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

ImageVersionNumber -> (integer)

The version number of the CustomImage.

AppImageConfigName -> (string)

The name of the AppImageConfig.

LifecycleConfigArns -> (list)

The Amazon Resource Name (ARN) of the lifecycle configurations attached to the user profile or domain. To remove a lifecycle config, you must set LifecycleConfigArns to an empty list.

(string)

CodeRepositories -> (list)

A list of Git repositories that SageMaker automatically displays to users for cloning in the JupyterLab application.

(structure)

A Git repository that SageMaker automatically displays to users for cloning in the JupyterServer application.

RepositoryUrl -> (string)

The URL of the Git repository.

SpaceStorageSettings -> (structure)

The default storage settings for a space.

DefaultEbsStorageSettings -> (structure)

The default EBS storage settings for a space.

DefaultEbsVolumeSizeInGb -> (integer)

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

MaximumEbsVolumeSizeInGb -> (integer)

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

CustomPosixUserConfig -> (structure)

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

Uid -> (long)

The POSIX user ID.

Gid -> (long)

The POSIX group ID.

CustomFileSystemConfigs -> (list)

The settings for assigning a custom file system to a domain. Permitted users can access this file system in Amazon SageMaker Studio.

(tagged union structure)

The settings for assigning a custom file system to a user profile or space for an Amazon SageMaker Domain. Permitted users can access this file system in Amazon SageMaker Studio.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: EFSFileSystemConfig.

EFSFileSystemConfig -> (structure)

The settings for a custom Amazon EFS file system.

FileSystemId -> (string)

The ID of your Amazon EFS file system.

FileSystemPath -> (string)

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