# CreateVpcEndpoint
<a name="API_CreateVpcEndpoint"></a>

Creates an OpenSearch Serverless-managed interface VPC endpoint. For more information, see [Access Amazon OpenSearch Serverless using an interface endpoint](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-vpc.html).

## Request Syntax
<a name="API_CreateVpcEndpoint_RequestSyntax"></a>

```
{
   "clientToken": "string",
   "name": "string",
   "securityGroupIds": [ "string" ],
   "subnetIds": [ "string" ],
   "vpcId": "string"
}
```

## Request Parameters
<a name="API_CreateVpcEndpoint_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [clientToken](#API_CreateVpcEndpoint_RequestSyntax) **   <a name="opensearchserverless-CreateVpcEndpoint-request-clientToken"></a>
Unique, case-sensitive identifier to ensure idempotency of the request.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 512.  
Required: No

 ** [name](#API_CreateVpcEndpoint_RequestSyntax) **   <a name="opensearchserverless-CreateVpcEndpoint-request-name"></a>
The name of the interface endpoint.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 32.  
Pattern: `[a-z][a-z0-9-]+`   
Required: Yes

 ** [securityGroupIds](#API_CreateVpcEndpoint_RequestSyntax) **   <a name="opensearchserverless-CreateVpcEndpoint-request-securityGroupIds"></a>
The unique identifiers of the security groups that define the ports, protocols, and sources for inbound traffic that you are authorizing into your endpoint.  
Type: Array of strings  
Array Members: Minimum number of 1 item. Maximum number of 5 items.  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[\w+\-]+`   
Required: No

 ** [subnetIds](#API_CreateVpcEndpoint_RequestSyntax) **   <a name="opensearchserverless-CreateVpcEndpoint-request-subnetIds"></a>
The ID of one or more subnets from which you'll access OpenSearch Serverless.  
Type: Array of strings  
Array Members: Minimum number of 1 item.  
Length Constraints: Minimum length of 1. Maximum length of 32.  
Pattern: `subnet-([0-9a-f]{8}|[0-9a-f]{17})`   
Required: Yes

 ** [vpcId](#API_CreateVpcEndpoint_RequestSyntax) **   <a name="opensearchserverless-CreateVpcEndpoint-request-vpcId"></a>
The ID of the VPC from which you'll access OpenSearch Serverless.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `vpc-[0-9a-z]*`   
Required: Yes

## Response Syntax
<a name="API_CreateVpcEndpoint_ResponseSyntax"></a>

```
{
   "createVpcEndpointDetail": { 
      "id": "string",
      "name": "string",
      "status": "string"
   }
}
```

## Response Elements
<a name="API_CreateVpcEndpoint_ResponseElements"></a>

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

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

 ** [createVpcEndpointDetail](#API_CreateVpcEndpoint_ResponseSyntax) **   <a name="opensearchserverless-CreateVpcEndpoint-response-createVpcEndpointDetail"></a>
Details about the created interface VPC endpoint.  
Type: [CreateVpcEndpointDetail](API_CreateVpcEndpointDetail.md) object

## Errors
<a name="API_CreateVpcEndpoint_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ConflictException **   
When creating a resource, thrown when a resource with the same name already exists or is being created.  
HTTP Status Code: 400

 ** InternalServerException **   
Thrown when an error internal to the service occurs while processing a request.  
HTTP Status Code: 500

 ** ServiceQuotaExceededException **   
Thrown when you attempt to create more resources than the service allows based on service quotas.  
HTTP Status Code: 400

 ** ValidationException **   
Thrown when the HTTP request contains invalid input or is missing required input.  
HTTP Status Code: 400

## See Also
<a name="API_CreateVpcEndpoint_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/opensearchserverless-2021-11-01/CreateVpcEndpoint) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/opensearchserverless-2021-11-01/CreateVpcEndpoint) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/opensearchserverless-2021-11-01/CreateVpcEndpoint) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/opensearchserverless-2021-11-01/CreateVpcEndpoint) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/opensearchserverless-2021-11-01/CreateVpcEndpoint) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/opensearchserverless-2021-11-01/CreateVpcEndpoint) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/opensearchserverless-2021-11-01/CreateVpcEndpoint) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/opensearchserverless-2021-11-01/CreateVpcEndpoint) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/opensearchserverless-2021-11-01/CreateVpcEndpoint) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/opensearchserverless-2021-11-01/CreateVpcEndpoint)