Describe Active Receipt Rule Set

ses_describe_active_receipt_rule_set

R Documentation

Returns the metadata and receipt rules for the receipt rule set that is currently active

Description

Returns the metadata and receipt rules for the receipt rule set that is currently active.

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

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

Usage

ses_describe_active_receipt_rule_set()

Value

A list with the following syntax:

list(
  Metadata = list(
    Name = "string",
    CreatedTimestamp = as.POSIXct(
      "2015-01-01"
    )
  ),
  Rules = list(
    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_active_receipt_rule_set()

Examples

## Not run: 
# The following example returns the metadata and receipt rules for the
# receipt rule set that is currently active:
svc$describe_active_receipt_rule_set()

## End(Not run)