aws_sdk_sagemaker/client/
list_apps.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 [`ListApps`](crate::operation::list_apps::builders::ListAppsFluentBuilder) operation.
4    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_apps::builders::ListAppsFluentBuilder::into_paginator).
5    ///
6    /// - The fluent builder is configurable:
7    ///   - [`next_token(impl Into<String>)`](crate::operation::list_apps::builders::ListAppsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_apps::builders::ListAppsFluentBuilder::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_apps::builders::ListAppsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_apps::builders::ListAppsFluentBuilder::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_apps::builders::ListAppsFluentBuilder::sort_order) / [`set_sort_order(Option<SortOrder>)`](crate::operation::list_apps::builders::ListAppsFluentBuilder::set_sort_order):<br>required: **false**<br><p>The sort order for the results. The default is Ascending.</p><br>
10    ///   - [`sort_by(AppSortKey)`](crate::operation::list_apps::builders::ListAppsFluentBuilder::sort_by) / [`set_sort_by(Option<AppSortKey>)`](crate::operation::list_apps::builders::ListAppsFluentBuilder::set_sort_by):<br>required: **false**<br><p>The parameter by which to sort the results. The default is CreationTime.</p><br>
11    ///   - [`domain_id_equals(impl Into<String>)`](crate::operation::list_apps::builders::ListAppsFluentBuilder::domain_id_equals) / [`set_domain_id_equals(Option<String>)`](crate::operation::list_apps::builders::ListAppsFluentBuilder::set_domain_id_equals):<br>required: **false**<br><p>A parameter to search for the domain ID.</p><br>
12    ///   - [`user_profile_name_equals(impl Into<String>)`](crate::operation::list_apps::builders::ListAppsFluentBuilder::user_profile_name_equals) / [`set_user_profile_name_equals(Option<String>)`](crate::operation::list_apps::builders::ListAppsFluentBuilder::set_user_profile_name_equals):<br>required: **false**<br><p>A parameter to search by user profile name. If <code>SpaceNameEquals</code> is set, then this value cannot be set.</p><br>
13    ///   - [`space_name_equals(impl Into<String>)`](crate::operation::list_apps::builders::ListAppsFluentBuilder::space_name_equals) / [`set_space_name_equals(Option<String>)`](crate::operation::list_apps::builders::ListAppsFluentBuilder::set_space_name_equals):<br>required: **false**<br><p>A parameter to search by space name. If <code>UserProfileNameEquals</code> is set, then this value cannot be set.</p><br>
14    /// - On success, responds with [`ListAppsOutput`](crate::operation::list_apps::ListAppsOutput) with field(s):
15    ///   - [`apps(Option<Vec::<AppDetails>>)`](crate::operation::list_apps::ListAppsOutput::apps): <p>The list of apps.</p>
16    ///   - [`next_token(Option<String>)`](crate::operation::list_apps::ListAppsOutput::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>
17    /// - On failure, responds with [`SdkError<ListAppsError>`](crate::operation::list_apps::ListAppsError)
18    pub fn list_apps(&self) -> crate::operation::list_apps::builders::ListAppsFluentBuilder {
19        crate::operation::list_apps::builders::ListAppsFluentBuilder::new(self.handle.clone())
20    }
21}
aws_sdk_sagemaker/client/list_apps.rs

aws_sdk_sagemaker/client/
list_apps.rs
