/2015-01-01/es/vpcEndpoints

The Amazon Elasticsearch Service multi-region endpoint

GET

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

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request GET 'http://es.{region}.amazonaws.com/2015-01-01/es/vpcEndpoints'

Response Example

200 - Example 1

{
  "VpcEndpointSummaryList": [],
  "NextToken": "string"
}

Request

Query Params

nextToken

string

optional

Identifier to allow retrieval of paginated results.

Responses

🟢200Success

application/json

Body

Container for response parameters to the <code><a>ListVpcEndpoints</a></code> operation. Returns a list containing summarized details of the VPC endpoints.

VpcEndpointSummaryList

array[object (VpcEndpointSummary) {4}]

required

Information about each endpoint.

VpcEndpointId

string

optional

The unique identifier of the endpoint.

>= 5 characters<= 256 characters

Match pattern:

^aos-[a-zA-Z0-9]*$

VpcEndpointOwner

string

optional

The creator of the endpoint.

DomainArn

string

optional

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

>= 1 characters<= 512 characters

Match pattern:

arn:aws[a-z\-]*:[a-z]+:[a-z0-9\-]+:[0-9]+:domain\/[a-z0-9\-]+

Status

object

optional

The current status of the endpoint.

NextToken

string

required

Provides an identifier to allow retrieval of paginated results.

🟠480InternalException

🟠481DisabledOperationException

🟠482BaseException

Modified at 2023-08-15 04:15:52

/2015-01-01/es/vpcEndpoints

/2015-01-01/es/domain/{DomainName}