You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::SES::Types::WorkmailAction
- Inherits:
-
Struct
- Object
- Struct
- Aws::SES::Types::WorkmailAction
- Defined in:
- (unknown)
Overview
When passing WorkmailAction as input to an Aws::Client method, you can use a vanilla Hash:
{
topic_arn: "AmazonResourceName",
organization_arn: "AmazonResourceName", # required
}
When included in a receipt rule, this action calls Amazon WorkMail and, optionally, publishes a notification to Amazon Simple Notification Service (Amazon SNS). You will typically not use this action directly because Amazon WorkMail adds the rule automatically during its setup procedure.
For information using a receipt rule to call Amazon WorkMail, see the Amazon SES Developer Guide.
Returned by:
Instance Attribute Summary collapse
-
#organization_arn ⇒ String
The ARN of the Amazon WorkMail organization.
-
#topic_arn ⇒ String
The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the WorkMail action is called.
Instance Attribute Details
#organization_arn ⇒ String
The ARN of the Amazon WorkMail organization. An example of an Amazon
WorkMail organization ARN is
arn:aws:workmail:us-west-2:123456789012:organization/m-68755160c4cb4e29a2b2f8fb58f359d7
.
For information about Amazon WorkMail organizations, see the Amazon
WorkMail Administrator Guide.
#topic_arn ⇒ String
The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when
the WorkMail action is called. An example of an Amazon SNS topic ARN is
arn:aws:sns:us-west-2:123456789012:MyTopic
. For more information about
Amazon SNS topics, see the Amazon SNS Developer Guide.