Skip to content

delete_proxy

delete_proxy(
    nat_gateway_id: NatGatewayId,
    *,
    config_overrides: Optional[NetworkFirewallClientConfig] = None,
    proxy_name: Optional[ResourceName] = None,
    proxy_arn: Optional[ResourceArn] = None,
) -> DeleteProxyResponse

Deletes the specified Proxy.

Detaches a Proxy configuration from a NAT Gateway.

Parameters:

  • nat_gateway_id (NatGatewayId) –

    The NAT Gateway the proxy is attached to.

  • proxy_name (Optional[ResourceName], default: None ) –

    The descriptive name of the proxy. You can't change the name of a proxy after you create it.

    You must specify the ARN or the name, and you can specify both.

  • proxy_arn (Optional[ResourceArn], default: None ) –

    The Amazon Resource Name (ARN) of a proxy.

    You must specify the ARN or the name, and you can specify both.

Raises:

  • InternalServerError –

    Your request is valid, but Network Firewall couldn't perform the operation because of a system problem. Retry your request.

  • InvalidRequestException –

    The operation failed because of a problem with your request. Examples include:

    • You specified an unsupported parameter name or value.

    • You tried to update a property with a value that isn't among the available types.

    • Your request references an ARN that is malformed, or corresponds to a resource that isn't valid in the context of the request.

  • ResourceNotFoundException –

    Unable to locate a resource using the parameters that you provided.

  • ThrottlingException –

    Unable to process the request due to throttling limitations.

  • UnsupportedOperationException –

    The operation you requested isn't supported by Network Firewall.

  • UnknownServiceError –

    The service returned an error code this client does not model.

Source code in docs_src/capo_network_firewall/_services/network_firewall.py
def delete_proxy(
    self,
    nat_gateway_id: "capo_network_firewall.types.nat_gateway_id.NatGatewayId",
    *,
    config_overrides: Optional[NetworkFirewallClientConfig] = None,
    proxy_name: Optional[
        "capo_network_firewall.types.resource_name.ResourceName"
    ] = None,
    proxy_arn: Optional[
        "capo_network_firewall.types.resource_arn.ResourceArn"
    ] = None,
) -> "capo_network_firewall.types.delete_proxy_response.DeleteProxyResponse":
    """<p>Deletes the specified <a>Proxy</a>. </p> <p>Detaches a Proxy configuration from a NAT Gateway. </p>

    Args:
        nat_gateway_id: <p>The NAT Gateway the proxy is attached to. </p>
        proxy_name: <p>The descriptive name of the proxy. You can't change the name of a proxy after you create it.</p> <p>You must specify the ARN or the name, and you can specify both. </p>
        proxy_arn: <p>The Amazon Resource Name (ARN) of a proxy.</p> <p>You must specify the ARN or the name, and you can specify both. </p>

    Raises:
        capo_network_firewall.errors.internal_server_error.InternalServerError: <p>Your request is valid, but Network Firewall couldn't perform the operation because of a system problem. Retry your request. </p>
        capo_network_firewall.errors.invalid_request_exception.InvalidRequestException: <p>The operation failed because of a problem with your request. Examples include: </p> <ul> <li> <p>You specified an unsupported parameter name or value.</p> </li> <li> <p>You tried to update a property with a value that isn't among the available types.</p> </li> <li> <p>Your request references an ARN that is malformed, or corresponds to a resource that isn't valid in the context of the request.</p> </li> </ul>
        capo_network_firewall.errors.resource_not_found_exception.ResourceNotFoundException: <p>Unable to locate a resource using the parameters that you provided.</p>
        capo_network_firewall.errors.throttling_exception.ThrottlingException: <p>Unable to process the request due to throttling limitations.</p>
        capo_network_firewall.errors.unsupported_operation_exception.UnsupportedOperationException: <p>The operation you requested isn't supported by Network Firewall. </p>
        capo_network_firewall.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_network_firewall.types.delete_proxy_request.DeleteProxyRequest]",
    ) -> OperationResponse[
        "capo_network_firewall.types.delete_proxy_response.DeleteProxyResponse"
    ]:
        import capo_network_firewall._operations.network_firewall_20201112.delete_proxy

        output, http_response = (
            capo_network_firewall._operations.network_firewall_20201112.delete_proxy.delete_proxy(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeleteProxy")
    )
    input_: capo_network_firewall.types.delete_proxy_request.DeleteProxyRequest = {
        "nat_gateway_id": nat_gateway_id
    }
    if proxy_name is not None:
        input_["proxy_name"] = proxy_name
    if proxy_arn is not None:
        input_["proxy_arn"] = proxy_arn

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