Skip to content

update_proxy_rule_priorities async

update_proxy_rule_priorities(
    rule_group_request_phase: RuleGroupRequestPhase,
    rules: ProxyRulePriorityList,
    update_token: UpdateToken,
    *,
    config_overrides: Optional[AsyncNetworkFirewallClientConfig] = None,
    proxy_rule_group_name: Optional[ResourceName] = None,
    proxy_rule_group_arn: Optional[ResourceArn] = None,
) -> UpdateProxyRulePrioritiesResponse

Updates proxy rule priorities within a proxy rule group.

Parameters:

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

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

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

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

    The Amazon Resource Name (ARN) of a proxy rule group.

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

  • rule_group_request_phase (RuleGroupRequestPhase) –

    Evaluation points in the traffic flow where rules are applied. There are three phases in a traffic where the rule match is applied.

  • rules (ProxyRulePriorityList) –

    proxy rule resources to update to new positions.

  • update_token (UpdateToken) –

    A token used for optimistic locking. Network Firewall returns a token to your requests that access the proxy rule group. The token marks the state of the proxy rule group resource at the time of the request.

    To make changes to the proxy rule group, you provide the token in your request. Network Firewall uses the token to ensure that the proxy rule group hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the proxy rule group 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.

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.

  • UnknownServiceError –

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

Source code in docs_src/capo_network_firewall/_services/async_network_firewall.py
async def update_proxy_rule_priorities(
    self,
    rule_group_request_phase: "capo_network_firewall.types.rule_group_request_phase.RuleGroupRequestPhase",
    rules: "capo_network_firewall.types.proxy_rule_priority_list.ProxyRulePriorityList",
    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,
) -> "capo_network_firewall.types.update_proxy_rule_priorities_response.UpdateProxyRulePrioritiesResponse":
    """<p>Updates proxy rule priorities within a proxy rule group.</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>
        rule_group_request_phase: <p>Evaluation points in the traffic flow where rules are applied. There are three phases in a traffic where the rule match is applied. </p>
        rules: <p>proxy rule resources to update to new positions. </p>
        update_token: <p>A token used for optimistic locking. Network Firewall returns a token to your requests that access the proxy rule group. The token marks the state of the proxy rule group resource at the time of the request. </p> <p>To make changes to the proxy rule group, you provide the token in your request. Network Firewall uses the token to ensure that the proxy rule group 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 group 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_priorities_request.UpdateProxyRulePrioritiesRequest]",
    ) -> AsyncOperationResponse[
        "capo_network_firewall.types.update_proxy_rule_priorities_response.UpdateProxyRulePrioritiesResponse"
    ]:
        import capo_network_firewall._operations.network_firewall_20201112.update_proxy_rule_priorities

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdateProxyRulePriorities")
    )
    input_: capo_network_firewall.types.update_proxy_rule_priorities_request.UpdateProxyRulePrioritiesRequest = {
        "rule_group_request_phase": rule_group_request_phase,
        "rules": rules,
        "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

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