:doc:`OpenSearchServiceServerless <../../opensearchserverless>` / Client / list_vpc_endpoints

******************
list_vpc_endpoints
******************



.. py:method:: OpenSearchServiceServerless.Client.list_vpc_endpoints(**kwargs)

  

  Returns the OpenSearch Serverless-managed interface VPC endpoints associated with the current account. For more information, see `Access Amazon OpenSearch Serverless using an interface endpoint <https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-vpc.html>`__.

  

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


  **Request Syntax**
  ::

    response = client.list_vpc_endpoints(
        vpcEndpointFilters={
            'status': 'PENDING'|'DELETING'|'ACTIVE'|'FAILED'
        },
        nextToken='string',
        maxResults=123
    )
    
  :type vpcEndpointFilters: dict
  :param vpcEndpointFilters: 

    Filter the results according to the current status of the VPC endpoint. Possible statuses are ``CREATING``, ``DELETING``, ``UPDATING``, ``ACTIVE``, and ``FAILED``.

    

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

      The current status of the endpoint.

      

    
  
  :type nextToken: string
  :param nextToken: 

    If your initial ``ListVpcEndpoints`` operation returns a ``nextToken``, you can include the returned ``nextToken`` in subsequent ``ListVpcEndpoints`` operations, which returns results in the next page.

    

  
  :type maxResults: integer
  :param maxResults: 

    An optional parameter that specifies the maximum number of results to return. You can use ``nextToken`` to get the next page of results. The default is 20.

    

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

    
    ::

      {
          'vpcEndpointSummaries': [
              {
                  'id': 'string',
                  'name': 'string',
                  'status': 'PENDING'|'DELETING'|'ACTIVE'|'FAILED'
              },
          ],
          'nextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **vpcEndpointSummaries** *(list) --* 

        Details about each VPC endpoint, including the name and current status.

        
        

        - *(dict) --* 

          The VPC endpoint object.

          
          

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

            The unique identifier of the endpoint.

            
          

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

            The name of the endpoint.

            
          

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

            The current status of the endpoint.

            
      
    
      

      - **nextToken** *(string) --* 

        When ``nextToken`` is returned, there are more results available. The value of ``nextToken`` is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.

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

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

  