« blib/lib/Paws/SES/KinesisFirehoseDestination.pm
↑ Summary
blib/lib/Paws/SES/ListConfigurationSets.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::SES::LambdaAction; | ||
| 3 | use Moose; | ||
| 4 | has FunctionArn => (is => 'ro', isa => 'Str', required => 1); | ||
| 5 | has InvocationType => (is => 'ro', isa => 'Str'); | ||
| 6 | has TopicArn => (is => 'ro', isa => 'Str'); | ||
| 7 | |||
| 8 | 1; | ||
| 9 | |||
| 10 | ### main pod documentation begin ### | ||
| 11 | |||
| 12 | =head1 NAME | ||
| 13 | |||
| 14 | Paws::SES::LambdaAction | ||
| 15 | |||
| 16 | =head1 USAGE | ||
| 17 | |||
| 18 | This class represents one of two things: | ||
| 19 | |||
| 20 | =head3 Arguments in a call to a service | ||
| 21 | |||
| 22 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 23 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 24 | |||
| 25 | As an example, if Att1 is expected to be a Paws::SES::LambdaAction object: | ||
| 26 | |||
| 27 | $service_obj->Method(Att1 => { FunctionArn => $value, ..., TopicArn => $value }); | ||
| 28 | |||
| 29 | =head3 Results returned from an API call | ||
| 30 | |||
| 31 | Use accessors for each attribute. If Att1 is expected to be an Paws::SES::LambdaAction object: | ||
| 32 | |||
| 33 | $result = $service_obj->Method(...); | ||
| 34 | $result->Att1->FunctionArn | ||
| 35 | |||
| 36 | =head1 DESCRIPTION | ||
| 37 | |||
| 38 | When included in a receipt rule, this action calls an AWS Lambda | ||
| 39 | function and, optionally, publishes a notification to Amazon Simple | ||
| 40 | Notification Service (Amazon SNS). | ||
| 41 | |||
| 42 | To enable Amazon SES to call your AWS Lambda function or to publish to | ||
| 43 | an Amazon SNS topic of another account, Amazon SES must have permission | ||
| 44 | to access those resources. For information about giving permissions, | ||
| 45 | see the Amazon SES Developer Guide | ||
| 46 | (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-permissions.html). | ||
| 47 | |||
| 48 | For information about using AWS Lambda actions in receipt rules, see | ||
| 49 | the Amazon SES Developer Guide | ||
| 50 | (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-action-lambda.html). | ||
| 51 | |||
| 52 | =head1 ATTRIBUTES | ||
| 53 | |||
| 54 | |||
| 55 | =head2 B<REQUIRED> FunctionArn => Str | ||
| 56 | |||
| 57 | The Amazon Resource Name (ARN) of the AWS Lambda function. An example | ||
| 58 | of an AWS Lambda function ARN is | ||
| 59 | C<arn:aws:lambda:us-west-2:account-id:function:MyFunction>. For more | ||
| 60 | information about AWS Lambda, see the AWS Lambda Developer Guide | ||
| 61 | (https://docs.aws.amazon.com/lambda/latest/dg/welcome.html). | ||
| 62 | |||
| 63 | |||
| 64 | =head2 InvocationType => Str | ||
| 65 | |||
| 66 | The invocation type of the AWS Lambda function. An invocation type of | ||
| 67 | C<RequestResponse> means that the execution of the function will | ||
| 68 | immediately result in a response, and a value of C<Event> means that | ||
| 69 | the function will be invoked asynchronously. The default value is | ||
| 70 | C<Event>. For information about AWS Lambda invocation types, see the | ||
| 71 | AWS Lambda Developer Guide | ||
| 72 | (https://docs.aws.amazon.com/lambda/latest/dg/API_Invoke.html). | ||
| 73 | |||
| 74 | There is a 30-second timeout on C<RequestResponse> invocations. You | ||
| 75 | should use C<Event> invocation in most cases. Use C<RequestResponse> | ||
| 76 | only when you want to make a mail flow decision, such as whether to | ||
| 77 | stop the receipt rule or the receipt rule set. | ||
| 78 | |||
| 79 | |||
| 80 | =head2 TopicArn => Str | ||
| 81 | |||
| 82 | The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when | ||
| 83 | the Lambda action is taken. An example of an Amazon SNS topic ARN is | ||
| 84 | C<arn:aws:sns:us-west-2:123456789012:MyTopic>. For more information | ||
| 85 | about Amazon SNS topics, see the Amazon SNS Developer Guide | ||
| 86 | (https://docs.aws.amazon.com/sns/latest/dg/CreateTopic.html). | ||
| 87 | |||
| 88 | |||
| 89 | |||
| 90 | =head1 SEE ALSO | ||
| 91 | |||
| 92 | This class forms part of L<Paws>, describing an object used in L<Paws::SES> | ||
| 93 | |||
| 94 | =head1 BUGS and CONTRIBUTIONS | ||
| 95 | |||
| 96 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 97 | |||
| 98 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 99 | |||
| 100 | =cut | ||
| 101 |