/2015-01-01/es/vpcEndpoints - Amazon Elasticsearch Service

Creates an Amazon OpenSearch Service-managed VPC endpoint.

curl --location -g --request POST 'http://es.{region}.amazonaws.com/2015-01-01/es/vpcEndpoints' \ --header 'Content-Type: application/json' \ --data-raw '{ "DomainArn": "string", "VpcOptions": { "SubnetIds": [], "SecurityGroupIds": [] }, "ClientToken": "string" }'

{ "VpcEndpoint": { "VpcEndpointId": "string", "VpcEndpointOwner": "string", "DomainArn": "string", "VpcOptions": { "VPCId": "string", "SubnetIds": [], "AvailabilityZones": [], "SecurityGroupIds": [] }, "Status": {}, "Endpoint": "string" } }

Request

Body Params application/json

DomainArn

string

required

The Amazon Resource Name (ARN) of the domain to grant access to.

>= 1 characters<= 512 characters

Match pattern:

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

VpcOptions

object

required

Options to specify the subnets and security groups for VPC endpoint. For more information, see VPC Endpoints for Amazon Elasticsearch Service Domains.

SubnetIds

array[string]

optional

Specifies the subnets for VPC endpoint.

SecurityGroupIds

array[string]

optional

Specifies the security groups for VPC endpoint.

ClientToken

string

optional

Unique, case-sensitive identifier to ensure idempotency of the request.

>= 1 characters<= 64 characters

Examples

Responses

🟢200Success

application/json

Body

Container for response parameters to the <code><a>CreateVpcEndpoint</a></code> operation. Contains the configuration and status of the VPC Endpoint being created.

VpcEndpoint

object

required

Information about the newly created VPC 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.

Match pattern:

^[0-9]+$

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\-]+

VpcOptions

object

optional

Options to specify the subnets and security groups for an Amazon OpenSearch Service VPC endpoint.

Status

object

optional

The current status of the endpoint.

Endpoint

string

optional

The connection endpoint ID for connecting to the domain.

Match pattern:

^[A-Za-z0-9\-\.]+$

🟠480ConflictException

🟠481ValidationException

🟠482LimitExceededException

🟠483InternalException

🟠484DisabledOperationException

🟠485BaseException