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

DeleteVpcEndpoint

Deletes an Amazon OpenSearch Service-managed interface VPC endpoint.

Request Syntax


DELETE /2021-01-01/opensearch/vpcEndpoints/VpcEndpointId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

VpcEndpointId

The unique identifier of the endpoint.

Length Constraints: Minimum length of 5. Maximum length of 256.

Pattern: ^aos-[a-zA-Z0-9]*$

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "VpcEndpointSummary": { 
      "DomainArn": "string",
      "Status": "string",
      "VpcEndpointId": "string",
      "VpcEndpointOwner": "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.

VpcEndpointSummary

Information about the deleted endpoint, including its current status (DELETING or DELETE_FAILED).

Type: VpcEndpointSummary 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

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

ResourceNotFoundException

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

HTTP Status Code: 409