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

(Optional) Use this to limit the number of results you want included in 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)

    (Optional) Use this to limit the number of results you want included in the response.

#next_tokenString

Use this parameter if you receive a NextToken response in a previous request that indicates that there is more output available. Set it to the value of the previous call\'s NextToken response to indicate where the output should continue from.

Returns:

  • (String)

    Use this parameter if you receive a NextToken response in a previous request that indicates that there is more output available.

#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 lower-case letters or digits.

  • Organizational unit (OU): a string that begins with \"ou-\" followed by from 4 to 32 lower-case letters or digits (the ID of the root that the OU is in) followed by a second \"-\" dash and from 8 to 32 additional lower-case letters or digits.

Returns:

  • (String)

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