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

The Amazon Elasticsearch Service multi-region endpoint

http://es.{region}.amazonaws.com

GET

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

Request Example

Shell

JavaScript

Java

Swift

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

Response Example

200 - Example 1

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

Request

Path Params

DomainName

string

required

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

Query Params

nextToken

string

optional

Provides an identifier to allow retrieval of paginated results.

Responses

🟢200Success

application/json

Body

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

VpcEndpointSummaryList

array[object (VpcEndpointSummary) {4}]

required

Provides list of VpcEndpointSummary summarizing details of the VPC endpoints.

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

Information about each endpoint associated with the domain.

🟠480InternalException

🟠481DisabledOperationException

🟠482ResourceNotFoundException

🟠483BaseException

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

/2015-01-01/es/purchaseReservedInstanceOffering