OpenSearchServiceServerless / Client / delete_vpc_endpoint

delete_vpc_endpoint

OpenSearchServiceServerless.Client.delete_vpc_endpoint(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.delete_vpc_endpoint(
    clientToken='string',
    id='string'
)

Parameters:

• clientToken (string) –

  Unique, case-sensitive identifier to ensure idempotency of the request.

  This field is autopopulated if not provided.

• id (string) –

  [REQUIRED]

  The VPC endpoint identifier.

Return type:

dict

Returns:

Response Syntax

{
    'deleteVpcEndpointDetail': {
        'id': 'string',
        'name': 'string',
        'status': 'PENDING'|'DELETING'|'ACTIVE'|'FAILED'
    }
}

Response Structure

• (dict) –

  • deleteVpcEndpointDetail (dict) –

    Details about the deleted endpoint.

    • id (string) –

      The unique identifier of the endpoint.

    • name (string) –

      The name of the endpoint.

    • status (string) –

      The current status of the endpoint deletion process.

Exceptions

• OpenSearchServiceServerless.Client.exceptions.InternalServerException

• OpenSearchServiceServerless.Client.exceptions.ResourceNotFoundException

• OpenSearchServiceServerless.Client.exceptions.ConflictException

• OpenSearchServiceServerless.Client.exceptions.ValidationException