Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

CreateVpcEndpoint

Creates an OpenSearch Serverless-managed interface VPC endpoint. For more information, see Access Amazon OpenSearch Serverless using an interface endpoint.

Request Syntax


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

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

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 512.

Required: No

name

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

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

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. Maximum number of 6 items.

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

Pattern: ^subnet-([0-9a-f]{8}|[0-9a-f]{17})$

Required: Yes

vpcId

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


{
   "createVpcEndpointDetail": { 
      "id": "string",
      "name": "string",
      "status": "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.

createVpcEndpointDetail

Details about the created interface VPC endpoint.

Type: CreateVpcEndpointDetail object

Errors

For information about the errors that are common to all actions, see Common Errors.

ConflictException

When creating a resource, thrown when a resource with the same name already exists or is being created. When deleting a resource, thrown when the resource is not in the ACTIVE or FAILED state.

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