:doc:`ElasticsearchService <../../es>` / Client / list_domain_names

*****************
list_domain_names
*****************



.. py:method:: ElasticsearchService.Client.list_domain_names(**kwargs)

  

  Returns the name of all Elasticsearch domains owned by the current user's account.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/es-2015-01-01/ListDomainNames>`_  


  **Request Syntax**
  ::

    response = client.list_domain_names(
        EngineType='OpenSearch'|'Elasticsearch'
    )
    
  :type EngineType: string
  :param EngineType: 

    Optional parameter to filter the output by domain engine type. Acceptable values are 'Elasticsearch' and 'OpenSearch'.

    

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

    
    ::

      {
          'DomainNames': [
              {
                  'DomainName': 'string',
                  'EngineType': 'OpenSearch'|'Elasticsearch'
              },
          ]
      }
      
    **Response Structure**

    

    - *(dict) --* 

      The result of a ``ListDomainNames`` operation. Contains the names of all domains owned by this account and their respective engine types.

      
      

      - **DomainNames** *(list) --* 

        List of domain names and respective engine types.

        
        

        - *(dict) --* 
          

          - **DomainName** *(string) --* 

            Specifies the ``DomainName``.

            
          

          - **EngineType** *(string) --* 

            Specifies the ``EngineType`` of the domain.

            
      
    
  
  **Exceptions**
  
  *   :py:class:`ElasticsearchService.Client.exceptions.BaseException`

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

  