libZSservicesZSamazonka-sesZSamazonka-ses
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.SES.Types.LambdaAction

Description

 
Synopsis

Documentation

data LambdaAction Source #

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.

See: newLambdaAction smart constructor.

Constructors

LambdaAction' 

Fields

  • invocationType :: Maybe InvocationType

    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.

  • topicArn :: Maybe Text

    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.

  • functionArn :: Text

    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.

Instances

Instances details
Eq LambdaAction Source # 
Instance details

Defined in Amazonka.SES.Types.LambdaAction

Read LambdaAction Source # 
Instance details

Defined in Amazonka.SES.Types.LambdaAction

Show LambdaAction Source # 
Instance details

Defined in Amazonka.SES.Types.LambdaAction

Generic LambdaAction Source # 
Instance details

Defined in Amazonka.SES.Types.LambdaAction

Associated Types

type Rep LambdaAction :: Type -> Type #

NFData LambdaAction Source # 
Instance details

Defined in Amazonka.SES.Types.LambdaAction

Methods

rnf :: LambdaAction -> () #

Hashable LambdaAction Source # 
Instance details

Defined in Amazonka.SES.Types.LambdaAction

ToQuery LambdaAction Source # 
Instance details

Defined in Amazonka.SES.Types.LambdaAction

FromXML LambdaAction Source # 
Instance details

Defined in Amazonka.SES.Types.LambdaAction

type Rep LambdaAction Source # 
Instance details

Defined in Amazonka.SES.Types.LambdaAction

type Rep LambdaAction = D1 ('MetaData "LambdaAction" "Amazonka.SES.Types.LambdaAction" "libZSservicesZSamazonka-sesZSamazonka-ses" 'False) (C1 ('MetaCons "LambdaAction'" 'PrefixI 'True) (S1 ('MetaSel ('Just "invocationType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe InvocationType)) :*: (S1 ('MetaSel ('Just "topicArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "functionArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newLambdaAction Source #

Create a value of LambdaAction with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:invocationType:LambdaAction', lambdaAction_invocationType - 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.

$sel:topicArn:LambdaAction', lambdaAction_topicArn - 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.

$sel:functionArn:LambdaAction', lambdaAction_functionArn - 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.

lambdaAction_invocationType :: Lens' LambdaAction (Maybe InvocationType) Source #

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.

lambdaAction_topicArn :: Lens' LambdaAction (Maybe Text) Source #

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.

lambdaAction_functionArn :: Lens' LambdaAction Text Source #

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.