OpenSearchService / Client / delete_vpc_endpoint

delete_vpc_endpoint#

OpenSearchService.Client.delete_vpc_endpoint(**kwargs)#

Deletes an Amazon OpenSearch Service-managed interface VPC endpoint.

Request Syntax

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

Parameters:

VpcEndpointId (string) –

[REQUIRED]

The unique identifier of the endpoint.

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) –
- 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

OpenSearchService.Client.exceptions.ResourceNotFoundException
OpenSearchService.Client.exceptions.DisabledOperationException
OpenSearchService.Client.exceptions.InternalException
OpenSearchService.Client.exceptions.BaseException