software.amazon.awssdk.services.ses.model

Class WorkmailAction

java.lang.Object

software.amazon.awssdk.services.ses.model.WorkmailAction

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<WorkmailAction.Builder,WorkmailAction>

@Generated(value="software.amazon.awssdk:codegen")
public final class WorkmailAction
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<WorkmailAction.Builder,WorkmailAction>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	WorkmailAction.Builder

Method Summary

Modifier and Type	Method and Description
static WorkmailAction.Builder	builder()
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	organizationArn() The ARN of the Amazon WorkMail organization.
List<SdkField<?>>	sdkFields()
static Class<? extends WorkmailAction.Builder>	serializableBuilderClass()
WorkmailAction.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	topicArn() The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the WorkMail action is called.
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

topicArn

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

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.

organizationArn

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

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.

toBuilder

public WorkmailAction.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<WorkmailAction.Builder,WorkmailAction>

Returns:

a builder for type T

builder

public static WorkmailAction.Builder builder()

serializableBuilderClass

public static Class<? extends WorkmailAction.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.