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

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



.. py:class:: DataZone.Paginator.ListDomains

  ::

    
    paginator = client.get_paginator('list_domains')

  
  

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

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

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


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          status='CREATING'|'AVAILABLE'|'CREATION_FAILED'|'DELETING'|'DELETED'|'DELETION_FAILED',
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type status: string
    :param status: 

      The status of the data source.

      

    
    :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': [
                {
                    'id': 'string',
                    'name': 'string',
                    'description': 'string',
                    'arn': 'string',
                    'managedAccountId': 'string',
                    'status': 'CREATING'|'AVAILABLE'|'CREATION_FAILED'|'DELETING'|'DELETED'|'DELETION_FAILED',
                    'portalUrl': 'string',
                    'createdAt': datetime(2015, 1, 1),
                    'lastUpdatedAt': datetime(2015, 1, 1),
                    'domainVersion': 'V1'|'V2'
                },
            ],
            'NextToken': 'string'
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

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

          The results of the ``ListDomains`` action.

          
          

          - *(dict) --* 

            A summary of a Amazon DataZone domain.

            
            

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

              The ID of the Amazon DataZone domain.

              
            

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

              A name of an Amazon DataZone domain.

              
            

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

              A description of an Amazon DataZone domain.

              
            

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

              The ARN of the Amazon DataZone domain.

              
            

            - **managedAccountId** *(string) --* 

              The identifier of the Amazon Web Services account that manages the domain.

              
            

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

              The status of the Amazon DataZone domain.

              
            

            - **portalUrl** *(string) --* 

              The data portal URL for the Amazon DataZone domain.

              
            

            - **createdAt** *(datetime) --* 

              A timestamp of when a Amazon DataZone domain was created.

              
            

            - **lastUpdatedAt** *(datetime) --* 

              A timestamp of when a Amazon DataZone domain was last updated.

              
            

            - **domainVersion** *(string) --* 

              The domain version.

              
        
      
        

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

          A token to resume pagination.

          
    