aws_sdk_sagemaker/operation/describe_space/
_describe_space_output.rs

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

/// A builder for [`DescribeSpaceOutput`](crate::operation::describe_space::DescribeSpaceOutput).
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
#[non_exhaustive]
pub struct DescribeSpaceOutputBuilder {
    pub(crate) domain_id: ::std::option::Option<::std::string::String>,
    pub(crate) space_arn: ::std::option::Option<::std::string::String>,
    pub(crate) space_name: ::std::option::Option<::std::string::String>,
    pub(crate) home_efs_file_system_uid: ::std::option::Option<::std::string::String>,
    pub(crate) status: ::std::option::Option<crate::types::SpaceStatus>,
    pub(crate) last_modified_time: ::std::option::Option<::aws_smithy_types::DateTime>,
    pub(crate) creation_time: ::std::option::Option<::aws_smithy_types::DateTime>,
    pub(crate) failure_reason: ::std::option::Option<::std::string::String>,
    pub(crate) space_settings: ::std::option::Option<crate::types::SpaceSettings>,
    pub(crate) ownership_settings: ::std::option::Option<crate::types::OwnershipSettings>,
    pub(crate) space_sharing_settings: ::std::option::Option<crate::types::SpaceSharingSettings>,
    pub(crate) space_display_name: ::std::option::Option<::std::string::String>,
    pub(crate) url: ::std::option::Option<::std::string::String>,
    _request_id: Option<String>,
}
impl DescribeSpaceOutputBuilder {
    /// <p>The ID of the associated domain.</p>
    pub fn domain_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.domain_id = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The ID of the associated domain.</p>
    pub fn set_domain_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.domain_id = input;
        self
    }
    /// <p>The ID of the associated domain.</p>
    pub fn get_domain_id(&self) -> &::std::option::Option<::std::string::String> {
        &self.domain_id
    }
    /// <p>The space's Amazon Resource Name (ARN).</p>
    pub fn space_arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.space_arn = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The space's Amazon Resource Name (ARN).</p>
    pub fn set_space_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.space_arn = input;
        self
    }
    /// <p>The space's Amazon Resource Name (ARN).</p>
    pub fn get_space_arn(&self) -> &::std::option::Option<::std::string::String> {
        &self.space_arn
    }
    /// <p>The name of the space.</p>
    pub fn space_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.space_name = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The name of the space.</p>
    pub fn set_space_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.space_name = input;
        self
    }
    /// <p>The name of the space.</p>
    pub fn get_space_name(&self) -> &::std::option::Option<::std::string::String> {
        &self.space_name
    }
    /// <p>The ID of the space's profile in the Amazon EFS volume.</p>
    pub fn home_efs_file_system_uid(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.home_efs_file_system_uid = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The ID of the space's profile in the Amazon EFS volume.</p>
    pub fn set_home_efs_file_system_uid(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.home_efs_file_system_uid = input;
        self
    }
    /// <p>The ID of the space's profile in the Amazon EFS volume.</p>
    pub fn get_home_efs_file_system_uid(&self) -> &::std::option::Option<::std::string::String> {
        &self.home_efs_file_system_uid
    }
    /// <p>The status.</p>
    pub fn status(mut self, input: crate::types::SpaceStatus) -> Self {
        self.status = ::std::option::Option::Some(input);
        self
    }
    /// <p>The status.</p>
    pub fn set_status(mut self, input: ::std::option::Option<crate::types::SpaceStatus>) -> Self {
        self.status = input;
        self
    }
    /// <p>The status.</p>
    pub fn get_status(&self) -> &::std::option::Option<crate::types::SpaceStatus> {
        &self.status
    }
    /// <p>The last modified time.</p>
    pub fn last_modified_time(mut self, input: ::aws_smithy_types::DateTime) -> Self {
        self.last_modified_time = ::std::option::Option::Some(input);
        self
    }
    /// <p>The last modified time.</p>
    pub fn set_last_modified_time(mut self, input: ::std::option::Option<::aws_smithy_types::DateTime>) -> Self {
        self.last_modified_time = input;
        self
    }
    /// <p>The last modified time.</p>
    pub fn get_last_modified_time(&self) -> &::std::option::Option<::aws_smithy_types::DateTime> {
        &self.last_modified_time
    }
    /// <p>The creation time.</p>
    pub fn creation_time(mut self, input: ::aws_smithy_types::DateTime) -> Self {
        self.creation_time = ::std::option::Option::Some(input);
        self
    }
    /// <p>The creation time.</p>
    pub fn set_creation_time(mut self, input: ::std::option::Option<::aws_smithy_types::DateTime>) -> Self {
        self.creation_time = input;
        self
    }
    /// <p>The creation time.</p>
    pub fn get_creation_time(&self) -> &::std::option::Option<::aws_smithy_types::DateTime> {
        &self.creation_time
    }
    /// <p>The failure reason.</p>
    pub fn failure_reason(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.failure_reason = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The failure reason.</p>
    pub fn set_failure_reason(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.failure_reason = input;
        self
    }
    /// <p>The failure reason.</p>
    pub fn get_failure_reason(&self) -> &::std::option::Option<::std::string::String> {
        &self.failure_reason
    }
    /// <p>A collection of space settings.</p>
    pub fn space_settings(mut self, input: crate::types::SpaceSettings) -> Self {
        self.space_settings = ::std::option::Option::Some(input);
        self
    }
    /// <p>A collection of space settings.</p>
    pub fn set_space_settings(mut self, input: ::std::option::Option<crate::types::SpaceSettings>) -> Self {
        self.space_settings = input;
        self
    }
    /// <p>A collection of space settings.</p>
    pub fn get_space_settings(&self) -> &::std::option::Option<crate::types::SpaceSettings> {
        &self.space_settings
    }
    /// <p>The collection of ownership settings for a space.</p>
    pub fn ownership_settings(mut self, input: crate::types::OwnershipSettings) -> Self {
        self.ownership_settings = ::std::option::Option::Some(input);
        self
    }
    /// <p>The collection of ownership settings for a space.</p>
    pub fn set_ownership_settings(mut self, input: ::std::option::Option<crate::types::OwnershipSettings>) -> Self {
        self.ownership_settings = input;
        self
    }
    /// <p>The collection of ownership settings for a space.</p>
    pub fn get_ownership_settings(&self) -> &::std::option::Option<crate::types::OwnershipSettings> {
        &self.ownership_settings
    }
    /// <p>The collection of space sharing settings for a space.</p>
    pub fn space_sharing_settings(mut self, input: crate::types::SpaceSharingSettings) -> Self {
        self.space_sharing_settings = ::std::option::Option::Some(input);
        self
    }
    /// <p>The collection of space sharing settings for a space.</p>
    pub fn set_space_sharing_settings(mut self, input: ::std::option::Option<crate::types::SpaceSharingSettings>) -> Self {
        self.space_sharing_settings = input;
        self
    }
    /// <p>The collection of space sharing settings for a space.</p>
    pub fn get_space_sharing_settings(&self) -> &::std::option::Option<crate::types::SpaceSharingSettings> {
        &self.space_sharing_settings
    }
    /// <p>The name of the space that appears in the Amazon SageMaker Studio UI.</p>
    pub fn space_display_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.space_display_name = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The name of the space that appears in the Amazon SageMaker Studio UI.</p>
    pub fn set_space_display_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.space_display_name = input;
        self
    }
    /// <p>The name of the space that appears in the Amazon SageMaker Studio UI.</p>
    pub fn get_space_display_name(&self) -> &::std::option::Option<::std::string::String> {
        &self.space_display_name
    }
    /// <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>
    pub fn url(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.url = ::std::option::Option::Some(input.into());
        self
    }
    /// <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>
    pub fn set_url(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.url = input;
        self
    }
    /// <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>
    pub fn get_url(&self) -> &::std::option::Option<::std::string::String> {
        &self.url
    }
    pub(crate) fn _request_id(mut self, request_id: impl Into<String>) -> Self {
        self._request_id = Some(request_id.into());
        self
    }

    pub(crate) fn _set_request_id(&mut self, request_id: Option<String>) -> &mut Self {
        self._request_id = request_id;
        self
    }
    /// Consumes the builder and constructs a [`DescribeSpaceOutput`](crate::operation::describe_space::DescribeSpaceOutput).
    pub fn build(self) -> crate::operation::describe_space::DescribeSpaceOutput {
        crate::operation::describe_space::DescribeSpaceOutput {
            domain_id: self.domain_id,
            space_arn: self.space_arn,
            space_name: self.space_name,
            home_efs_file_system_uid: self.home_efs_file_system_uid,
            status: self.status,
            last_modified_time: self.last_modified_time,
            creation_time: self.creation_time,
            failure_reason: self.failure_reason,
            space_settings: self.space_settings,
            ownership_settings: self.ownership_settings,
            space_sharing_settings: self.space_sharing_settings,
            space_display_name: self.space_display_name,
            url: self.url,
            _request_id: self._request_id,
        }
    }
}