Organizations / Paginator / ListOrganizationalUnitsForParent
ListOrganizationalUnitsForParent#
- class Organizations.Paginator.ListOrganizationalUnitsForParent#
paginator = client.get_paginator('list_organizational_units_for_parent')
- paginate(**kwargs)#
Creates an iterator that will paginate through responses from
Organizations.Client.list_organizational_units_for_parent()
.See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate( ParentId='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } )
- 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.
PaginationConfig (dict) –
A dictionary that provides parameters to control pagination.
MaxItems (integer) –
The total number of items to return. If the total number of items available is more than the value specified in max-items then a
NextToken
will be provided in the output that you can use to resume pagination.PageSize (integer) –
The size of each page.
StartingToken (string) –
A token to specify where to start paginating. This is the
NextToken
from a previous response.
- Return type:
dict
- Returns:
Response Syntax
{ 'OrganizationalUnits': [ { 'Id': 'string', 'Arn': 'string', 'Name': '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 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.