set_active_receipt_rule_set `async` ¶

set_active_receipt_rule_set(
    *,
    config_overrides: Optional[AsyncSESClientConfig] = None,
    rule_set_name: Optional[ReceiptRuleSetName] = None,
) -> SetActiveReceiptRuleSetResponse

Sets the specified receipt rule set as the active receipt rule set.

To disable your email-receiving through Amazon SES completely, you can call this operation with RuleSetName set to null.

For information about managing receipt rule sets, see the Amazon SES Developer Guide.

You can execute this operation no more than once per second.

Parameters:

rule_set_name (Optional[ReceiptRuleSetName], default: None ) –

The name of the receipt rule set to make active. Setting this value to null disables all email receiving.

Raises:

RuleSetDoesNotExistException –

Indicates that the provided receipt rule set does not exist.
UnknownServiceError –

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

Examples:

SetActiveReceiptRuleSet The following example sets the active receipt rule set:

>>> await client.set_active_receipt_rule_set(rule_set_name='RuleSetToActivate')

Source code in docs_src/capo_ses/_services/async_ses.py

async def set_active_receipt_rule_set(
    self,
    *,
    config_overrides: Optional[AsyncSESClientConfig] = None,
    rule_set_name: Optional[
        "capo_ses.types.receipt_rule_set_name.ReceiptRuleSetName"
    ] = None,
) -> "capo_ses.types.set_active_receipt_rule_set_response.SetActiveReceiptRuleSetResponse":
    """<p>Sets the specified receipt rule set as the active receipt rule set.</p> <note> <p>To disable your email-receiving through Amazon SES completely, you can call this operation with <code>RuleSetName</code> set to null.</p> </note> <p>For information about managing receipt rule sets, see the <a href="https://docs.aws.amazon.com/ses/latest/dg/receiving-email-receipt-rules-console-walkthrough.html">Amazon SES Developer Guide</a>.</p> <p>You can execute this operation no more than once per second.</p>

    Args:
        rule_set_name: <p>The name of the receipt rule set to make active. Setting this value to null disables all email receiving.</p>

    Raises:
        capo_ses.errors.rule_set_does_not_exist_exception.RuleSetDoesNotExistException: <p>Indicates that the provided receipt rule set does not exist.</p>
        capo_ses.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        SetActiveReceiptRuleSet
        The following example sets the active receipt rule set:

        >>> await client.set_active_receipt_rule_set(rule_set_name='RuleSetToActivate')
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_ses.types.set_active_receipt_rule_set_request.SetActiveReceiptRuleSetRequest]",
    ) -> AsyncOperationResponse[
        "capo_ses.types.set_active_receipt_rule_set_response.SetActiveReceiptRuleSetResponse"
    ]:
        import capo_ses._operations.simple_email_service.set_active_receipt_rule_set

        (
            output,
            http_response,
        ) = await capo_ses._operations.simple_email_service.set_active_receipt_rule_set.async_set_active_receipt_rule_set(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("SetActiveReceiptRuleSet")
    )
    input_: capo_ses.types.set_active_receipt_rule_set_request.SetActiveReceiptRuleSetRequest = {}
    if rule_set_name is not None:
        input_["rule_set_name"] = rule_set_name

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

set_active_receipt_rule_set async ¶

set_active_receipt_rule_set `async` ¶