ListChildrenRequest Class | AWS SDK for .NET V3

Container for the parameters to the ListChildren operation. Lists all of the organizational units (OUs) or accounts that are contained in the specified parent OU or root. This operation, along with ListParents enables you to traverse the tree structure that makes up this root.

Always check the NextToken response parameter for a null value when calling a List* operation. These operations can occasionally return an empty set of results even when there are more results available. The NextToken response parameter value is nullonly when there are no more results to display.

This operation can be called only from the organization's management account or by a member account that is a delegated administrator for an Amazon Web Services service.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.Organizations.AmazonOrganizationsRequest
      Amazon.Organizations.Model.ListChildrenRequest

Namespace: Amazon.Organizations.Model
Assembly: AWSSDK.Organizations.dll
Version: 3.x.y.z

Syntax

public class ListChildrenRequest : AmazonOrganizationsRequest
         IAmazonWebServiceRequest

The ListChildrenRequest type exposes the following members

Constructors

	Name	Description
	ListChildrenRequest()

Properties

Name	Type	Description
ChildType	Amazon.Organizations.ChildType	Gets and sets the property ChildType. Filters the output to include only the specified child type.
MaxResults	System.Int32	Gets and sets the property 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.
NextToken	System.String	Gets and sets the property 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.
ParentId	System.String	Gets and sets the property 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.

Examples

The following example shows how to request a list of the child OUs in a parent root or OU:/n/n

To retrieve a list of all of the child accounts and OUs in a parent root or OU


var client = new AmazonOrganizationsClient();
var response = client.ListChildren(new ListChildrenRequest 
{
    ChildType = "ORGANIZATIONAL_UNIT",
    ParentId = "ou-examplerootid111-exampleouid111"
});

List<Child> children = response.Children;

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer, 3.5