Class: Aws::SES::Types::LambdaAction

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

[1]: docs.aws.amazon.com/ses/latest/dg/receiving-email-permissions.html [2]: docs.aws.amazon.com/ses/latest/dg/receiving-email-action-lambda.html

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#function_arn ⇒ String

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

[1]: docs.aws.amazon.com/lambda/latest/dg/welcome.html

Returns:

  • (String) 


2454
2455
2456
2457
2458
2459
2460
 
# File 'lib/aws-sdk-ses/types.rb', line 2454

class LambdaAction < Struct.new(
  :topic_arn,
  :function_arn,
  :invocation_type)
  SENSITIVE = []
  include Aws::Structure
end

#invocation_type ⇒ String

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.

[1]: docs.aws.amazon.com/lambda/latest/dg/API_Invoke.html

Returns:

  • (String) 


2454
2455
2456
2457
2458
2459
2460
 
# File 'lib/aws-sdk-ses/types.rb', line 2454

class LambdaAction < Struct.new(
  :topic_arn,
  :function_arn,
  :invocation_type)
  SENSITIVE = []
  include Aws::Structure
end

#topic_arn ⇒ String

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

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

Returns:

  • (String) 


2454
2455
2456
2457
2458
2459
2460
 
# File 'lib/aws-sdk-ses/types.rb', line 2454

class LambdaAction < Struct.new(
  :topic_arn,
  :function_arn,
  :invocation_type)
  SENSITIVE = []
  include Aws::Structure
end