:doc:`WorkMail <../../workmail>` / Paginator / ListOrganizations

*****************
ListOrganizations
*****************



.. py:class:: WorkMail.Paginator.ListOrganizations

  ::

    
    paginator = client.get_paginator('list_organizations')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`WorkMail.Client.list_organizations`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/ListOrganizations>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :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**

      
      ::

        {
            'OrganizationSummaries': [
                {
                    'OrganizationId': 'string',
                    'Alias': 'string',
                    'DefaultMailDomain': 'string',
                    'ErrorMessage': 'string',
                    'State': 'string'
                },
            ],
            
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **OrganizationSummaries** *(list) --* 

          The overview of owned organizations presented as a list of organization summaries.

          
          

          - *(dict) --* 

            The representation of an organization.

            
            

            - **OrganizationId** *(string) --* 

              The identifier associated with the organization.

              
            

            - **Alias** *(string) --* 

              The alias associated with the organization.

              
            

            - **DefaultMailDomain** *(string) --* 

              The default email domain associated with the organization.

              
            

            - **ErrorMessage** *(string) --* 

              The error message associated with the organization. It is only present if unexpected behavior has occurred with regards to the organization. It provides insight or solutions regarding unexpected behavior.

              
            

            - **State** *(string) --* 

              The state associated with the organization.

              
        
      
    