UnifiedStudioSettings - Amazon SageMaker
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

UnifiedStudioSettings

The settings that apply to an Amazon SageMaker AI domain when you use it in Amazon SageMaker Unified Studio.

Contents

DomainAccountId

The ID of the Amazon account that has the Amazon SageMaker Unified Studio domain. The default value, if you don't specify an ID, is the ID of the account that has the Amazon SageMaker AI domain.

Type: String

Length Constraints: Fixed length of 12.

Pattern: \d+

Required: No

DomainId

The ID of the Amazon SageMaker Unified Studio domain associated with this domain.

Type: String

Pattern: dzd[-_][a-zA-Z0-9_-]{1,36}

Required: No

DomainRegion

The Amazon Region where the domain is located in Amazon SageMaker Unified Studio. The default value, if you don't specify a Region, is the Region where the Amazon SageMaker AI domain is located.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 24.

Required: No

EnvironmentId

The ID of the environment that Amazon SageMaker Unified Studio associates with the domain.

Type: String

Pattern: [a-zA-Z0-9_-]{1,36}

Required: No

ProjectId

The ID of the Amazon SageMaker Unified Studio project that corresponds to the domain.

Type: String

Pattern: [a-zA-Z0-9_-]{1,36}

Required: No

ProjectS3Path

The location where Amazon S3 stores temporary execution data and other artifacts for the project that corresponds to the domain.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 1024.

Pattern: (https|s3)://([^/]+)/?(.*)

Required: No

SingleSignOnApplicationArn

The ARN of the application managed by SageMaker AI and SageMaker Unified Studio in the Amazon IAM Identity Center.

Type: String

Pattern: arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso::[0-9]+:application\/[a-zA-Z0-9-_.]+\/apl-[a-zA-Z0-9]+

Required: No

StudioWebPortalAccess

Sets whether you can access the domain in Amazon SageMaker Studio:

ENABLED

You can access the domain in Amazon SageMaker Studio. If you migrate the domain to Amazon SageMaker Unified Studio, you can access it in both studio interfaces.

DISABLED

You can't access the domain in Amazon SageMaker Studio. If you migrate the domain to Amazon SageMaker Unified Studio, you can access it only in that studio interface.

To migrate a domain to Amazon SageMaker Unified Studio, you specify the UnifiedStudioSettings data type when you use the UpdateDomain action.

Type: String

Valid Values: ENABLED | DISABLED

Required: No

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: