update_proxy_rule async ¶

async def update_proxy_rule(
    self,
    proxy_rule_name: "capo_network_firewall.types.resource_name.ResourceName",
    update_token: "capo_network_firewall.types.update_token.UpdateToken",
    *,
    config_overrides: Optional[AsyncNetworkFirewallClientConfig] = None,
    proxy_rule_group_name: Optional[
        "capo_network_firewall.types.resource_name.ResourceName"
    ] = None,
    proxy_rule_group_arn: Optional[
        "capo_network_firewall.types.resource_arn.ResourceArn"
    ] = None,
    description: Optional[
        "capo_network_firewall.types.description.Description"
    ] = None,
    action: Optional[
        "capo_network_firewall.types.proxy_rule_phase_action.ProxyRulePhaseAction"
    ] = None,
    add_conditions: Optional[
        "capo_network_firewall.types.proxy_rule_condition_list.ProxyRuleConditionList"
    ] = None,
    remove_conditions: Optional[
        "capo_network_firewall.types.proxy_rule_condition_list.ProxyRuleConditionList"
    ] = None,
) -> (
    "capo_network_firewall.types.update_proxy_rule_response.UpdateProxyRuleResponse"
):
    """<p>Updates the properties of the specified proxy rule.</p>

    Args:
        proxy_rule_group_name: <p>The descriptive name of the proxy rule group. You can't change the name of a proxy rule group after you create it.</p> <p>You must specify the ARN or the name, and you can specify both. </p>
        proxy_rule_group_arn: <p>The Amazon Resource Name (ARN) of a proxy rule group.</p> <p>You must specify the ARN or the name, and you can specify both. </p>
        proxy_rule_name: <p>The descriptive name of the proxy rule. You can't change the name of a proxy rule after you create it.</p>
        description: <p>A description of the proxy rule. </p>
        action: <p>Depending on the match action, the proxy either stops the evaluation (if the action is terminal - allow or deny), or continues it (if the action is alert) until it matches a rule with a terminal action. </p>
        add_conditions: <p>Proxy rule conditions to add. Match criteria that specify what traffic attributes to examine. Conditions include operators (StringEquals, StringLike) and values to match against. </p>
        remove_conditions: <p>Proxy rule conditions to remove. Match criteria that specify what traffic attributes to examine. Conditions include operators (StringEquals, StringLike) and values to match against. </p>
        update_token: <p>A token used for optimistic locking. Network Firewall returns a token to your requests that access the proxy rule. The token marks the state of the proxy rule resource at the time of the request. </p> <p>To make changes to the proxy rule, you provide the token in your request. Network Firewall uses the token to ensure that the proxy rule 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 rule 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.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_network_firewall.types.update_proxy_rule_request.UpdateProxyRuleRequest]",
    ) -> AsyncOperationResponse[
        "capo_network_firewall.types.update_proxy_rule_response.UpdateProxyRuleResponse"
    ]:
        import capo_network_firewall._operations.network_firewall_20201112.update_proxy_rule

        (
            output,
            http_response,
        ) = await capo_network_firewall._operations.network_firewall_20201112.update_proxy_rule.async_update_proxy_rule(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdateProxyRule")
    )
    input_: capo_network_firewall.types.update_proxy_rule_request.UpdateProxyRuleRequest = {
        "proxy_rule_name": proxy_rule_name,
        "update_token": update_token,
    }
    if proxy_rule_group_name is not None:
        input_["proxy_rule_group_name"] = proxy_rule_group_name
    if proxy_rule_group_arn is not None:
        input_["proxy_rule_group_arn"] = proxy_rule_group_arn
    if description is not None:
        input_["description"] = description
    if action is not None:
        input_["action"] = action
    if add_conditions is not None:
        input_["add_conditions"] = add_conditions
    if remove_conditions is not None:
        input_["remove_conditions"] = remove_conditions

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output