:doc:`OpenSearchService <../../opensearch>` / Client / list_domain_names

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



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

  

  Returns the names of all Amazon OpenSearch Service domains owned by the current user in the active Region.

  

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


  **Request Syntax**
  ::

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

    Filters the output by domain engine type.

    

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

    
    ::

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

    

    - *(dict) --* 

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

      
      

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

        The names of all OpenSearch Service domains owned by the current user and their respective engine types.

        
        

        - *(dict) --* 

          Information about an OpenSearch Service domain.

          
          

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

            Name of the domain.

            
          

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

            The type of search engine that the domain is running. ``OpenSearch`` for an OpenSearch engine, or ``Elasticsearch`` for a legacy Elasticsearch OSS engine.

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

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

  