Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-143021,9861.6 MB

The description of the domain.

post/#X-Amz-Target=SageMaker.DescribeDomain

Headers

X-Amz-Target'SageMaker.DescribeDomain' required

Request body

DomainIdstring required

The domain ID.

Response

Success

DomainArnstring

The domain's Amazon Resource Name (ARN).

DomainIdstring

The domain ID.

DomainNamestring

The domain name.

HomeEfsFileSystemIdstring

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

SingleSignOnManagedApplicationInstanceIdstring

The IAM Identity Center managed application instance ID.

Status'Deleting' | 'Failed' | 'InService' | 'Pending' | 'Updating' | 'Update_Failed' | 'Delete_Failed'

The status.

CreationTimestring date-time

The creation time.

LastModifiedTimestring date-time

The last modified time.

FailureReasonstring

The failure reason.

AuthMode'SSO' | 'IAM'

The domain's authentication mode.

AppNetworkAccessType'PublicInternetOnly' | 'VpcOnly'
<p>Specifies the VPC used for non-EFS traffic. The default value is <code>PublicInternetOnly</code>.</p> <ul> <li> <p> <code>PublicInternetOnly</code> - Non-EFS traffic is through a VPC managed by Amazon SageMaker, which allows direct internet access</p> </li> <li> <p> <code>VpcOnly</code> - All Studio traffic is through the specified VPC and subnets</p> </li> </ul>
HomeEfsFileSystemKmsKeyIdstring

Use <code>KmsKeyId</code>.This property is deprecated, use KmsKeyId instead.

SubnetIdsSubnetId[]

The VPC subnets that Studio uses for communication.

Urlstring

The domain's URL.

VpcIdstring

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

KmsKeyIdstring

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

AppSecurityGroupManagement'Service' | 'Customer'

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

SecurityGroupIdForDomainBoundarystring

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