Skip to content

delete_db_proxy_endpoint

delete_db_proxy_endpoint(
    *,
    config_overrides: Optional[RDSClientConfig] = None,
    db_proxy_endpoint_name: Optional[DBProxyEndpointName] = None,
) -> DeleteDBProxyEndpointResponse

Deletes a DBProxyEndpoint. Doing so removes the ability to access the DB proxy using the endpoint that you defined. The endpoint that you delete might have provided capabilities such as read/write or read-only operations, or using a different VPC than the DB proxy's default VPC.

Parameters:

Raises:

Source code in docs_src/capo_rds/_services/rds.py
def delete_db_proxy_endpoint(
    self,
    *,
    config_overrides: Optional[RDSClientConfig] = None,
    db_proxy_endpoint_name: Optional[
        "capo_rds.types.db_proxy_endpoint_name.DBProxyEndpointName"
    ] = None,
) -> (
    "capo_rds.types.delete_db_proxy_endpoint_response.DeleteDBProxyEndpointResponse"
):
    """<p>Deletes a <code>DBProxyEndpoint</code>. Doing so removes the ability to access the DB proxy using the endpoint that you defined. The endpoint that you delete might have provided capabilities such as read/write or read-only operations, or using a different VPC than the DB proxy's default VPC.</p>

    Args:
        db_proxy_endpoint_name: <p>The name of the DB proxy endpoint to delete.</p>

    Raises:
        capo_rds.errors.db_proxy_endpoint_not_found_fault.DBProxyEndpointNotFoundFault: <p>The DB proxy endpoint doesn't exist.</p>
        capo_rds.errors.invalid_db_proxy_endpoint_state_fault.InvalidDBProxyEndpointStateFault: <p>You can't perform this operation while the DB proxy endpoint is in a particular state.</p>
        capo_rds.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_rds.types.delete_db_proxy_endpoint_request.DeleteDBProxyEndpointRequest]",
    ) -> OperationResponse[
        "capo_rds.types.delete_db_proxy_endpoint_response.DeleteDBProxyEndpointResponse"
    ]:
        import capo_rds._operations.amazon_rd_sv19.delete_db_proxy_endpoint

        output, http_response = (
            capo_rds._operations.amazon_rd_sv19.delete_db_proxy_endpoint.delete_db_proxy_endpoint(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeleteDBProxyEndpoint")
    )
    input_: capo_rds.types.delete_db_proxy_endpoint_request.DeleteDBProxyEndpointRequest = {}
    if db_proxy_endpoint_name is not None:
        input_["db_proxy_endpoint_name"] = db_proxy_endpoint_name

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output