:doc:`DataZone <../../datazone>` / Paginator / ListAccountPools

****************
ListAccountPools
****************



.. py:class:: DataZone.Paginator.ListAccountPools

  ::

    
    paginator = client.get_paginator('list_account_pools')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`DataZone.Client.list_account_pools`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/datazone-2018-05-10/ListAccountPools>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          domainIdentifier='string',
          name='string',
          sortBy='NAME',
          sortOrder='ASCENDING'|'DESCENDING',
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type domainIdentifier: string
    :param domainIdentifier: **[REQUIRED]** 

      The ID of the domain where exsting account pools are to be listed.

      

    
    :type name: string
    :param name: 

      The name of the account pool to be listed.

      

    
    :type sortBy: string
    :param sortBy: 

      The sort by mechanism in which the existing account pools are to be listed.

      

    
    :type sortOrder: string
    :param sortOrder: 

      The sort order in which the existing account pools are to be listed.

      

    
    :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**

      
      ::

        {
            'items': [
                {
                    'domainId': 'string',
                    'id': 'string',
                    'name': 'string',
                    'resolutionStrategy': 'MANUAL',
                    'domainUnitId': 'string',
                    'createdBy': 'string',
                    'updatedBy': 'string'
                },
            ],
            'NextToken': 'string'
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **items** *(list) --* 

          The results of the ListAccountPools operation.

          
          

          - *(dict) --* 

            The summary of the account pool.

            
            

            - **domainId** *(string) --* 

              The ID of the domain.

              
            

            - **id** *(string) --* 

              The ID of the account pool.

              
            

            - **name** *(string) --* 

              The name of the account pool.

              
            

            - **resolutionStrategy** *(string) --* 

              The mechanism used to resolve the account selection from the account pool.

              
            

            - **domainUnitId** *(string) --* 

              The ID of the domain unit.

              
            

            - **createdBy** *(string) --* 

              The user who created the account pool.

              
            

            - **updatedBy** *(string) --* 

              The user who updated the account pool.

              
        
      
        

        - **NextToken** *(string) --* 

          A token to resume pagination.

          
    