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

Inherits:

Struct

• Object
• Struct
• Aws::Organizations::Types::ListChildrenRequest

Defined in:

gems/aws-sdk-organizations/lib/aws-sdk-organizations/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #child_type ⇒ String

  Filters the output to include only the specified child type.

• #max_results ⇒ Integer

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

• #next_token ⇒ String

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

• #parent_id ⇒ String

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

Instance Attribute Details

#child_type ⇒ String

Filters the output to include only the specified child type.

Returns:

• (String)

# File 'gems/aws-sdk-organizations/lib/aws-sdk-organizations/types.rb', line 2794

class ListChildrenRequest < Struct.new(
  :parent_id,
  :child_type,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#max_results ⇒ Integer

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)

# File 'gems/aws-sdk-organizations/lib/aws-sdk-organizations/types.rb', line 2794

class ListChildrenRequest < Struct.new(
  :parent_id,
  :child_type,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#next_token ⇒ String

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)

# File 'gems/aws-sdk-organizations/lib/aws-sdk-organizations/types.rb', line 2794

class ListChildrenRequest < Struct.new(
  :parent_id,
  :child_type,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#parent_id ⇒ String

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)

# File 'gems/aws-sdk-organizations/lib/aws-sdk-organizations/types.rb', line 2794

class ListChildrenRequest < Struct.new(
  :parent_id,
  :child_type,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end