Package software.amazon.awssdk.services.ses.model

Class LambdaAction

java.lang.Object

software.amazon.awssdk.services.ses.model.LambdaAction

All Implemented Interfaces:

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

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

When included in a receipt rule, this action calls an Amazon Web Services Lambda function and, optionally, publishes a notification to Amazon Simple Notification Service (Amazon SNS).

To enable Amazon SES to call your Amazon Web Services Lambda function or to publish to an Amazon SNS topic of another account, Amazon SES must have permission to access those resources. For information about giving permissions, see the Amazon SES Developer Guide.

For information about using Amazon Web Services Lambda actions in receipt rules, see the Amazon SES Developer Guide.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	LambdaAction.Builder

Method Summary

Modifier and Type	Method	Description
static LambdaAction.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	functionArn()	The Amazon Resource Name (ARN) of the Amazon Web Services Lambda function.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
InvocationType	invocationType()	The invocation type of the Amazon Web Services Lambda function.
String	invocationTypeAsString()	The invocation type of the Amazon Web Services Lambda function.
List<SdkField<?>>	sdkFields()
static Class<? extends LambdaAction.Builder>	serializableBuilderClass()
LambdaAction.Builder	toBuilder()
String	topicArn()	The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the Lambda action is executed.
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

topicArn

public final String topicArn()

The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the Lambda action is executed. 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.

Returns:

The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the Lambda action is executed. 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.

functionArn

public final String functionArn()

The Amazon Resource Name (ARN) of the Amazon Web Services Lambda function. An example of an Amazon Web Services Lambda function ARN is arn:aws:lambda:us-west-2:account-id:function:MyFunction. For more information about Amazon Web Services Lambda, see the Amazon Web Services Lambda Developer Guide.

Returns:

The Amazon Resource Name (ARN) of the Amazon Web Services Lambda function. An example of an Amazon Web Services Lambda function ARN is arn:aws:lambda:us-west-2:account-id:function:MyFunction. For more information about Amazon Web Services Lambda, see the Amazon Web Services Lambda Developer Guide.

invocationType

public final InvocationType invocationType()

The invocation type of the Amazon Web Services Lambda function. An invocation type of RequestResponse means that the execution of the function immediately results in a response, and a value of Event means that the function is invoked asynchronously. The default value is Event. For information about Amazon Web Services Lambda invocation types, see the Amazon Web Services Lambda Developer Guide.

There is a 30-second timeout on RequestResponse invocations. You should use Event invocation in most cases. Use RequestResponse only to make a mail flow decision, such as whether to stop the receipt rule or the receipt rule set.

If the service returns an enum value that is not available in the current SDK version, invocationType will return InvocationType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from invocationTypeAsString().

Returns:

The invocation type of the Amazon Web Services Lambda function. An invocation type of RequestResponse means that the execution of the function immediately results in a response, and a value of Event means that the function is invoked asynchronously. The default value is Event. For information about Amazon Web Services Lambda invocation types, see the Amazon Web Services Lambda Developer Guide.

There is a 30-second timeout on RequestResponse invocations. You should use Event invocation in most cases. Use RequestResponse only to make a mail flow decision, such as whether to stop the receipt rule or the receipt rule set.

See Also:

InvocationType

invocationTypeAsString

public final String invocationTypeAsString()

The invocation type of the Amazon Web Services Lambda function. An invocation type of RequestResponse means that the execution of the function immediately results in a response, and a value of Event means that the function is invoked asynchronously. The default value is Event. For information about Amazon Web Services Lambda invocation types, see the Amazon Web Services Lambda Developer Guide.

There is a 30-second timeout on RequestResponse invocations. You should use Event invocation in most cases. Use RequestResponse only to make a mail flow decision, such as whether to stop the receipt rule or the receipt rule set.

If the service returns an enum value that is not available in the current SDK version, invocationType will return InvocationType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from invocationTypeAsString().

Returns:

The invocation type of the Amazon Web Services Lambda function. An invocation type of RequestResponse means that the execution of the function immediately results in a response, and a value of Event means that the function is invoked asynchronously. The default value is Event. For information about Amazon Web Services Lambda invocation types, see the Amazon Web Services Lambda Developer Guide.

There is a 30-second timeout on RequestResponse invocations. You should use Event invocation in most cases. Use RequestResponse only to make a mail flow decision, such as whether to stop the receipt rule or the receipt rule set.

See Also:

InvocationType

toBuilder

public LambdaAction.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<LambdaAction.Builder,LambdaAction>

builder

public static LambdaAction.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

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

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo