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

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

Overview

When included in a receipt rule, this action calls Amazon WorkMail and, optionally, publishes a notification to Amazon Simple Notification Service (Amazon SNS). It usually isn’t necessary to set this up manually, 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/dg/receiving-email-action-workmail.html

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#organization_arn ⇒ String

The Amazon Resource Name (ARN) of the Amazon WorkMail organization. Amazon WorkMail ARNs use the following format:

‘arn:aws:workmail:<region>:<awsAccountId>:organization/<workmailOrganizationId>`

You can find the ID of your organization by using the

ListOrganizations][1

operation in Amazon WorkMail. Amazon WorkMail

organization IDs begin with “‘m-`”, followed by a string of alphanumeric characters.

For information about Amazon WorkMail organizations, see the [Amazon WorkMail Administrator Guide].

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

Returns:

  • (String) 


5420
5421
5422
5423
5424
5425
 
# File 'lib/aws-sdk-ses/types.rb', line 5420

class WorkmailAction < Struct.new(
  :topic_arn,
  :organization_arn)
  SENSITIVE = []
  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. You can find the ARN of a topic by using the [ListTopics] operation in Amazon SNS.

For more information about Amazon SNS topics, see the [Amazon SNS Developer Guide].

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

Returns:

  • (String) 


5420
5421
5422
5423
5424
5425
 
# File 'lib/aws-sdk-ses/types.rb', line 5420

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