Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

ListVpcEndpoints

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

Request Syntax


GET /2021-01-01/opensearch/vpcEndpoints?nextToken=NextToken HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

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.

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "NextToken": "string",
   "VpcEndpointSummaryList": [ 
      { 
         "DomainArn": "string",
         "Status": "string",
         "VpcEndpointId": "string",
         "VpcEndpointOwner": "string"
      }
   ]
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

NextToken

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

Type: String

VpcEndpointSummaryList

Information about each endpoint.

Type: Array of VpcEndpointSummary objects

Errors

For information about the errors that are common to all actions, see Common Errors.

BaseException

An error occurred while processing the request.

HTTP Status Code: 400

DisabledOperationException

An error occured because the client wanted to access an unsupported operation.

HTTP Status Code: 409

InternalException

Request processing failed because of an unknown error, exception, or internal failure.

HTTP Status Code: 500