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

CreateVpcEndpoint

Creates an Amazon OpenSearch Service-managed VPC endpoint.

Request Syntax


POST /2021-01-01/opensearch/vpcEndpoints HTTP/1.1
Content-type: application/json

{
   "ClientToken": "string",
   "DomainArn": "string",
   "VpcOptions": { 
      "SecurityGroupIds": [ "string" ],
      "SubnetIds": [ "string" ]
   }
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

ClientToken

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Required: No

DomainArn

The Amazon Resource Name (ARN) of the domain to create the endpoint for.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 512.

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

Required: Yes

VpcOptions

Options to specify the subnets and security groups for the endpoint.

Type: VPCOptions object

Required: Yes

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "VpcEndpoint": { 
      "DomainArn": "string",
      "Endpoint": "string",
      "Status": "string",
      "VpcEndpointId": "string",
      "VpcEndpointOwner": "string",
      "VpcOptions": { 
         "AvailabilityZones": [ "string" ],
         "SecurityGroupIds": [ "string" ],
         "SubnetIds": [ "string" ],
         "VPCId": "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.

VpcEndpoint

Information about the newly created VPC endpoint.

Type: VpcEndpoint object

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

ConflictException

An error occurred because the client attempts to remove a resource that is currently in use.

HTTP Status Code: 409

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

LimitExceededException

An exception for trying to create more than the allowed number of resources or sub-resources.

HTTP Status Code: 409

ValidationException

An exception for accessing or deleting a resource that doesn't exist.

HTTP Status Code: 400