:doc:`DataZone <../../datazone>` / Client / list_account_pools

******************
list_account_pools
******************



.. py:method:: DataZone.Client.list_account_pools(**kwargs)

  

  Lists existing account pools.

  

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


  **Request Syntax**
  ::

    response = client.list_account_pools(
        domainIdentifier='string',
        name='string',
        sortBy='NAME',
        sortOrder='ASCENDING'|'DESCENDING',
        nextToken='string',
        maxResults=123
    )
    
  :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 nextToken: string
  :param nextToken: 

    When the number of account pools is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of account pools, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListAccountPools to list the next set of account pools.

    

  
  :type maxResults: integer
  :param maxResults: 

    The maximum number of account pools to return in a single call to ListAccountPools. When the number of account pools to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to ListAccountPools to list the next set of account pools.

    

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

        When the number of account pools is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of account pools, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListAccountPools to list the next set of account pools.

        
  
  **Exceptions**
  
  *   :py:class:`DataZone.Client.exceptions.InternalServerException`

  
  *   :py:class:`DataZone.Client.exceptions.AccessDeniedException`

  
  *   :py:class:`DataZone.Client.exceptions.ThrottlingException`

  
  *   :py:class:`DataZone.Client.exceptions.ValidationException`

  
  *   :py:class:`DataZone.Client.exceptions.UnauthorizedException`

  