Organizations / Client / list_organizational_units_for_parent

list_organizational_units_for_parent#

Organizations.Client.list_organizational_units_for_parent(**kwargs)#

Lists the organizational units (OUs) in a parent organizational unit or root.

Note

Always check the NextToken response parameter for a null value when calling a List* operation. These operations can occasionally return an empty set of results even when there are more results available. The NextToken response parameter value is null only when there are no more results to display.

This operation can be called only from the organization’s management account or by a member account that is a delegated administrator for an Amazon Web Services service.

See also: AWS API Documentation

Request Syntax

response = client.list_organizational_units_for_parent(
    ParentId='string',
    NextToken='string',
    MaxResults=123
)
Parameters:

  • ParentId (string) –

    [REQUIRED]

    The unique identifier (ID) of the root or OU whose child OUs 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.

  • NextToken (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.

  • MaxResults (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.

Return type:

dict

Returns:

Response Syntax

{
    'OrganizationalUnits': [
        {
            'Id': 'string',
            'Arn': 'string',
            'Name': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • OrganizationalUnits (list) –

      A list of the OUs in the specified root or parent OU.

      • (dict) –

        Contains details about an organizational unit (OU). An OU is a container of Amazon Web Services accounts within a root of an organization. Policies that are attached to an OU apply to all accounts contained in that OU and in any child OUs.

        • Id (string) –

          The unique identifier (ID) associated with this OU. The ID is unique to the organization only.

          The regex pattern for an organizational unit ID string requires “ou-” followed by from 4 to 32 lowercase letters or digits (the ID of the root that contains the OU). This string is followed by a second “-” dash and from 8 to 32 additional lowercase letters or digits.

        • Arn (string) –

          The Amazon Resource Name (ARN) of this OU.

          For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the Amazon Web Services Service Authorization Reference.

        • Name (string) –

          The friendly name of this OU.

          The regex pattern that is used to validate this parameter is a string of any of the characters in the ASCII character range.

    • NextToken (string) –

      If present, indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null.

Exceptions

  • Organizations.Client.exceptions.AccessDeniedException

  • Organizations.Client.exceptions.AWSOrganizationsNotInUseException

  • Organizations.Client.exceptions.InvalidInputException

  • Organizations.Client.exceptions.ParentNotFoundException

  • Organizations.Client.exceptions.ServiceException

  • Organizations.Client.exceptions.TooManyRequestsException

Examples

The following example shows how to get a list of OUs in a specified root:/n/n

response = client.list_organizational_units_for_parent(
    ParentId='r-examplerootid111',
)

print(response)

Expected Output:

{
    'OrganizationalUnits': [
        {
            'Arn': 'arn:aws:organizations::111111111111:ou/o-exampleorgid/ou-examlerootid111-exampleouid111',
            'Id': 'ou-examplerootid111-exampleouid111',
            'Name': 'Development',
        },
        {
            'Arn': 'arn:aws:organizations::111111111111:ou/o-exampleorgid/ou-examlerootid111-exampleouid222',
            'Id': 'ou-examplerootid111-exampleouid222',
            'Name': 'Production',
        },
    ],
    'ResponseMetadata': {
        '...': '...',
    },
}