paws.customer.engagement (version 0.1.8)

ses_update_receipt_rule: Updates a receipt rule

Description

Updates a receipt rule.

Usage

ses_update_receipt_rule(RuleSetName, Rule)

Arguments

RuleSetName

[required] The name of the receipt rule set that the receipt rule belongs to.

Rule

[required] A data structure that contains the updated receipt rule information.

Request syntax

svc$update_receipt_rule(
  RuleSetName = "string",
  Rule = list(
    Name = "string",
    Enabled = TRUE|FALSE,
    TlsPolicy = "Require"|"Optional",
    Recipients = list(
      "string"
    ),
    Actions = list(
      list(
        S3Action = list(
          TopicArn = "string",
          BucketName = "string",
          ObjectKeyPrefix = "string",
          KmsKeyArn = "string"
        ),
        BounceAction = list(
          TopicArn = "string",
          SmtpReplyCode = "string",
          StatusCode = "string",
          Message = "string",
          Sender = "string"
        ),
        WorkmailAction = list(
          TopicArn = "string",
          OrganizationArn = "string"
        ),
        LambdaAction = list(
          TopicArn = "string",
          FunctionArn = "string",
          InvocationType = "Event"|"RequestResponse"
        ),
        StopAction = list(
          Scope = "RuleSet",
          TopicArn = "string"
        ),
        AddHeaderAction = list(
          HeaderName = "string",
          HeaderValue = "string"
        ),
        SNSAction = list(
          TopicArn = "string",
          Encoding = "UTF-8"|"Base64"
        )
      )
    ),
    ScanEnabled = TRUE|FALSE
  )
)

Details

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

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

Examples

# NOT RUN {
# The following example updates a receipt rule to use an Amazon S3 action:
svc$update_receipt_rule(
  Rule = list(
    Actions = list(
      list(
        S3Action = list(
          BucketName = "MyBucket",
          ObjectKeyPrefix = "email"
        )
      )
    ),
    Enabled = TRUE,
    Name = "MyRule",
    ScanEnabled = TRUE,
    TlsPolicy = "Optional"
  ),
  RuleSetName = "MyRuleSet"
)
# }
# NOT RUN {
# }