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

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



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

  

  Lists Amazon DataZone domains.

  

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


  **Request Syntax**
  ::

    response = client.list_domains(
        status='CREATING'|'AVAILABLE'|'CREATION_FAILED'|'DELETING'|'DELETED'|'DELETION_FAILED',
        maxResults=123,
        nextToken='string'
    )
    
  :type status: string
  :param status: 

    The status of the data source.

    

  
  :type maxResults: integer
  :param maxResults: 

    The maximum number of domains to return in a single call to ``ListDomains``. When the number of domains 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 ``ListDomains`` to list the next set of domains.

    

  
  :type nextToken: string
  :param nextToken: 

    When the number of domains 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 domains, the response includes a pagination token named ``NextToken``. You can specify this ``NextToken`` value in a subsequent call to ``ListDomains`` to list the next set of domains.

    

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

        When the number of domains 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 domains, the response includes a pagination token named ``NextToken``. You can specify this ``NextToken`` value in a subsequent call to ``ListDomains`` to list the next set of domains.

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

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

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

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

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

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

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

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

  