Describe Receipt Rule

ses_describe_receipt_rule

R Documentation

Returns the details of the specified receipt rule

Description

Returns the details of the specified receipt rule.

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

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

Usage

ses_describe_receipt_rule(RuleSetName, RuleName)

Arguments

RuleSetName

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

RuleName

[required] The name of the receipt rule.

Value

A list with the following syntax:

list(
  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",
          IamRoleArn = "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
  )
)

Request syntax

svc$describe_receipt_rule(
  RuleSetName = "string",
  RuleName = "string"
)

Examples

## Not run: 
# The following example returns the details of a receipt rule:
svc$describe_receipt_rule(
  RuleName = "MyRule",
  RuleSetName = "MyRuleSet"
)

## End(Not run)