View and edit domains - Amazon SageMaker

View and edit domains

This topic shows how to view a list of your Amazon SageMaker domains, view the details of a domain, and edit domain settings from the Amazon SageMaker console or AWS Command Line Interface (AWS CLI).

View domains

The following section shows how to view a list of your domains, and details of an individual domain from the SageMaker console or the AWS CLI.

Console

The console's domain overview page gives information about the structure of a domain, and it provides a list of your domains. The page's domain structure diagram describes domain components and how they interact with each other.

The following procedure shows how to view a list of your domains from the SageMaker console.

  1. Open the Amazon SageMaker console at https://console.aws.amazon.com/sagemaker/.

  2. On the left navigation pane, choose Admin configurations.

  3. Under Admin configurations, choose domains.

To view the details of the domain, complete the following procedure. This page gives information about the general settings for the domain, including the name, domain ID, execution role used to create the domain, and the authentication method of the domain. 

  1. From the list of domains, select the domain for which you want to open the domain settings page.

  2. On the domain details page, choose the domain settings tab.

AWS CLI

Run the following command from the terminal of your local machine to view a list of domains from the AWS CLI.

aws sagemaker list-domains --region region

Edit domain settings

You can edit the settings of a domain from the SageMaker console or the AWS CLI. The following considerations apply when updating the settings of a domain.

  • If DefaultUserSettings and DefaultSpaceSettings are set, they cannot be unset.

  • DefaultUserSettings.ExecutionRole can only be updated if there are no applications running in any user profile within the domain. This value cannot be unset.

  • DefaultSpaceSettings.ExecutionRole can only be updated if there are no applications running in any of shared spaces within the domain. This value cannot be unset.

  • If the domain was created in VPC only mode, SageMaker automatically applies updates to the security group settings defined for the domain to all shared spaces created in the domain.

  • DomainId cannot be updated.

The following section shows how to edit domain settings from the SageMaker console or the AWS CLI.

Console

You can edit the domain from the SageMaker console using the following procedure.

  1. Open the Amazon SageMaker console at https://console.aws.amazon.com/sagemaker/.

  2. On the left navigation pane, choose Admin configurations.

  3. Under Admin configurations, choose domains.

  4. From the list of domains, select the domain for which you want to open the domain settings page.

  5. On the domain details page, you can configure and manage your domain details by choosing the appropriate tab.

  6. To configure the general settings, on the domain details page choose the domain settings tab then choose Edit.

AWS CLI

Run the following command from the terminal of your local machine to update a domain from the AWS CLI. For more information about the structure of default-user-settings, see CreateDomain.

aws sagemaker update-domain \ --domain-id domain-id \ --default-user-settings default-user-settings \ --default-space-settings default-space-settings \ --domain-settings-for-update settings-for-update \ --region region