aws_sdk_datazone/client/list_account_pools.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 [`ListAccountPools`](crate::operation::list_account_pools::builders::ListAccountPoolsFluentBuilder) operation.
4 /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_account_pools::builders::ListAccountPoolsFluentBuilder::into_paginator).
5 ///
6 /// - The fluent builder is configurable:
7 /// - [`domain_identifier(impl Into<String>)`](crate::operation::list_account_pools::builders::ListAccountPoolsFluentBuilder::domain_identifier) / [`set_domain_identifier(Option<String>)`](crate::operation::list_account_pools::builders::ListAccountPoolsFluentBuilder::set_domain_identifier):<br>required: **true**<br><p>The ID of the domain where exsting account pools are to be listed.</p><br>
8 /// - [`name(impl Into<String>)`](crate::operation::list_account_pools::builders::ListAccountPoolsFluentBuilder::name) / [`set_name(Option<String>)`](crate::operation::list_account_pools::builders::ListAccountPoolsFluentBuilder::set_name):<br>required: **false**<br><p>The name of the account pool to be listed.</p><br>
9 /// - [`sort_by(SortFieldAccountPool)`](crate::operation::list_account_pools::builders::ListAccountPoolsFluentBuilder::sort_by) / [`set_sort_by(Option<SortFieldAccountPool>)`](crate::operation::list_account_pools::builders::ListAccountPoolsFluentBuilder::set_sort_by):<br>required: **false**<br><p>The sort by mechanism in which the existing account pools are to be listed.</p><br>
10 /// - [`sort_order(SortOrder)`](crate::operation::list_account_pools::builders::ListAccountPoolsFluentBuilder::sort_order) / [`set_sort_order(Option<SortOrder>)`](crate::operation::list_account_pools::builders::ListAccountPoolsFluentBuilder::set_sort_order):<br>required: **false**<br><p>The sort order in which the existing account pools are to be listed.</p><br>
11 /// - [`next_token(impl Into<String>)`](crate::operation::list_account_pools::builders::ListAccountPoolsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_account_pools::builders::ListAccountPoolsFluentBuilder::set_next_token):<br>required: **false**<br><p>When the number of account pools is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of account pools, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListAccountPools to list the next set of account pools.</p><br>
12 /// - [`max_results(i32)`](crate::operation::list_account_pools::builders::ListAccountPoolsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_account_pools::builders::ListAccountPoolsFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of account pools to return in a single call to ListAccountPools. When the number of account pools to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to ListAccountPools to list the next set of account pools.</p><br>
13 /// - On success, responds with [`ListAccountPoolsOutput`](crate::operation::list_account_pools::ListAccountPoolsOutput) with field(s):
14 /// - [`items(Option<Vec::<AccountPoolSummary>>)`](crate::operation::list_account_pools::ListAccountPoolsOutput::items): <p>The results of the ListAccountPools operation.</p>
15 /// - [`next_token(Option<String>)`](crate::operation::list_account_pools::ListAccountPoolsOutput::next_token): <p>When the number of account pools is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of account pools, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListAccountPools to list the next set of account pools.</p>
16 /// - On failure, responds with [`SdkError<ListAccountPoolsError>`](crate::operation::list_account_pools::ListAccountPoolsError)
17 pub fn list_account_pools(&self) -> crate::operation::list_account_pools::builders::ListAccountPoolsFluentBuilder {
18 crate::operation::list_account_pools::builders::ListAccountPoolsFluentBuilder::new(self.handle.clone())
19 }
20}