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
17
18
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`ListChildren`](crate::operation::list_children::builders::ListChildrenFluentBuilder) operation.
    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_children::builders::ListChildrenFluentBuilder::into_paginator).
    ///
    /// - The fluent builder is configurable:
    ///   - [`parent_id(impl Into<String>)`](crate::operation::list_children::builders::ListChildrenFluentBuilder::parent_id) / [`set_parent_id(Option<String>)`](crate::operation::list_children::builders::ListChildrenFluentBuilder::set_parent_id):<br>required: **true**<br><p>The unique identifier (ID) for the parent root or OU whose children you want to list.</p> <p>The <a href="http://wikipedia.org/wiki/regex">regex pattern</a> for a parent ID string requires one of the following:</p> <ul>  <li>   <p><b>Root</b> - A string that begins with "r-" followed by from 4 to 32 lowercase letters or digits.</p></li>  <li>   <p><b>Organizational unit (OU)</b> - A string that begins with "ou-" followed by from 4 to 32 lowercase letters or digits (the ID of the root that the OU is in). This string is followed by a second "-" dash and from 8 to 32 additional lowercase letters or digits.</p></li> </ul><br>
    ///   - [`child_type(ChildType)`](crate::operation::list_children::builders::ListChildrenFluentBuilder::child_type) / [`set_child_type(Option<ChildType>)`](crate::operation::list_children::builders::ListChildrenFluentBuilder::set_child_type):<br>required: **true**<br><p>Filters the output to include only the specified child type.</p><br>
    ///   - [`next_token(impl Into<String>)`](crate::operation::list_children::builders::ListChildrenFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_children::builders::ListChildrenFluentBuilder::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_children::builders::ListChildrenFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_children::builders::ListChildrenFluentBuilder::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 [`ListChildrenOutput`](crate::operation::list_children::ListChildrenOutput) with field(s):
    ///   - [`children(Option<Vec::<Child>>)`](crate::operation::list_children::ListChildrenOutput::children): <p>The list of children of the specified parent container.</p>
    ///   - [`next_token(Option<String>)`](crate::operation::list_children::ListChildrenOutput::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<ListChildrenError>`](crate::operation::list_children::ListChildrenError)
    pub fn list_children(&self) -> crate::operation::list_children::builders::ListChildrenFluentBuilder {
        crate::operation::list_children::builders::ListChildrenFluentBuilder::new(self.handle.clone())
    }
}