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

*****************************
list_vpc_endpoints_for_domain
*****************************



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

  

  Retrieves all Amazon OpenSearch Service-managed VPC endpoints associated with a particular domain.

  

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


  **Request Syntax**
  ::

    response = client.list_vpc_endpoints_for_domain(
        DomainName='string',
        NextToken='string'
    )
    
  :type DomainName: string
  :param DomainName: **[REQUIRED]** 

    Name of the ElasticSearch domain whose VPC endpoints are to be listed.

    

  
  :type NextToken: string
  :param NextToken: 

    Provides an identifier to allow retrieval of paginated results.

    

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

    
    ::

      {
          'VpcEndpointSummaryList': [
              {
                  'VpcEndpointId': 'string',
                  'VpcEndpointOwner': 'string',
                  'DomainArn': 'string',
                  'Status': 'CREATING'|'CREATE_FAILED'|'ACTIVE'|'UPDATING'|'UPDATE_FAILED'|'DELETING'|'DELETE_FAILED'
              },
          ],
          'NextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 

      Container for response parameters to the ``ListVpcEndpointsForDomain`` operation. Returns a list containing summarized details of the VPC endpoints.

      
      

      - **VpcEndpointSummaryList** *(list) --* 

        Provides list of ``VpcEndpointSummary`` summarizing details of the VPC endpoints.

        
        

        - *(dict) --* 

          Summary information for an Amazon OpenSearch Service-managed VPC endpoint.

          
          

          - **VpcEndpointId** *(string) --* 

            The unique identifier of the endpoint.

            
          

          - **VpcEndpointOwner** *(string) --* 

            The creator of the endpoint.

            
          

          - **DomainArn** *(string) --* 

            The Amazon Resource Name (ARN) of the domain associated with the endpoint.

            
          

          - **Status** *(string) --* 

            The current status of the endpoint.

            
      
    
      

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

        Information about each endpoint associated with the domain.

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

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

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

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

  