update_proxy ¶

def update_proxy(
    self,
    nat_gateway_id: "capo_network_firewall.types.nat_gateway_id.NatGatewayId",
    update_token: "capo_network_firewall.types.update_token.UpdateToken",
    *,
    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,
    listener_properties_to_add: Optional[
        "capo_network_firewall.types.listener_properties_request.ListenerPropertiesRequest"
    ] = None,
    listener_properties_to_remove: Optional[
        "capo_network_firewall.types.listener_properties_request.ListenerPropertiesRequest"
    ] = None,
    tls_intercept_properties: Optional[
        "capo_network_firewall.types.tls_intercept_properties_request.TlsInterceptPropertiesRequest"
    ] = None,
) -> "capo_network_firewall.types.update_proxy_response.UpdateProxyResponse":
    """<p>Updates the properties of the specified proxy.</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>
        listener_properties_to_add: <p>Listener properties for HTTP and HTTPS traffic to add. </p>
        listener_properties_to_remove: <p>Listener properties for HTTP and HTTPS traffic to remove. </p>
        tls_intercept_properties: <p>TLS decryption on traffic to filter on attributes in the HTTP header. </p>
        update_token: <p>A token used for optimistic locking. Network Firewall returns a token to your requests that access the proxy. The token marks the state of the proxy resource at the time of the request. </p> <p>To make changes to the proxy, you provide the token in your request. Network Firewall uses the token to ensure that the proxy hasn't changed since you last retrieved it. If it has changed, the operation fails with an <code>InvalidTokenException</code>. If this happens, retrieve the proxy again to get a current copy of it with a current token. Reapply your changes as needed, then try the operation again using the new token. </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.update_proxy_request.UpdateProxyRequest]",
    ) -> OperationResponse[
        "capo_network_firewall.types.update_proxy_response.UpdateProxyResponse"
    ]:
        import capo_network_firewall._operations.network_firewall_20201112.update_proxy

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdateProxy")
    )
    input_: capo_network_firewall.types.update_proxy_request.UpdateProxyRequest = {
        "nat_gateway_id": nat_gateway_id,
        "update_token": update_token,
    }
    if proxy_name is not None:
        input_["proxy_name"] = proxy_name
    if proxy_arn is not None:
        input_["proxy_arn"] = proxy_arn
    if listener_properties_to_add is not None:
        input_["listener_properties_to_add"] = listener_properties_to_add
    if listener_properties_to_remove is not None:
        input_["listener_properties_to_remove"] = listener_properties_to_remove
    if tls_intercept_properties is not None:
        input_["tls_intercept_properties"] = tls_intercept_properties

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