Package software.amazon.awssdk.services.organizations.model

Interface ListChildrenRequest.Builder

    • Method Detail

      • parentId

        ListChildrenRequest.Builder parentId​(String parentId)

        The unique identifier (ID) for the parent root or OU whose children you want to list.

        The regex pattern for a parent ID string requires one of the following:

        • Root - A string that begins with "r-" followed by from 4 to 32 lowercase letters or digits.

        • Organizational unit (OU) - 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.

        Parameters:
        parentId - The unique identifier (ID) for the parent root or OU whose children you want to list.

        The regex pattern for a parent ID string requires one of the following:

        • Root - A string that begins with "r-" followed by from 4 to 32 lowercase letters or digits.

        • Organizational unit (OU) - 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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • childType

        ListChildrenRequest.Builder childType​(String childType)

        Filters the output to include only the specified child type.

        Parameters:
        childType - Filters the output to include only the specified child type.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        ChildType, ChildType

      • childType

        ListChildrenRequest.Builder childType​(ChildType childType)

        Filters the output to include only the specified child type.

        Parameters:
        childType - Filters the output to include only the specified child type.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        ChildType, ChildType

      • nextToken

        ListChildrenRequest.Builder nextToken​(String nextToken)

        The parameter for receiving additional results if you receive a NextToken response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the value of the previous call's NextToken response to indicate where the output should continue from.

        Parameters:
        nextToken - The parameter for receiving additional results if you receive a NextToken response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the value of the previous call's NextToken response to indicate where the output should continue from.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • maxResults

        ListChildrenRequest.Builder maxResults​(Integer maxResults)

        The total number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that Organizations might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

        Parameters:
        maxResults - The total number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that Organizations might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.
        Returns:
        Returns a reference to this object so that method calls can be chained together.