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

Inherits:
Struct
  • Object
show all
Includes:
Aws::Structure
Defined in:
lib/aws-sdk-ses/types.rb

Overview

Note:

When making an API call, you may pass LambdaAction data as a hash:

{
  topic_arn: "AmazonResourceName",
  function_arn: "AmazonResourceName", # required
  invocation_type: "Event", # accepts Event, RequestResponse
}

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

To enable Amazon SES to call your AWS 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 AWS Lambda actions in receipt rules, see the [Amazon SES Developer Guide].

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

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#function_arn ⇒ String

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

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

Returns:

  • (String) 


2391
2392
2393
2394
2395
2396
 
# File 'lib/aws-sdk-ses/types.rb', line 2391

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

#invocation_type ⇒ String

The invocation type of the AWS Lambda function. An invocation type of ‘RequestResponse` means that the execution of the function will immediately result in a response, and a value of `Event` means that the function will be invoked asynchronously. The default value is `Event`. For information about AWS Lambda invocation types, see the [AWS Lambda Developer Guide].

There is a 30-second timeout on ‘RequestResponse` invocations. You should use `Event` invocation in most cases. Use `RequestResponse` only when you want 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) 


2391
2392
2393
2394
2395
2396
 
# File 'lib/aws-sdk-ses/types.rb', line 2391

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

#topic_arn ⇒ String

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

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

Returns:

  • (String) 


2391
2392
2393
2394
2395
2396
 
# File 'lib/aws-sdk-ses/types.rb', line 2391

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