Class WorkmailAction
- java.lang.Object
-
- com.amazonaws.services.simpleemail.model.WorkmailAction
-
- All Implemented Interfaces:
Serializable
,Cloneable
public class WorkmailAction extends Object implements Serializable, Cloneable
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.
- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description WorkmailAction()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description WorkmailAction
clone()
boolean
equals(Object obj)
String
getOrganizationArn()
The ARN of the Amazon WorkMail organization.String
getTopicArn()
The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the WorkMail action is called.int
hashCode()
void
setOrganizationArn(String organizationArn)
The ARN of the Amazon WorkMail organization.void
setTopicArn(String topicArn)
The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the WorkMail action is called.String
toString()
Returns a string representation of this object; useful for testing and debugging.WorkmailAction
withOrganizationArn(String organizationArn)
The ARN of the Amazon WorkMail organization.WorkmailAction
withTopicArn(String topicArn)
The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the WorkMail action is called.
-
-
-
Method Detail
-
setTopicArn
public void setTopicArn(String topicArn)
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.- Parameters:
topicArn
- 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 isarn:aws:sns:us-west-2:123456789012:MyTopic
. For more information about Amazon SNS topics, see the Amazon SNS Developer Guide.
-
getTopicArn
public String getTopicArn()
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:
- 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.
-
withTopicArn
public WorkmailAction withTopicArn(String topicArn)
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.- Parameters:
topicArn
- 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 isarn:aws:sns:us-west-2:123456789012:MyTopic
. For more information about Amazon SNS topics, see the Amazon SNS Developer Guide.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setOrganizationArn
public void setOrganizationArn(String organizationArn)
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.- Parameters:
organizationArn
- The ARN of the Amazon WorkMail organization. An example of an Amazon WorkMail organization ARN isarn:aws:workmail:us-west-2:123456789012:organization/m-68755160c4cb4e29a2b2f8fb58f359d7
. For information about Amazon WorkMail organizations, see the Amazon WorkMail Administrator Guide.
-
getOrganizationArn
public String getOrganizationArn()
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:
- 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.
-
withOrganizationArn
public WorkmailAction withOrganizationArn(String organizationArn)
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.- Parameters:
organizationArn
- The ARN of the Amazon WorkMail organization. An example of an Amazon WorkMail organization ARN isarn:aws:workmail:us-west-2:123456789012:organization/m-68755160c4cb4e29a2b2f8fb58f359d7
. For information about Amazon WorkMail organizations, see the Amazon WorkMail Administrator Guide.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
toString
public String toString()
Returns a string representation of this object; useful for testing and debugging.- Overrides:
toString
in classObject
- Returns:
- A string representation of this object.
- See Also:
Object.toString()
-
clone
public WorkmailAction clone()
-
-