Retrieves all Amazon OpenSearch Service-managed VPC endpoints in the current Amazon Web Services account and Region.

See also: AWS API Documentation

Request Syntax

response = client.list_vpc_endpoints(
NextToken (string) -- 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.
Return type
Response Syntax
    'VpcEndpointSummaryList': [
            'VpcEndpointId': 'string',
            'VpcEndpointOwner': 'string',
            'DomainArn': 'string',
    'NextToken': 'string'

Response Structure

  • (dict) --
    • VpcEndpointSummaryList (list) --

      Information about each endpoint.

      • (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) --

      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.


  • OpenSearchService.Client.exceptions.InternalException
  • OpenSearchService.Client.exceptions.DisabledOperationException
  • OpenSearchService.Client.exceptions.BaseException