:doc:`SWF <../../swf>` / Paginator / ListDomains

***********
ListDomains
***********



.. py:class:: SWF.Paginator.ListDomains

  ::

    
    paginator = client.get_paginator('list_domains')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`SWF.Client.list_domains`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/swf-2012-01-25/ListDomains>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          registrationStatus='REGISTERED'|'DEPRECATED',
          reverseOrder=True|False,
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type registrationStatus: string
    :param registrationStatus: **[REQUIRED]** 

      Specifies the registration status of the domains to list.

      

    
    :type reverseOrder: boolean
    :param reverseOrder: 

      When set to ``true``, returns the results in reverse order. By default, the results are returned in ascending alphabetical order by ``name`` of the domains.

      

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

      
      ::

        {
            'domainInfos': [
                {
                    'name': 'string',
                    'status': 'REGISTERED'|'DEPRECATED',
                    'description': 'string',
                    'arn': 'string'
                },
            ],
            'NextToken': 'string'
        }
        
      **Response Structure**

      

      - *(dict) --* 

        Contains a paginated collection of DomainInfo structures.

        
        

        - **domainInfos** *(list) --* 

          A list of DomainInfo structures.

          
          

          - *(dict) --* 

            Contains general information about a domain.

            
            

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

              The name of the domain. This name is unique within the account.

              
            

            - **status** *(string) --* 

              The status of the domain:

               

              
              * ``REGISTERED`` – The domain is properly registered and available. You can use this domain for registering types and creating new workflow executions.
               
              * ``DEPRECATED`` – The domain was deprecated using  DeprecateDomain, but is still in use. You should not create new workflow executions in this domain.
              

              
            

            - **description** *(string) --* 

              The description of the domain provided through  RegisterDomain.

              
            

            - **arn** *(string) --* 

              The ARN of the domain.

              
        
      
        

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

          A token to resume pagination.

          
    