aws_sdk_sagemaker/client/
list_workteams.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 [`ListWorkteams`](crate::operation::list_workteams::builders::ListWorkteamsFluentBuilder) operation.
4    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_workteams::builders::ListWorkteamsFluentBuilder::into_paginator).
5    ///
6    /// - The fluent builder is configurable:
7    ///   - [`sort_by(ListWorkteamsSortByOptions)`](crate::operation::list_workteams::builders::ListWorkteamsFluentBuilder::sort_by) / [`set_sort_by(Option<ListWorkteamsSortByOptions>)`](crate::operation::list_workteams::builders::ListWorkteamsFluentBuilder::set_sort_by):<br>required: **false**<br><p>The field to sort results by. The default is <code>CreationTime</code>.</p><br>
8    ///   - [`sort_order(SortOrder)`](crate::operation::list_workteams::builders::ListWorkteamsFluentBuilder::sort_order) / [`set_sort_order(Option<SortOrder>)`](crate::operation::list_workteams::builders::ListWorkteamsFluentBuilder::set_sort_order):<br>required: **false**<br><p>The sort order for results. The default is <code>Ascending</code>.</p><br>
9    ///   - [`name_contains(impl Into<String>)`](crate::operation::list_workteams::builders::ListWorkteamsFluentBuilder::name_contains) / [`set_name_contains(Option<String>)`](crate::operation::list_workteams::builders::ListWorkteamsFluentBuilder::set_name_contains):<br>required: **false**<br><p>A string in the work team's name. This filter returns only work teams whose name contains the specified string.</p><br>
10    ///   - [`next_token(impl Into<String>)`](crate::operation::list_workteams::builders::ListWorkteamsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_workteams::builders::ListWorkteamsFluentBuilder::set_next_token):<br>required: **false**<br><p>If the result of the previous <code>ListWorkteams</code> request was truncated, the response includes a <code>NextToken</code>. To retrieve the next set of labeling jobs, use the token in the next request.</p><br>
11    ///   - [`max_results(i32)`](crate::operation::list_workteams::builders::ListWorkteamsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_workteams::builders::ListWorkteamsFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of work teams to return in each page of the response.</p><br>
12    /// - On success, responds with [`ListWorkteamsOutput`](crate::operation::list_workteams::ListWorkteamsOutput) with field(s):
13    ///   - [`workteams(Option<Vec::<Workteam>>)`](crate::operation::list_workteams::ListWorkteamsOutput::workteams): <p>An array of <code>Workteam</code> objects, each describing a work team.</p>
14    ///   - [`next_token(Option<String>)`](crate::operation::list_workteams::ListWorkteamsOutput::next_token): <p>If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of work teams, use it in the subsequent request.</p>
15    /// - On failure, responds with [`SdkError<ListWorkteamsError>`](crate::operation::list_workteams::ListWorkteamsError)
16    pub fn list_workteams(&self) -> crate::operation::list_workteams::builders::ListWorkteamsFluentBuilder {
17        crate::operation::list_workteams::builders::ListWorkteamsFluentBuilder::new(self.handle.clone())
18    }
19}