Class: Aws::SES::Types::WorkmailAction

Inherits:
Struct
  • Object
show all
Includes:
Aws::Structure
Defined in:
lib/aws-sdk-ses/types.rb

Overview

Note:

When making an API call, you may pass WorkmailAction data as a 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].

[1]: docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-action-workmail.html

See Also:

Instance Attribute Summary collapse

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].

[1]: docs.aws.amazon.com/workmail/latest/adminguide/organizations_overview.html

Returns:

  • (String) 


5823
5824
5825
5826
5827
 
# File 'lib/aws-sdk-ses/types.rb', line 5823

class WorkmailAction < Struct.new(
  :topic_arn,
  :organization_arn)
  include Aws::Structure
end

#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].

[1]: docs.aws.amazon.com/sns/latest/dg/CreateTopic.html

Returns:

  • (String) 


5823
5824
5825
5826
5827
 
# File 'lib/aws-sdk-ses/types.rb', line 5823

class WorkmailAction < Struct.new(
  :topic_arn,
  :organization_arn)
  include Aws::Structure
end