Skip to content

create_rule_set

create_rule_set(
    rule_set_name: RuleSetName,
    rules: Rules,
    *,
    config_overrides: Optional[MailManagerClientConfig] = None,
    client_token: Optional[IdempotencyToken] = None,
    tags: Optional[TagList] = None,
) -> CreateRuleSetResponse

Provision a new rule set.

Parameters:

  • client_token (Optional[IdempotencyToken], default: None ) –

    A unique token that Amazon SES uses to recognize subsequent retries of the same request.

  • rule_set_name (RuleSetName) –

    A user-friendly name for the rule set.

  • rules (Rules) –

    Conditional rules that are evaluated for determining actions on email.

  • tags (Optional[TagList], default: None ) –

    The tags used to organize, track, or control access for the resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.

Raises:

Source code in docs_src/capo_mailmanager/_services/mail_manager.py
def create_rule_set(
    self,
    rule_set_name: "capo_mailmanager.types.rule_set_name.RuleSetName",
    rules: "capo_mailmanager.types.rules.Rules",
    *,
    config_overrides: Optional[MailManagerClientConfig] = None,
    client_token: Optional[
        "capo_mailmanager.types.idempotency_token.IdempotencyToken"
    ] = None,
    tags: Optional["capo_mailmanager.types.tag_list.TagList"] = None,
) -> "capo_mailmanager.types.create_rule_set_response.CreateRuleSetResponse":
    """<p>Provision a new rule set.</p>

    Args:
        client_token: <p>A unique token that Amazon SES uses to recognize subsequent retries of the same request.</p>
        rule_set_name: <p>A user-friendly name for the rule set.</p>
        rules: <p>Conditional rules that are evaluated for determining actions on email.</p>
        tags: <p>The tags used to organize, track, or control access for the resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.</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.service_quota_exceeded_exception.ServiceQuotaExceededException: <p>Occurs when an operation exceeds a predefined service quota or limit.</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.create_rule_set_request.CreateRuleSetRequest]",
    ) -> OperationResponse[
        "capo_mailmanager.types.create_rule_set_response.CreateRuleSetResponse"
    ]:
        import capo_mailmanager._operations.mail_manager_svc.create_rule_set

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

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

        return capo_mailmanager.types.create_rule_set_request.redact_sensitive(
            input_
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("CreateRuleSet", redact_input=_redact_input),
    )
    input_: capo_mailmanager.types.create_rule_set_request.CreateRuleSetRequest = {
        "rule_set_name": rule_set_name,
        "rules": rules,
    }
    if client_token is None:
        client_token = str(uuid.uuid4())
    input_["client_token"] = client_token
    if tags is not None:
        input_["tags"] = tags

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