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

Class: Aws::Organizations::Types::ListAccountsForParentRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-organizations/lib/aws-sdk-organizations/types.rb

Overview

Note:

When making an API call, you may pass ListAccountsForParentRequest data as a hash:

{
  parent_id: "ParentId", # required
  next_token: "NextToken",
  max_results: 1,
}

Instance Attribute Summary collapse

Instance Attribute Details

#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)


1356
1357
1358
1359
1360
1361
# File 'gems/aws-sdk-organizations/lib/aws-sdk-organizations/types.rb', line 1356

class ListAccountsForParentRequest < Struct.new(
  :parent_id,
  :next_token,
  :max_results)
  include Aws::Structure
end

#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)


1356
1357
1358
1359
1360
1361
# File 'gems/aws-sdk-organizations/lib/aws-sdk-organizations/types.rb', line 1356

class ListAccountsForParentRequest < Struct.new(
  :parent_id,
  :next_token,
  :max_results)
  include Aws::Structure
end

#parent_idString

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

Returns:

  • (String)


1356
1357
1358
1359
1360
1361
# File 'gems/aws-sdk-organizations/lib/aws-sdk-organizations/types.rb', line 1356

class ListAccountsForParentRequest < Struct.new(
  :parent_id,
  :next_token,
  :max_results)
  include Aws::Structure
end