aws_sdk_sagemaker/client/
list_spaces.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 [`ListSpaces`](crate::operation::list_spaces::builders::ListSpacesFluentBuilder) operation.
4    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_spaces::builders::ListSpacesFluentBuilder::into_paginator).
5    ///
6    /// - The fluent builder is configurable:
7    ///   - [`next_token(impl Into<String>)`](crate::operation::list_spaces::builders::ListSpacesFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_spaces::builders::ListSpacesFluentBuilder::set_next_token):<br>required: **false**<br><p>If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.</p><br>
8    ///   - [`max_results(i32)`](crate::operation::list_spaces::builders::ListSpacesFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_spaces::builders::ListSpacesFluentBuilder::set_max_results):<br>required: **false**<br><p>This parameter defines the maximum number of results that can be return in a single response. The <code>MaxResults</code> parameter is an upper bound, not a target. If there are more results available than the value specified, a <code>NextToken</code> is provided in the response. The <code>NextToken</code> indicates that the user should get the next set of results by providing this token as a part of a subsequent call. The default value for <code>MaxResults</code> is 10.</p><br>
9    ///   - [`sort_order(SortOrder)`](crate::operation::list_spaces::builders::ListSpacesFluentBuilder::sort_order) / [`set_sort_order(Option<SortOrder>)`](crate::operation::list_spaces::builders::ListSpacesFluentBuilder::set_sort_order):<br>required: **false**<br><p>The sort order for the results. The default is <code>Ascending</code>.</p><br>
10    ///   - [`sort_by(SpaceSortKey)`](crate::operation::list_spaces::builders::ListSpacesFluentBuilder::sort_by) / [`set_sort_by(Option<SpaceSortKey>)`](crate::operation::list_spaces::builders::ListSpacesFluentBuilder::set_sort_by):<br>required: **false**<br><p>The parameter by which to sort the results. The default is <code>CreationTime</code>.</p><br>
11    ///   - [`domain_id_equals(impl Into<String>)`](crate::operation::list_spaces::builders::ListSpacesFluentBuilder::domain_id_equals) / [`set_domain_id_equals(Option<String>)`](crate::operation::list_spaces::builders::ListSpacesFluentBuilder::set_domain_id_equals):<br>required: **false**<br><p>A parameter to search for the domain ID.</p><br>
12    ///   - [`space_name_contains(impl Into<String>)`](crate::operation::list_spaces::builders::ListSpacesFluentBuilder::space_name_contains) / [`set_space_name_contains(Option<String>)`](crate::operation::list_spaces::builders::ListSpacesFluentBuilder::set_space_name_contains):<br>required: **false**<br><p>A parameter by which to filter the results.</p><br>
13    /// - On success, responds with [`ListSpacesOutput`](crate::operation::list_spaces::ListSpacesOutput) with field(s):
14    ///   - [`spaces(Option<Vec::<SpaceDetails>>)`](crate::operation::list_spaces::ListSpacesOutput::spaces): <p>The list of spaces.</p>
15    ///   - [`next_token(Option<String>)`](crate::operation::list_spaces::ListSpacesOutput::next_token): <p>If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.</p>
16    /// - On failure, responds with [`SdkError<ListSpacesError>`](crate::operation::list_spaces::ListSpacesError)
17    pub fn list_spaces(&self) -> crate::operation::list_spaces::builders::ListSpacesFluentBuilder {
18        crate::operation::list_spaces::builders::ListSpacesFluentBuilder::new(self.handle.clone())
19    }
20}
aws_sdk_sagemaker/client/list_spaces.rs

aws_sdk_sagemaker/client/
list_spaces.rs
