GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages
Paws::Organizations::ListChildren(3) User Contributed Perl Documentation Paws::Organizations::ListChildren(3)

Paws::Organizations::ListChildren - Arguments for method ListChildren on Paws::Organizations

This class represents the parameters used for calling the method ListChildren on the AWS Organizations service. Use the attributes of this class as arguments to method ListChildren.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ListChildren.

    my $organizations = Paws->service('Organizations');
# To retrieve a list of all of the child accounts and OUs in a parent root or OU
# The following example shows how to request a list of the child OUs in a parent
# root or OU:/n/n
    my $ListChildrenResponse = $organizations->ListChildren(
      'ChildType' => 'ORGANIZATIONAL_UNIT',
      'ParentId'  => 'ou-examplerootid111-exampleouid111'
    );
    # Results:
    my $Children = $ListChildrenResponse->Children;
    # Returns a L<Paws::Organizations::ListChildrenResponse> object.

Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see <https://docs.aws.amazon.com/goto/WebAPI/organizations/ListChildren>

REQUIRED ChildType => Str

Filters the output to include only the specified child type.

Valid values are: "ACCOUNT", "ORGANIZATIONAL_UNIT"

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.

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.

REQUIRED ParentId => Str

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

The regex pattern (http://wikipedia.org/wiki/regex) 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.

This class forms part of Paws, documenting arguments for method ListChildren in Paws::Organizations

The source code is located here: <https://github.com/pplu/aws-sdk-perl>

Please report bugs to: <https://github.com/pplu/aws-sdk-perl/issues>

2022-06-01 perl v5.40.2

Search for    or go to Top of page |  Section 3 |  Main Index

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with ManDoc.