Skip to content

update_receipt_rule async 

update_receipt_rule(
    rule_set_name: ReceiptRuleSetName,
    rule: ReceiptRule,
    *,
    config_overrides: Optional[AsyncSESClientConfig] = None,
) -> UpdateReceiptRuleResponse

Updates a receipt rule.

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

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

Parameters:

  • rule_set_name (ReceiptRuleSetName) –

    The name of the receipt rule set that the receipt rule belongs to.

  • rule (ReceiptRule) –

    A data structure that contains the updated receipt rule information.

Raises:

Examples:

UpdateReceiptRule The following example updates a receipt rule to use an Amazon S3 action:

>>> await client.update_receipt_rule(rule_set_name='MyRuleSet', rule={'TlsPolicy': 'Optional', 'Enabled': True, 'Name': 'MyRule', 'Actions': [{'S3Action': {'ObjectKeyPrefix': 'email', 'BucketName': 'MyBucket'}}], 'ScanEnabled': True})
Source code in docs_src/capo_ses/_services/async_ses.py 
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
3950
3951
3952
3953
3954
3955
3956
3957
3958
3959
3960
3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
3981
3982
3983
3984
3985
3986
3987
async def update_receipt_rule(
    self,
    rule_set_name: "capo_ses.types.receipt_rule_set_name.ReceiptRuleSetName",
    rule: "capo_ses.types.receipt_rule.ReceiptRule",
    *,
    config_overrides: Optional[AsyncSESClientConfig] = None,
) -> "capo_ses.types.update_receipt_rule_response.UpdateReceiptRuleResponse":
    """<p>Updates a receipt rule.</p> <p>For information about managing receipt rules, 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 that the receipt rule belongs to.</p>
        rule: <p>A data structure that contains the updated receipt rule information.</p>

    Raises:
        capo_ses.errors.invalid_lambda_function_exception.InvalidLambdaFunctionException: <p>Indicates that the provided Amazon Web Services Lambda function is invalid, or that Amazon SES could not execute the provided function, possibly due to permissions issues. For information about giving permissions, see the <a href="https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-permissions.html">Amazon SES Developer Guide</a>.</p>
        capo_ses.errors.invalid_s3_configuration_exception.InvalidS3ConfigurationException: <p>Indicates that the provided Amazon S3 bucket or Amazon Web Services KMS encryption key is invalid, or that Amazon SES could not publish to the bucket, possibly due to permissions issues. For information about giving permissions, see the <a href="https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-permissions.html">Amazon SES Developer Guide</a>.</p>
        capo_ses.errors.invalid_sns_topic_exception.InvalidSnsTopicException: <p>Indicates that the provided Amazon SNS topic is invalid, or that Amazon SES could not publish to the topic, possibly due to permissions issues. For information about giving permissions, see the <a href="https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-permissions.html">Amazon SES Developer Guide</a>.</p>
        capo_ses.errors.limit_exceeded_exception.LimitExceededException: <p>Indicates that a resource could not be created because of service limits. For a list of Amazon SES limits, see the <a href="https://docs.aws.amazon.com/ses/latest/DeveloperGuide/limits.html">Amazon SES Developer Guide</a>.</p>
        capo_ses.errors.rule_does_not_exist_exception.RuleDoesNotExistException: <p>Indicates that the provided receipt rule does not exist.</p>
        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:
        UpdateReceiptRule
        The following example updates a receipt rule to use an Amazon S3 action:

        >>> await client.update_receipt_rule(rule_set_name='MyRuleSet', rule={'TlsPolicy': 'Optional', 'Enabled': True, 'Name': 'MyRule', 'Actions': [{'S3Action': {'ObjectKeyPrefix': 'email', 'BucketName': 'MyBucket'}}], 'ScanEnabled': True})
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_ses.types.update_receipt_rule_request.UpdateReceiptRuleRequest]",
    ) -> AsyncOperationResponse[
        "capo_ses.types.update_receipt_rule_response.UpdateReceiptRuleResponse"
    ]:
        import capo_ses._operations.simple_email_service.update_receipt_rule

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdateReceiptRule")
    )
    input_: capo_ses.types.update_receipt_rule_request.UpdateReceiptRuleRequest = {
        "rule_set_name": rule_set_name,
        "rule": rule,
    }

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