aws-sdk-organizations 1.119.1

AWS SDK for AWS Organizations
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`ListRoots`](crate::operation::list_roots::builders::ListRootsFluentBuilder) operation.
    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_roots::builders::ListRootsFluentBuilder::into_paginator).
    ///
    /// - The fluent builder is configurable:
    ///   - [`next_token(impl Into<String>)`](crate::operation::list_roots::builders::ListRootsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_roots::builders::ListRootsFluentBuilder::set_next_token):<br>required: **false**<br><p>The parameter for receiving additional results if you receive a <code>NextToken</code> response in a previous request. A <code>NextToken</code> response indicates that more output is available. Set this parameter to the value of the previous call's <code>NextToken</code> response to indicate where the output should continue from.</p><br>
    ///   - [`max_results(i32)`](crate::operation::list_roots::builders::ListRootsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_roots::builders::ListRootsFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of items to return in the response. If more results exist than the specified <code>MaxResults</code> value, a token is included in the response so that you can retrieve the remaining results.</p><br>
    /// - On success, responds with [`ListRootsOutput`](crate::operation::list_roots::ListRootsOutput) with field(s):
    ///   - [`roots(Option<Vec::<Root>>)`](crate::operation::list_roots::ListRootsOutput::roots): <p>A list of roots that are defined in an organization.</p>
    ///   - [`next_token(Option<String>)`](crate::operation::list_roots::ListRootsOutput::next_token): <p>If present, indicates that more output is available than is included in the current response. Use this value in the <code>NextToken</code> request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the <code>NextToken</code> response element comes back as <code>null</code>.</p>
    /// - On failure, responds with [`SdkError<ListRootsError>`](crate::operation::list_roots::ListRootsError)
    pub fn list_roots(&self) -> crate::operation::list_roots::builders::ListRootsFluentBuilder {
        crate::operation::list_roots::builders::ListRootsFluentBuilder::new(self.handle.clone())
    }
}