AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::Organizations::Types::ListChildrenRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing ListChildrenRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  parent_id: "ParentId", # required
  child_type: "ACCOUNT", # required, accepts ACCOUNT, ORGANIZATIONAL_UNIT
  next_token: "NextToken",
  max_results: 1,
}

Instance Attribute Summary collapse

Instance Attribute Details

#child_typeString

Filters the output to include only the specified child type.

Possible values:

  • ACCOUNT
  • ORGANIZATIONAL_UNIT

Returns:

  • (String)

    Filters the output to include only the specified child type.

#max_resultsInteger

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:

  • (Integer)

    The total number of results that you want included on each page of the response.

#next_tokenString

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:

  • (String)

    The parameter for receiving additional results if you receive a NextToken response in a previous request.

#parent_idString

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:

  • (String)

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