aws_sdk_sagemaker/operation/describe_space/
_describe_space_output.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2#[allow(missing_docs)] // documentation missing in model
3#[non_exhaustive]
4#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::fmt::Debug)]
5pub struct DescribeSpaceOutput {
6    /// <p>The ID of the associated domain.</p>
7    pub domain_id: ::std::option::Option<::std::string::String>,
8    /// <p>The space's Amazon Resource Name (ARN).</p>
9    pub space_arn: ::std::option::Option<::std::string::String>,
10    /// <p>The name of the space.</p>
11    pub space_name: ::std::option::Option<::std::string::String>,
12    /// <p>The ID of the space's profile in the Amazon EFS volume.</p>
13    pub home_efs_file_system_uid: ::std::option::Option<::std::string::String>,
14    /// <p>The status.</p>
15    pub status: ::std::option::Option<crate::types::SpaceStatus>,
16    /// <p>The last modified time.</p>
17    pub last_modified_time: ::std::option::Option<::aws_smithy_types::DateTime>,
18    /// <p>The creation time.</p>
19    pub creation_time: ::std::option::Option<::aws_smithy_types::DateTime>,
20    /// <p>The failure reason.</p>
21    pub failure_reason: ::std::option::Option<::std::string::String>,
22    /// <p>A collection of space settings.</p>
23    pub space_settings: ::std::option::Option<crate::types::SpaceSettings>,
24    /// <p>The collection of ownership settings for a space.</p>
25    pub ownership_settings: ::std::option::Option<crate::types::OwnershipSettings>,
26    /// <p>The collection of space sharing settings for a space.</p>
27    pub space_sharing_settings: ::std::option::Option<crate::types::SpaceSharingSettings>,
28    /// <p>The name of the space that appears in the Amazon SageMaker Studio UI.</p>
29    pub space_display_name: ::std::option::Option<::std::string::String>,
30    /// <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>
31    /// <p>The following application types are supported:</p>
32    /// <ul>
33    /// <li>
34    /// <p>Studio Classic: <code>&amp;redirect=JupyterServer</code></p></li>
35    /// <li>
36    /// <p>JupyterLab: <code>&amp;redirect=JupyterLab</code></p></li>
37    /// <li>
38    /// <p>Code Editor, based on Code-OSS, Visual Studio Code - Open Source: <code>&amp;redirect=CodeEditor</code></p></li>
39    /// </ul>
40    pub url: ::std::option::Option<::std::string::String>,
41    _request_id: Option<String>,
42}
43impl DescribeSpaceOutput {
44    /// <p>The ID of the associated domain.</p>
45    pub fn domain_id(&self) -> ::std::option::Option<&str> {
46        self.domain_id.as_deref()
47    }
48    /// <p>The space's Amazon Resource Name (ARN).</p>
49    pub fn space_arn(&self) -> ::std::option::Option<&str> {
50        self.space_arn.as_deref()
51    }
52    /// <p>The name of the space.</p>
53    pub fn space_name(&self) -> ::std::option::Option<&str> {
54        self.space_name.as_deref()
55    }
56    /// <p>The ID of the space's profile in the Amazon EFS volume.</p>
57    pub fn home_efs_file_system_uid(&self) -> ::std::option::Option<&str> {
58        self.home_efs_file_system_uid.as_deref()
59    }
60    /// <p>The status.</p>
61    pub fn status(&self) -> ::std::option::Option<&crate::types::SpaceStatus> {
62        self.status.as_ref()
63    }
64    /// <p>The last modified time.</p>
65    pub fn last_modified_time(&self) -> ::std::option::Option<&::aws_smithy_types::DateTime> {
66        self.last_modified_time.as_ref()
67    }
68    /// <p>The creation time.</p>
69    pub fn creation_time(&self) -> ::std::option::Option<&::aws_smithy_types::DateTime> {
70        self.creation_time.as_ref()
71    }
72    /// <p>The failure reason.</p>
73    pub fn failure_reason(&self) -> ::std::option::Option<&str> {
74        self.failure_reason.as_deref()
75    }
76    /// <p>A collection of space settings.</p>
77    pub fn space_settings(&self) -> ::std::option::Option<&crate::types::SpaceSettings> {
78        self.space_settings.as_ref()
79    }
80    /// <p>The collection of ownership settings for a space.</p>
81    pub fn ownership_settings(&self) -> ::std::option::Option<&crate::types::OwnershipSettings> {
82        self.ownership_settings.as_ref()
83    }
84    /// <p>The collection of space sharing settings for a space.</p>
85    pub fn space_sharing_settings(&self) -> ::std::option::Option<&crate::types::SpaceSharingSettings> {
86        self.space_sharing_settings.as_ref()
87    }
88    /// <p>The name of the space that appears in the Amazon SageMaker Studio UI.</p>
89    pub fn space_display_name(&self) -> ::std::option::Option<&str> {
90        self.space_display_name.as_deref()
91    }
92    /// <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>
93    /// <p>The following application types are supported:</p>
94    /// <ul>
95    /// <li>
96    /// <p>Studio Classic: <code>&amp;redirect=JupyterServer</code></p></li>
97    /// <li>
98    /// <p>JupyterLab: <code>&amp;redirect=JupyterLab</code></p></li>
99    /// <li>
100    /// <p>Code Editor, based on Code-OSS, Visual Studio Code - Open Source: <code>&amp;redirect=CodeEditor</code></p></li>
101    /// </ul>
102    pub fn url(&self) -> ::std::option::Option<&str> {
103        self.url.as_deref()
104    }
105}
106impl ::aws_types::request_id::RequestId for DescribeSpaceOutput {
107    fn request_id(&self) -> Option<&str> {
108        self._request_id.as_deref()
109    }
110}
111impl DescribeSpaceOutput {
112    /// Creates a new builder-style object to manufacture [`DescribeSpaceOutput`](crate::operation::describe_space::DescribeSpaceOutput).
113    pub fn builder() -> crate::operation::describe_space::builders::DescribeSpaceOutputBuilder {
114        crate::operation::describe_space::builders::DescribeSpaceOutputBuilder::default()
115    }
116}
117
118/// A builder for [`DescribeSpaceOutput`](crate::operation::describe_space::DescribeSpaceOutput).
119#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
120#[non_exhaustive]
121pub struct DescribeSpaceOutputBuilder {
122    pub(crate) domain_id: ::std::option::Option<::std::string::String>,
123    pub(crate) space_arn: ::std::option::Option<::std::string::String>,
124    pub(crate) space_name: ::std::option::Option<::std::string::String>,
125    pub(crate) home_efs_file_system_uid: ::std::option::Option<::std::string::String>,
126    pub(crate) status: ::std::option::Option<crate::types::SpaceStatus>,
127    pub(crate) last_modified_time: ::std::option::Option<::aws_smithy_types::DateTime>,
128    pub(crate) creation_time: ::std::option::Option<::aws_smithy_types::DateTime>,
129    pub(crate) failure_reason: ::std::option::Option<::std::string::String>,
130    pub(crate) space_settings: ::std::option::Option<crate::types::SpaceSettings>,
131    pub(crate) ownership_settings: ::std::option::Option<crate::types::OwnershipSettings>,
132    pub(crate) space_sharing_settings: ::std::option::Option<crate::types::SpaceSharingSettings>,
133    pub(crate) space_display_name: ::std::option::Option<::std::string::String>,
134    pub(crate) url: ::std::option::Option<::std::string::String>,
135    _request_id: Option<String>,
136}
137impl DescribeSpaceOutputBuilder {
138    /// <p>The ID of the associated domain.</p>
139    pub fn domain_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
140        self.domain_id = ::std::option::Option::Some(input.into());
141        self
142    }
143    /// <p>The ID of the associated domain.</p>
144    pub fn set_domain_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
145        self.domain_id = input;
146        self
147    }
148    /// <p>The ID of the associated domain.</p>
149    pub fn get_domain_id(&self) -> &::std::option::Option<::std::string::String> {
150        &self.domain_id
151    }
152    /// <p>The space's Amazon Resource Name (ARN).</p>
153    pub fn space_arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
154        self.space_arn = ::std::option::Option::Some(input.into());
155        self
156    }
157    /// <p>The space's Amazon Resource Name (ARN).</p>
158    pub fn set_space_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
159        self.space_arn = input;
160        self
161    }
162    /// <p>The space's Amazon Resource Name (ARN).</p>
163    pub fn get_space_arn(&self) -> &::std::option::Option<::std::string::String> {
164        &self.space_arn
165    }
166    /// <p>The name of the space.</p>
167    pub fn space_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
168        self.space_name = ::std::option::Option::Some(input.into());
169        self
170    }
171    /// <p>The name of the space.</p>
172    pub fn set_space_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
173        self.space_name = input;
174        self
175    }
176    /// <p>The name of the space.</p>
177    pub fn get_space_name(&self) -> &::std::option::Option<::std::string::String> {
178        &self.space_name
179    }
180    /// <p>The ID of the space's profile in the Amazon EFS volume.</p>
181    pub fn home_efs_file_system_uid(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
182        self.home_efs_file_system_uid = ::std::option::Option::Some(input.into());
183        self
184    }
185    /// <p>The ID of the space's profile in the Amazon EFS volume.</p>
186    pub fn set_home_efs_file_system_uid(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
187        self.home_efs_file_system_uid = input;
188        self
189    }
190    /// <p>The ID of the space's profile in the Amazon EFS volume.</p>
191    pub fn get_home_efs_file_system_uid(&self) -> &::std::option::Option<::std::string::String> {
192        &self.home_efs_file_system_uid
193    }
194    /// <p>The status.</p>
195    pub fn status(mut self, input: crate::types::SpaceStatus) -> Self {
196        self.status = ::std::option::Option::Some(input);
197        self
198    }
199    /// <p>The status.</p>
200    pub fn set_status(mut self, input: ::std::option::Option<crate::types::SpaceStatus>) -> Self {
201        self.status = input;
202        self
203    }
204    /// <p>The status.</p>
205    pub fn get_status(&self) -> &::std::option::Option<crate::types::SpaceStatus> {
206        &self.status
207    }
208    /// <p>The last modified time.</p>
209    pub fn last_modified_time(mut self, input: ::aws_smithy_types::DateTime) -> Self {
210        self.last_modified_time = ::std::option::Option::Some(input);
211        self
212    }
213    /// <p>The last modified time.</p>
214    pub fn set_last_modified_time(mut self, input: ::std::option::Option<::aws_smithy_types::DateTime>) -> Self {
215        self.last_modified_time = input;
216        self
217    }
218    /// <p>The last modified time.</p>
219    pub fn get_last_modified_time(&self) -> &::std::option::Option<::aws_smithy_types::DateTime> {
220        &self.last_modified_time
221    }
222    /// <p>The creation time.</p>
223    pub fn creation_time(mut self, input: ::aws_smithy_types::DateTime) -> Self {
224        self.creation_time = ::std::option::Option::Some(input);
225        self
226    }
227    /// <p>The creation time.</p>
228    pub fn set_creation_time(mut self, input: ::std::option::Option<::aws_smithy_types::DateTime>) -> Self {
229        self.creation_time = input;
230        self
231    }
232    /// <p>The creation time.</p>
233    pub fn get_creation_time(&self) -> &::std::option::Option<::aws_smithy_types::DateTime> {
234        &self.creation_time
235    }
236    /// <p>The failure reason.</p>
237    pub fn failure_reason(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
238        self.failure_reason = ::std::option::Option::Some(input.into());
239        self
240    }
241    /// <p>The failure reason.</p>
242    pub fn set_failure_reason(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
243        self.failure_reason = input;
244        self
245    }
246    /// <p>The failure reason.</p>
247    pub fn get_failure_reason(&self) -> &::std::option::Option<::std::string::String> {
248        &self.failure_reason
249    }
250    /// <p>A collection of space settings.</p>
251    pub fn space_settings(mut self, input: crate::types::SpaceSettings) -> Self {
252        self.space_settings = ::std::option::Option::Some(input);
253        self
254    }
255    /// <p>A collection of space settings.</p>
256    pub fn set_space_settings(mut self, input: ::std::option::Option<crate::types::SpaceSettings>) -> Self {
257        self.space_settings = input;
258        self
259    }
260    /// <p>A collection of space settings.</p>
261    pub fn get_space_settings(&self) -> &::std::option::Option<crate::types::SpaceSettings> {
262        &self.space_settings
263    }
264    /// <p>The collection of ownership settings for a space.</p>
265    pub fn ownership_settings(mut self, input: crate::types::OwnershipSettings) -> Self {
266        self.ownership_settings = ::std::option::Option::Some(input);
267        self
268    }
269    /// <p>The collection of ownership settings for a space.</p>
270    pub fn set_ownership_settings(mut self, input: ::std::option::Option<crate::types::OwnershipSettings>) -> Self {
271        self.ownership_settings = input;
272        self
273    }
274    /// <p>The collection of ownership settings for a space.</p>
275    pub fn get_ownership_settings(&self) -> &::std::option::Option<crate::types::OwnershipSettings> {
276        &self.ownership_settings
277    }
278    /// <p>The collection of space sharing settings for a space.</p>
279    pub fn space_sharing_settings(mut self, input: crate::types::SpaceSharingSettings) -> Self {
280        self.space_sharing_settings = ::std::option::Option::Some(input);
281        self
282    }
283    /// <p>The collection of space sharing settings for a space.</p>
284    pub fn set_space_sharing_settings(mut self, input: ::std::option::Option<crate::types::SpaceSharingSettings>) -> Self {
285        self.space_sharing_settings = input;
286        self
287    }
288    /// <p>The collection of space sharing settings for a space.</p>
289    pub fn get_space_sharing_settings(&self) -> &::std::option::Option<crate::types::SpaceSharingSettings> {
290        &self.space_sharing_settings
291    }
292    /// <p>The name of the space that appears in the Amazon SageMaker Studio UI.</p>
293    pub fn space_display_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
294        self.space_display_name = ::std::option::Option::Some(input.into());
295        self
296    }
297    /// <p>The name of the space that appears in the Amazon SageMaker Studio UI.</p>
298    pub fn set_space_display_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
299        self.space_display_name = input;
300        self
301    }
302    /// <p>The name of the space that appears in the Amazon SageMaker Studio UI.</p>
303    pub fn get_space_display_name(&self) -> &::std::option::Option<::std::string::String> {
304        &self.space_display_name
305    }
306    /// <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>
307    /// <p>The following application types are supported:</p>
308    /// <ul>
309    /// <li>
310    /// <p>Studio Classic: <code>&amp;redirect=JupyterServer</code></p></li>
311    /// <li>
312    /// <p>JupyterLab: <code>&amp;redirect=JupyterLab</code></p></li>
313    /// <li>
314    /// <p>Code Editor, based on Code-OSS, Visual Studio Code - Open Source: <code>&amp;redirect=CodeEditor</code></p></li>
315    /// </ul>
316    pub fn url(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
317        self.url = ::std::option::Option::Some(input.into());
318        self
319    }
320    /// <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>
321    /// <p>The following application types are supported:</p>
322    /// <ul>
323    /// <li>
324    /// <p>Studio Classic: <code>&amp;redirect=JupyterServer</code></p></li>
325    /// <li>
326    /// <p>JupyterLab: <code>&amp;redirect=JupyterLab</code></p></li>
327    /// <li>
328    /// <p>Code Editor, based on Code-OSS, Visual Studio Code - Open Source: <code>&amp;redirect=CodeEditor</code></p></li>
329    /// </ul>
330    pub fn set_url(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
331        self.url = input;
332        self
333    }
334    /// <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>
335    /// <p>The following application types are supported:</p>
336    /// <ul>
337    /// <li>
338    /// <p>Studio Classic: <code>&amp;redirect=JupyterServer</code></p></li>
339    /// <li>
340    /// <p>JupyterLab: <code>&amp;redirect=JupyterLab</code></p></li>
341    /// <li>
342    /// <p>Code Editor, based on Code-OSS, Visual Studio Code - Open Source: <code>&amp;redirect=CodeEditor</code></p></li>
343    /// </ul>
344    pub fn get_url(&self) -> &::std::option::Option<::std::string::String> {
345        &self.url
346    }
347    pub(crate) fn _request_id(mut self, request_id: impl Into<String>) -> Self {
348        self._request_id = Some(request_id.into());
349        self
350    }
351
352    pub(crate) fn _set_request_id(&mut self, request_id: Option<String>) -> &mut Self {
353        self._request_id = request_id;
354        self
355    }
356    /// Consumes the builder and constructs a [`DescribeSpaceOutput`](crate::operation::describe_space::DescribeSpaceOutput).
357    pub fn build(self) -> crate::operation::describe_space::DescribeSpaceOutput {
358        crate::operation::describe_space::DescribeSpaceOutput {
359            domain_id: self.domain_id,
360            space_arn: self.space_arn,
361            space_name: self.space_name,
362            home_efs_file_system_uid: self.home_efs_file_system_uid,
363            status: self.status,
364            last_modified_time: self.last_modified_time,
365            creation_time: self.creation_time,
366            failure_reason: self.failure_reason,
367            space_settings: self.space_settings,
368            ownership_settings: self.ownership_settings,
369            space_sharing_settings: self.space_sharing_settings,
370            space_display_name: self.space_display_name,
371            url: self.url,
372            _request_id: self._request_id,
373        }
374    }
375}
aws_sdk_sagemaker/operation/describe_space/_describe_space_output.rs

aws_sdk_sagemaker/operation/describe_space/
_describe_space_output.rs
