delete_vpc_endpoint

delete_vpc_endpoint(**kwargs)

Deletes an Amazon OpenSearch Service-managed interface VPC endpoint.

See also: AWS API Documentation

Request Syntax

response = client.delete_vpc_endpoint(
    VpcEndpointId='string'
)
Parameters
VpcEndpointId (string) --

[REQUIRED]

The unique identifier of the endpoint to be deleted.

Return type
dict
Returns
Response Syntax
{
    'VpcEndpointSummary': {
        'VpcEndpointId': 'string',
        'VpcEndpointOwner': 'string',
        'DomainArn': 'string',
        'Status': 'CREATING'|'CREATE_FAILED'|'ACTIVE'|'UPDATING'|'UPDATE_FAILED'|'DELETING'|'DELETE_FAILED'
    }
}

Response Structure

  • (dict) --

    Container for response parameters to the DeleteVpcEndpoint operation. Contains the summarized detail of the VPC Endpoint being deleted.

    • VpcEndpointSummary (dict) --

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

      • VpcEndpointId (string) --

        The unique identifier of the endpoint.

      • VpcEndpointOwner (string) --

        The creator of the endpoint.

      • DomainArn (string) --

        The Amazon Resource Name (ARN) of the domain associated with the endpoint.

      • Status (string) --

        The current status of the endpoint.

Exceptions

  • ElasticsearchService.Client.exceptions.ResourceNotFoundException
  • ElasticsearchService.Client.exceptions.DisabledOperationException
  • ElasticsearchService.Client.exceptions.InternalException
  • ElasticsearchService.Client.exceptions.BaseException