aws_sdk_sagemaker/client/
describe_domain.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3    /// Constructs a fluent builder for the [`DescribeDomain`](crate::operation::describe_domain::builders::DescribeDomainFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`domain_id(impl Into<String>)`](crate::operation::describe_domain::builders::DescribeDomainFluentBuilder::domain_id) / [`set_domain_id(Option<String>)`](crate::operation::describe_domain::builders::DescribeDomainFluentBuilder::set_domain_id):<br>required: **true**<br><p>The domain ID.</p><br>
7    /// - On success, responds with [`DescribeDomainOutput`](crate::operation::describe_domain::DescribeDomainOutput) with field(s):
8    ///   - [`domain_arn(Option<String>)`](crate::operation::describe_domain::DescribeDomainOutput::domain_arn): <p>The domain's Amazon Resource Name (ARN).</p>
9    ///   - [`domain_id(Option<String>)`](crate::operation::describe_domain::DescribeDomainOutput::domain_id): <p>The domain ID.</p>
10    ///   - [`domain_name(Option<String>)`](crate::operation::describe_domain::DescribeDomainOutput::domain_name): <p>The domain name.</p>
11    ///   - [`home_efs_file_system_id(Option<String>)`](crate::operation::describe_domain::DescribeDomainOutput::home_efs_file_system_id): <p>The ID of the Amazon Elastic File System managed by this Domain.</p>
12    ///   - [`single_sign_on_managed_application_instance_id(Option<String>)`](crate::operation::describe_domain::DescribeDomainOutput::single_sign_on_managed_application_instance_id): <p>The IAM Identity Center managed application instance ID.</p>
13    ///   - [`single_sign_on_application_arn(Option<String>)`](crate::operation::describe_domain::DescribeDomainOutput::single_sign_on_application_arn): <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>
14    ///   - [`status(Option<DomainStatus>)`](crate::operation::describe_domain::DescribeDomainOutput::status): <p>The status.</p>
15    ///   - [`creation_time(Option<DateTime>)`](crate::operation::describe_domain::DescribeDomainOutput::creation_time): <p>The creation time.</p>
16    ///   - [`last_modified_time(Option<DateTime>)`](crate::operation::describe_domain::DescribeDomainOutput::last_modified_time): <p>The last modified time.</p>
17    ///   - [`failure_reason(Option<String>)`](crate::operation::describe_domain::DescribeDomainOutput::failure_reason): <p>The failure reason.</p>
18    ///   - [`security_group_id_for_domain_boundary(Option<String>)`](crate::operation::describe_domain::DescribeDomainOutput::security_group_id_for_domain_boundary): <p>The ID of the security group that authorizes traffic between the <code>RSessionGateway</code> apps and the <code>RStudioServerPro</code> app.</p>
19    ///   - [`auth_mode(Option<AuthMode>)`](crate::operation::describe_domain::DescribeDomainOutput::auth_mode): <p>The domain's authentication mode.</p>
20    ///   - [`default_user_settings(Option<UserSettings>)`](crate::operation::describe_domain::DescribeDomainOutput::default_user_settings): <p>Settings which are applied to UserProfiles in this domain if settings are not explicitly specified in a given UserProfile.</p>
21    ///   - [`domain_settings(Option<DomainSettings>)`](crate::operation::describe_domain::DescribeDomainOutput::domain_settings): <p>A collection of <code>Domain</code> settings.</p>
22    ///   - [`app_network_access_type(Option<AppNetworkAccessType>)`](crate::operation::describe_domain::DescribeDomainOutput::app_network_access_type): <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>
23    ///   - [`home_efs_file_system_kms_key_id(Option<String>)`](crate::operation::describe_domain::DescribeDomainOutput::home_efs_file_system_kms_key_id): <p>Use <code>KmsKeyId</code>.</p>
24    ///   - [`subnet_ids(Option<Vec::<String>>)`](crate::operation::describe_domain::DescribeDomainOutput::subnet_ids): <p>The VPC subnets that the domain uses for communication.</p>
25    ///   - [`url(Option<String>)`](crate::operation::describe_domain::DescribeDomainOutput::url): <p>The domain's URL.</p>
26    ///   - [`vpc_id(Option<String>)`](crate::operation::describe_domain::DescribeDomainOutput::vpc_id): <p>The ID of the Amazon Virtual Private Cloud (VPC) that the domain uses for communication.</p>
27    ///   - [`kms_key_id(Option<String>)`](crate::operation::describe_domain::DescribeDomainOutput::kms_key_id): <p>The Amazon Web Services KMS customer managed key used to encrypt the EFS volume attached to the domain.</p>
28    ///   - [`app_security_group_management(Option<AppSecurityGroupManagement>)`](crate::operation::describe_domain::DescribeDomainOutput::app_security_group_management): <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>
29    ///   - [`tag_propagation(Option<TagPropagation>)`](crate::operation::describe_domain::DescribeDomainOutput::tag_propagation): <p>Indicates whether custom tag propagation is supported for the domain.</p>
30    ///   - [`default_space_settings(Option<DefaultSpaceSettings>)`](crate::operation::describe_domain::DescribeDomainOutput::default_space_settings): <p>The default settings for shared spaces that users create in the domain.</p>
31    /// - On failure, responds with [`SdkError<DescribeDomainError>`](crate::operation::describe_domain::DescribeDomainError)
32    pub fn describe_domain(&self) -> crate::operation::describe_domain::builders::DescribeDomainFluentBuilder {
33        crate::operation::describe_domain::builders::DescribeDomainFluentBuilder::new(self.handle.clone())
34    }
35}
aws_sdk_sagemaker/client/describe_domain.rs

aws_sdk_sagemaker/client/
describe_domain.rs
