:doc:`SWF <../../swf>` / Client / list_domains

************
list_domains
************



.. py:method:: SWF.Client.list_domains(**kwargs)

  

  Returns the list of domains registered in the account. The results may be split into multiple pages. To retrieve subsequent pages, make the call again using the nextPageToken returned by the initial call.

   

  .. note::

    

    This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.

    

   

  **Access Control**

   

  You can use IAM policies to control this action's access to Amazon SWF resources as follows:

   

  
  * Use a ``Resource`` element with the domain name to limit the action to only specified domains. The element must be set to ``arn:aws:swf::AccountID:domain/*``, where *AccountID* is the account ID, with no dashes.
   
  * Use an ``Action`` element to allow or deny permission to call this action.
   
  * You cannot use an IAM policy to constrain this action's parameters.
  

   

  If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's ``cause`` parameter is set to ``OPERATION_NOT_PERMITTED``. For details and example IAM policies, see `Using IAM to Manage Access to Amazon SWF Workflows <https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html>`__ in the *Amazon SWF Developer Guide*.

  

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


  **Request Syntax**
  ::

    response = client.list_domains(
        nextPageToken='string',
        registrationStatus='REGISTERED'|'DEPRECATED',
        maximumPageSize=123,
        reverseOrder=True|False
    )
    
  :type nextPageToken: string
  :param nextPageToken: 

    If ``NextPageToken`` is returned there are more results available. The value of ``NextPageToken`` is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return a ``400`` error: " ``Specified token has exceeded its maximum lifetime``".

     

    The configured ``maximumPageSize`` determines how many results can be returned in a single call.

    

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

    Specifies the registration status of the domains to list.

    

  
  :type maximumPageSize: integer
  :param maximumPageSize: 

    The maximum number of results that are returned per call. Use ``nextPageToken`` to obtain further pages of results.

    

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

    

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

    
    ::

      {
          'domainInfos': [
              {
                  'name': 'string',
                  'status': 'REGISTERED'|'DEPRECATED',
                  'description': 'string',
                  'arn': 'string'
              },
          ],
          'nextPageToken': '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.

            
      
    
      

      - **nextPageToken** *(string) --* 

        If a ``NextPageToken`` was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in ``nextPageToken``. Keep all other arguments unchanged.

         

        The configured ``maximumPageSize`` determines how many results can be returned in a single call.

        
  
  **Exceptions**
  
  *   :py:class:`SWF.Client.exceptions.OperationNotPermittedFault`

  