:doc:`Organizations <../../organizations>` / Paginator / ListChildren

************
ListChildren
************



.. py:class:: Organizations.Paginator.ListChildren

  ::

    
    paginator = client.get_paginator('list_children')

  
  

  .. py:method:: paginate(**kwargs)

    Creates an iterator that will paginate through responses from :py:meth:`Organizations.Client.list_children`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/organizations-2016-11-28/ListChildren>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          ParentId='string',
          ChildType='ACCOUNT'|'ORGANIZATIONAL_UNIT',
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type ParentId: string
    :param ParentId: **[REQUIRED]** 

      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.
      

      

    
    :type ChildType: string
    :param ChildType: **[REQUIRED]** 

      Filters the output to include only the specified child type.

      

    
    :type PaginationConfig: dict
    :param PaginationConfig: 

      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.

        

      
    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax**

      
      ::

        {
            'Children': [
                {
                    'Id': 'string',
                    'Type': 'ACCOUNT'|'ORGANIZATIONAL_UNIT'
                },
            ],
            
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **Children** *(list) --* 

          The list of children of the specified parent container.

          
          

          - *(dict) --* 

            Contains a list of child entities, either OUs or accounts.

            
            

            - **Id** *(string) --* 

              The unique identifier (ID) of this child entity.

               

              The `regex pattern <http://wikipedia.org/wiki/regex>`__ for a child ID string requires one of the following:

               

              
              * **Account** - A string that consists of exactly 12 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 contains the OU). This string is followed by a second "-" dash and from 8 to 32 additional lowercase letters or digits.
              

              
            

            - **Type** *(string) --* 

              The type of this child entity.

              
        
      
    