Skip to content

update_rule_set

update_rule_set(
    rule_set_id: RuleSetId,
    *,
    config_overrides: Optional[MailManagerClientConfig] = None,
    rule_set_name: Optional[RuleSetName] = None,
    rules: Optional[Rules] = None,
) -> UpdateRuleSetResponse

Update attributes of an already provisioned rule set.

Parameters:

  • rule_set_id (RuleSetId) –

    The identifier of a rule set you want to update.

  • rule_set_name (Optional[RuleSetName], default: None ) –

    A user-friendly name for the rule set resource.

  • rules (Optional[Rules], default: None ) –

    A new set of rules to replace the current rules of the rule set—these rules will override all the rules of the rule set.

Raises:

Source code in docs_src/capo_mailmanager/_services/mail_manager.py
def update_rule_set(
    self,
    rule_set_id: "capo_mailmanager.types.rule_set_id.RuleSetId",
    *,
    config_overrides: Optional[MailManagerClientConfig] = None,
    rule_set_name: Optional[
        "capo_mailmanager.types.rule_set_name.RuleSetName"
    ] = None,
    rules: Optional["capo_mailmanager.types.rules.Rules"] = None,
) -> "capo_mailmanager.types.update_rule_set_response.UpdateRuleSetResponse":
    """<p>Update attributes of an already provisioned rule set.</p>

    Args:
        rule_set_id: <p>The identifier of a rule set you want to update.</p>
        rule_set_name: <p>A user-friendly name for the rule set resource.</p>
        rules: <p>A new set of rules to replace the current rules of the rule set—these rules will override all the rules of the rule set.</p>

    Raises:
        capo_mailmanager.errors.conflict_exception.ConflictException: <p>The request configuration has conflicts. For details, see the accompanying error message.</p>
        capo_mailmanager.errors.resource_not_found_exception.ResourceNotFoundException: <p>Occurs when a requested resource is not found.</p>
        capo_mailmanager.errors.validation_exception.ValidationException: <p>The request validation has failed. For details, see the accompanying error message.</p>
        capo_mailmanager.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_mailmanager.types.update_rule_set_request.UpdateRuleSetRequest]",
    ) -> OperationResponse[
        "capo_mailmanager.types.update_rule_set_response.UpdateRuleSetResponse"
    ]:
        import capo_mailmanager._operations.mail_manager_svc.update_rule_set

        output, http_response = (
            capo_mailmanager._operations.mail_manager_svc.update_rule_set.update_rule_set(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    def _redact_input(
        input_: "capo_mailmanager.types.update_rule_set_request.UpdateRuleSetRequest",
    ) -> dict[str, Any]:
        import capo_mailmanager.types.update_rule_set_request

        return capo_mailmanager.types.update_rule_set_request.redact_sensitive(
            input_
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("UpdateRuleSet", redact_input=_redact_input),
    )
    input_: capo_mailmanager.types.update_rule_set_request.UpdateRuleSetRequest = {
        "rule_set_id": rule_set_id
    }
    if rule_set_name is not None:
        input_["rule_set_name"] = rule_set_name
    if rules is not None:
        input_["rules"] = rules

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