update_firewall_policy ¶

def update_firewall_policy(
    self,
    update_token: "capo_network_firewall.types.update_token.UpdateToken",
    firewall_policy: "capo_network_firewall.types.firewall_policy.FirewallPolicy",
    *,
    config_overrides: Optional[NetworkFirewallClientConfig] = None,
    firewall_policy_arn: Optional[
        "capo_network_firewall.types.resource_arn.ResourceArn"
    ] = None,
    firewall_policy_name: Optional[
        "capo_network_firewall.types.resource_name.ResourceName"
    ] = None,
    description: Optional[
        "capo_network_firewall.types.description.Description"
    ] = None,
    dry_run: Optional["capo_network_firewall.types.boolean.Boolean"] = None,
    encryption_configuration: Optional[
        "capo_network_firewall.types.encryption_configuration.EncryptionConfiguration"
    ] = None,
) -> "capo_network_firewall.types.update_firewall_policy_response.UpdateFirewallPolicyResponse":
    """<p>Updates the properties of the specified firewall policy.</p>

    Args:
        update_token: <p>A token used for optimistic locking. Network Firewall returns a token to your requests that access the firewall policy. The token marks the state of the policy resource at the time of the request. </p> <p>To make changes to the policy, you provide the token in your request. Network Firewall uses the token to ensure that the policy 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 firewall policy again to get a current copy of it with current token. Reapply your changes as needed, then try the operation again using the new token. </p>
        firewall_policy_arn: <p>The Amazon Resource Name (ARN) of the firewall policy.</p> <p>You must specify the ARN or the name, and you can specify both. </p>
        firewall_policy_name: <p>The descriptive name of the firewall policy. You can't change the name of a firewall policy after you create it.</p> <p>You must specify the ARN or the name, and you can specify both. </p>
        firewall_policy: <p>The updated firewall policy to use for the firewall. You can't add or remove a <a>TLSInspectionConfiguration</a> after you create a firewall policy. However, you can replace an existing TLS inspection configuration with another <code>TLSInspectionConfiguration</code>.</p>
        description: <p>A description of the firewall policy.</p>
        dry_run: <p>Indicates whether you want Network Firewall to just check the validity of the request, rather than run the request. </p> <p>If set to <code>TRUE</code>, Network Firewall checks whether the request can run successfully, but doesn't actually make the requested changes. The call returns the value that the request would return if you ran it with dry run set to <code>FALSE</code>, but doesn't make additions or changes to your resources. This option allows you to make sure that you have the required permissions to run the request and that your request parameters are valid. </p> <p>If set to <code>FALSE</code>, Network Firewall makes the requested changes to your resources. </p>
        encryption_configuration: <p>A complex type that contains settings for encryption of your firewall policy resources.</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.invalid_token_exception.InvalidTokenException: <p>The token you provided is stale or isn't valid for the operation. </p>
        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.
    """

    def _handler(
        req: "OperationRequest[capo_network_firewall.types.update_firewall_policy_request.UpdateFirewallPolicyRequest]",
    ) -> OperationResponse[
        "capo_network_firewall.types.update_firewall_policy_response.UpdateFirewallPolicyResponse"
    ]:
        import capo_network_firewall._operations.network_firewall_20201112.update_firewall_policy

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdateFirewallPolicy")
    )
    input_: capo_network_firewall.types.update_firewall_policy_request.UpdateFirewallPolicyRequest = {
        "update_token": update_token,
        "firewall_policy": firewall_policy,
    }
    if firewall_policy_arn is not None:
        input_["firewall_policy_arn"] = firewall_policy_arn
    if firewall_policy_name is not None:
        input_["firewall_policy_name"] = firewall_policy_name
    if description is not None:
        input_["description"] = description
    if dry_run is not None:
        input_["dry_run"] = dry_run
    if encryption_configuration is not None:
        input_["encryption_configuration"] = encryption_configuration

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