aws_sdk_sagemaker/client/
describe_space.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 [`DescribeSpace`](crate::operation::describe_space::builders::DescribeSpaceFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`domain_id(impl Into<String>)`](crate::operation::describe_space::builders::DescribeSpaceFluentBuilder::domain_id) / [`set_domain_id(Option<String>)`](crate::operation::describe_space::builders::DescribeSpaceFluentBuilder::set_domain_id):<br>required: **true**<br><p>The ID of the associated domain.</p><br>
7    ///   - [`space_name(impl Into<String>)`](crate::operation::describe_space::builders::DescribeSpaceFluentBuilder::space_name) / [`set_space_name(Option<String>)`](crate::operation::describe_space::builders::DescribeSpaceFluentBuilder::set_space_name):<br>required: **true**<br><p>The name of the space.</p><br>
8    /// - On success, responds with [`DescribeSpaceOutput`](crate::operation::describe_space::DescribeSpaceOutput) with field(s):
9    ///   - [`domain_id(Option<String>)`](crate::operation::describe_space::DescribeSpaceOutput::domain_id): <p>The ID of the associated domain.</p>
10    ///   - [`space_arn(Option<String>)`](crate::operation::describe_space::DescribeSpaceOutput::space_arn): <p>The space's Amazon Resource Name (ARN).</p>
11    ///   - [`space_name(Option<String>)`](crate::operation::describe_space::DescribeSpaceOutput::space_name): <p>The name of the space.</p>
12    ///   - [`home_efs_file_system_uid(Option<String>)`](crate::operation::describe_space::DescribeSpaceOutput::home_efs_file_system_uid): <p>The ID of the space's profile in the Amazon EFS volume.</p>
13    ///   - [`status(Option<SpaceStatus>)`](crate::operation::describe_space::DescribeSpaceOutput::status): <p>The status.</p>
14    ///   - [`last_modified_time(Option<DateTime>)`](crate::operation::describe_space::DescribeSpaceOutput::last_modified_time): <p>The last modified time.</p>
15    ///   - [`creation_time(Option<DateTime>)`](crate::operation::describe_space::DescribeSpaceOutput::creation_time): <p>The creation time.</p>
16    ///   - [`failure_reason(Option<String>)`](crate::operation::describe_space::DescribeSpaceOutput::failure_reason): <p>The failure reason.</p>
17    ///   - [`space_settings(Option<SpaceSettings>)`](crate::operation::describe_space::DescribeSpaceOutput::space_settings): <p>A collection of space settings.</p>
18    ///   - [`ownership_settings(Option<OwnershipSettings>)`](crate::operation::describe_space::DescribeSpaceOutput::ownership_settings): <p>The collection of ownership settings for a space.</p>
19    ///   - [`space_sharing_settings(Option<SpaceSharingSettings>)`](crate::operation::describe_space::DescribeSpaceOutput::space_sharing_settings): <p>The collection of space sharing settings for a space.</p>
20    ///   - [`space_display_name(Option<String>)`](crate::operation::describe_space::DescribeSpaceOutput::space_display_name): <p>The name of the space that appears in the Amazon SageMaker Studio UI.</p>
21    ///   - [`url(Option<String>)`](crate::operation::describe_space::DescribeSpaceOutput::url): <p>Returns the URL of the space. If the space is created with Amazon Web Services IAM Identity Center (Successor to Amazon Web Services Single Sign-On) authentication, users can navigate to the URL after appending the respective redirect parameter for the application type to be federated through Amazon Web Services IAM Identity Center.</p> <p>The following application types are supported:</p> <ul>  <li>   <p>Studio Classic: <code>&amp;redirect=JupyterServer</code></p></li>  <li>   <p>JupyterLab: <code>&amp;redirect=JupyterLab</code></p></li>  <li>   <p>Code Editor, based on Code-OSS, Visual Studio Code - Open Source: <code>&amp;redirect=CodeEditor</code></p></li> </ul>
22    /// - On failure, responds with [`SdkError<DescribeSpaceError>`](crate::operation::describe_space::DescribeSpaceError)
23    pub fn describe_space(&self) -> crate::operation::describe_space::builders::DescribeSpaceFluentBuilder {
24        crate::operation::describe_space::builders::DescribeSpaceFluentBuilder::new(self.handle.clone())
25    }
26}
aws_sdk_sagemaker/client/describe_space.rs

aws_sdk_sagemaker/client/
describe_space.rs
