Skip to content

DescribeDomainResponse

Source code in docs_src/capo_sagemaker/types/describe_domain_response.py
class DescribeDomainResponse(TypedDict, closed=True):
    domain_arn: NotRequired["capo_sagemaker.types.domain_arn.DomainArn"]
    """<p>The domain's Amazon Resource Name (ARN).</p>"""
    domain_id: NotRequired["capo_sagemaker.types.domain_id.DomainId"]
    """<p>The domain ID.</p>"""
    domain_name: NotRequired["capo_sagemaker.types.domain_name.DomainName"]
    """<p>The domain name.</p>"""
    home_efs_file_system_id: NotRequired["capo_sagemaker.types.resource_id.ResourceId"]
    """<p>The ID of the Amazon Elastic File System managed by this Domain.</p>"""
    single_sign_on_managed_application_instance_id: NotRequired[
        "capo_sagemaker.types.string256.String256"
    ]
    """<p>The IAM Identity Center managed application instance ID.</p>"""
    single_sign_on_application_arn: NotRequired[
        "capo_sagemaker.types.single_sign_on_application_arn.SingleSignOnApplicationArn"
    ]
    """<p>The ARN of the application managed by SageMaker AI in IAM Identity Center. This value is only returned for domains created after October 1, 2023.</p>"""
    status: NotRequired["capo_sagemaker.types.domain_status.DomainStatus"]
    """<p>The status.</p>"""
    creation_time: NotRequired["capo_sagemaker.types.creation_time.CreationTime"]
    """<p>The creation time.</p>"""
    last_modified_time: NotRequired[
        "capo_sagemaker.types.last_modified_time.LastModifiedTime"
    ]
    """<p>The last modified time.</p>"""
    failure_reason: NotRequired["capo_sagemaker.types.failure_reason.FailureReason"]
    """<p>The failure reason.</p>"""
    security_group_id_for_domain_boundary: NotRequired[
        "capo_sagemaker.types.security_group_id.SecurityGroupId"
    ]
    """<p>The ID of the security group that authorizes traffic between the <code>RSessionGateway</code> apps and the <code>RStudioServerPro</code> app.</p>"""
    auth_mode: NotRequired["capo_sagemaker.types.auth_mode.AuthMode"]
    """<p>The domain's authentication mode.</p>"""
    default_user_settings: NotRequired[
        "capo_sagemaker.types.user_settings.UserSettings"
    ]
    """<p>Settings which are applied to UserProfiles in this domain if settings are not explicitly specified in a given UserProfile. </p>"""
    domain_settings: NotRequired["capo_sagemaker.types.domain_settings.DomainSettings"]
    """<p>A collection of <code>Domain</code> settings.</p>"""
    app_network_access_type: NotRequired[
        "capo_sagemaker.types.app_network_access_type.AppNetworkAccessType"
    ]
    """<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 AI, which allows direct internet access</p> </li> <li> <p> <code>VpcOnly</code> - All traffic is through the specified VPC and subnets</p> </li> </ul>"""
    home_efs_file_system_kms_key_id: NotRequired[
        "capo_sagemaker.types.kms_key_id.KmsKeyId"
    ]
    """<p>Use <code>KmsKeyId</code>.</p>"""
    subnet_ids: NotRequired["capo_sagemaker.types.subnets.Subnets"]
    """<p>The VPC subnets that the domain uses for communication.</p>"""
    url: NotRequired["capo_sagemaker.types.string1024.String1024"]
    """<p>The domain's URL.</p>"""
    vpc_id: NotRequired["capo_sagemaker.types.vpc_id.VpcId"]
    """<p>The ID of the Amazon Virtual Private Cloud (VPC) that the domain uses for communication.</p>"""
    kms_key_id: NotRequired["capo_sagemaker.types.kms_key_id.KmsKeyId"]
    """<p>The Amazon Web Services KMS customer managed key used to encrypt the EFS volume attached to the domain.</p>"""
    app_security_group_management: NotRequired[
        "capo_sagemaker.types.app_security_group_management.AppSecurityGroupManagement"
    ]
    """<p>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.</p>"""
    home_efs_file_system_creation: NotRequired[
        "capo_sagemaker.types.home_efs_file_system_creation.HomeEfsFileSystemCreation"
    ]
    """<p>Indicates whether a home EFS file system is created for the domain.</p>"""
    tag_propagation: NotRequired["capo_sagemaker.types.tag_propagation.TagPropagation"]
    """<p>Indicates whether custom tag propagation is supported for the domain.</p>"""
    default_space_settings: NotRequired[
        "capo_sagemaker.types.default_space_settings.DefaultSpaceSettings"
    ]
    """<p>The default settings for shared spaces that users create in the domain.</p>"""

app_network_access_type instance-attribute

app_network_access_type: NotRequired[AppNetworkAccessType]

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 AI, which allows direct internet access

  • VpcOnly - All traffic is through the specified VPC and subnets

app_security_group_management instance-attribute

app_security_group_management: NotRequired[AppSecurityGroupManagement]

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.

auth_mode instance-attribute

auth_mode: NotRequired[AuthMode]

The domain's authentication mode.

creation_time instance-attribute

creation_time: NotRequired[CreationTime]

The creation time.

default_space_settings instance-attribute

default_space_settings: NotRequired[DefaultSpaceSettings]

The default settings for shared spaces that users create in the domain.

default_user_settings instance-attribute

default_user_settings: NotRequired[UserSettings]

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

domain_arn instance-attribute

domain_arn: NotRequired[DomainArn]

The domain's Amazon Resource Name (ARN).

domain_id instance-attribute

domain_id: NotRequired[DomainId]

The domain ID.

domain_name instance-attribute

domain_name: NotRequired[DomainName]

The domain name.

domain_settings instance-attribute

domain_settings: NotRequired[DomainSettings]

A collection of Domain settings.

failure_reason instance-attribute

failure_reason: NotRequired[FailureReason]

The failure reason.

home_efs_file_system_creation instance-attribute

home_efs_file_system_creation: NotRequired[HomeEfsFileSystemCreation]

Indicates whether a home EFS file system is created for the domain.

home_efs_file_system_id instance-attribute

home_efs_file_system_id: NotRequired[ResourceId]

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

home_efs_file_system_kms_key_id instance-attribute

home_efs_file_system_kms_key_id: NotRequired[KmsKeyId]

Use KmsKeyId.

kms_key_id instance-attribute

kms_key_id: NotRequired[KmsKeyId]

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

last_modified_time instance-attribute

last_modified_time: NotRequired[LastModifiedTime]

The last modified time.

security_group_id_for_domain_boundary instance-attribute

security_group_id_for_domain_boundary: NotRequired[SecurityGroupId]

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

single_sign_on_application_arn instance-attribute

single_sign_on_application_arn: NotRequired[SingleSignOnApplicationArn]

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

single_sign_on_managed_application_instance_id instance-attribute

single_sign_on_managed_application_instance_id: NotRequired[String256]

The IAM Identity Center managed application instance ID.

status instance-attribute

status: NotRequired[DomainStatus]

The status.

subnet_ids instance-attribute

subnet_ids: NotRequired[Subnets]

The VPC subnets that the domain uses for communication.

tag_propagation instance-attribute

tag_propagation: NotRequired[TagPropagation]

Indicates whether custom tag propagation is supported for the domain.

url instance-attribute

url: NotRequired[String1024]

The domain's URL.

vpc_id instance-attribute

vpc_id: NotRequired[VpcId]

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