You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-ses/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.

Instance Attribute Summary collapse

Instance Attribute Details

#organization_arnString

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.

Returns:

  • (String)


5820
5821
5822
5823
5824
# File 'gems/aws-sdk-ses/lib/aws-sdk-ses/types.rb', line 5820

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

#topic_arnString

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.

Returns:

  • (String)


5820
5821
5822
5823
5824
# File 'gems/aws-sdk-ses/lib/aws-sdk-ses/types.rb', line 5820

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