update_rule_group ¶

def update_rule_group(
    self,
    update_token: "capo_network_firewall.types.update_token.UpdateToken",
    *,
    config_overrides: Optional[NetworkFirewallClientConfig] = None,
    rule_group_arn: Optional[
        "capo_network_firewall.types.resource_arn.ResourceArn"
    ] = None,
    rule_group_name: Optional[
        "capo_network_firewall.types.resource_name.ResourceName"
    ] = None,
    rule_group: Optional["capo_network_firewall.types.rule_group.RuleGroup"] = None,
    rules: Optional["capo_network_firewall.types.rules_string.RulesString"] = None,
    type: Optional[
        "capo_network_firewall.types.rule_group_type.RuleGroupType"
    ] = 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,
    source_metadata: Optional[
        "capo_network_firewall.types.source_metadata.SourceMetadata"
    ] = None,
    analyze_rule_group: Optional[
        "capo_network_firewall.types.boolean.Boolean"
    ] = None,
    summary_configuration: Optional[
        "capo_network_firewall.types.summary_configuration.SummaryConfiguration"
    ] = None,
) -> (
    "capo_network_firewall.types.update_rule_group_response.UpdateRuleGroupResponse"
):
    """<p>Updates the rule settings for the specified rule group. You use a rule group by reference in one or more firewall policies. When you modify a rule group, you modify all firewall policies that use the rule group. </p> <p>To update a rule group, first call <a>DescribeRuleGroup</a> to retrieve the current <a>RuleGroup</a> object, update the object as needed, and then provide the updated object to this call. </p>

    Args:
        update_token: <p>A token used for optimistic locking. Network Firewall returns a token to your requests that access the rule group. The token marks the state of the rule group resource at the time of the request. </p> <p>To make changes to the rule group, you provide the token in your request. Network Firewall uses the token to ensure that the 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 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>
        rule_group_arn: <p>The Amazon Resource Name (ARN) of the rule group.</p> <p>You must specify the ARN or the name, and you can specify both. </p>
        rule_group_name: <p>The descriptive name of the rule group. You can't change the name of a rule group after you create it.</p> <p>You must specify the ARN or the name, and you can specify both. </p>
        rule_group: <p>An object that defines the rule group rules. </p> <note> <p>You must provide either this rule group setting or a <code>Rules</code> setting, but not both. </p> </note>
        rules: <p>A string containing stateful rule group rules specifications in Suricata flat format, with one rule per line. Use this to import your existing Suricata compatible rule groups. </p> <note> <p>You must provide either this rules setting or a populated <code>RuleGroup</code> setting, but not both. </p> </note> <p>You can provide your rule group specification in Suricata flat format through this setting when you create or update your rule group. The call response returns a <a>RuleGroup</a> object that Network Firewall has populated from your string. </p>
        type: <p>Indicates whether the rule group is stateless or stateful. If the rule group is stateless, it contains stateless rules. If it is stateful, it contains stateful rules. </p> <note> <p>This setting is required for requests that do not include the <code>RuleGroupARN</code>.</p> </note>
        description: <p>A description of the rule group. </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 rule group resources.</p>
        source_metadata: <p>A complex type that contains metadata about the rule group that your own rule group is copied from. You can use the metadata to keep track of updates made to the originating rule group.</p>
        analyze_rule_group: <p>Indicates whether you want Network Firewall to analyze the stateless rules in the rule group for rule behavior such as asymmetric routing. If set to <code>TRUE</code>, Network Firewall runs the analysis and then updates the rule group for you. To run the stateless rule group analyzer without updating the rule group, set <code>DryRun</code> to <code>TRUE</code>. </p>
        summary_configuration: <p>Updates the selected summary configuration for a rule group.</p> <p>Changes affect subsequent responses from <a>DescribeRuleGroupSummary</a>.</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_rule_group_request.UpdateRuleGroupRequest]",
    ) -> OperationResponse[
        "capo_network_firewall.types.update_rule_group_response.UpdateRuleGroupResponse"
    ]:
        import capo_network_firewall._operations.network_firewall_20201112.update_rule_group

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdateRuleGroup")
    )
    input_: capo_network_firewall.types.update_rule_group_request.UpdateRuleGroupRequest = {
        "update_token": update_token
    }
    if rule_group_arn is not None:
        input_["rule_group_arn"] = rule_group_arn
    if rule_group_name is not None:
        input_["rule_group_name"] = rule_group_name
    if rule_group is not None:
        input_["rule_group"] = rule_group
    if rules is not None:
        input_["rules"] = rules
    if type is not None:
        input_["type"] = type
    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
    if source_metadata is not None:
        input_["source_metadata"] = source_metadata
    if analyze_rule_group is not None:
        input_["analyze_rule_group"] = analyze_rule_group
    if summary_configuration is not None:
        input_["summary_configuration"] = summary_configuration

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