| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::SES::WorkmailAction; | ||
| 3 | use Moose; | ||
| 4 | has OrganizationArn => (is => 'ro', isa => 'Str', required => 1); | ||
| 5 | has TopicArn => (is => 'ro', isa => 'Str'); | ||
| 6 | |||
| 7 | 1; | ||
| 8 | |||
| 9 | ### main pod documentation begin ### | ||
| 10 | |||
| 11 | =head1 NAME | ||
| 12 | |||
| 13 | Paws::SES::WorkmailAction | ||
| 14 | |||
| 15 | =head1 USAGE | ||
| 16 | |||
| 17 | This class represents one of two things: | ||
| 18 | |||
| 19 | =head3 Arguments in a call to a service | ||
| 20 | |||
| 21 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 22 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 23 | |||
| 24 | As an example, if Att1 is expected to be a Paws::SES::WorkmailAction object: | ||
| 25 | |||
| 26 | $service_obj->Method(Att1 => { OrganizationArn => $value, ..., TopicArn => $value }); | ||
| 27 | |||
| 28 | =head3 Results returned from an API call | ||
| 29 | |||
| 30 | Use accessors for each attribute. If Att1 is expected to be an Paws::SES::WorkmailAction object: | ||
| 31 | |||
| 32 | $result = $service_obj->Method(...); | ||
| 33 | $result->Att1->OrganizationArn | ||
| 34 | |||
| 35 | =head1 DESCRIPTION | ||
| 36 | |||
| 37 | When included in a receipt rule, this action calls Amazon WorkMail and, | ||
| 38 | optionally, publishes a notification to Amazon Simple Notification | ||
| 39 | Service (Amazon SNS). You will typically not use this action directly | ||
| 40 | because Amazon WorkMail adds the rule automatically during its setup | ||
| 41 | procedure. | ||
| 42 | |||
| 43 | For information using a receipt rule to call Amazon WorkMail, see the | ||
| 44 | Amazon SES Developer Guide | ||
| 45 | (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-action-workmail.html). | ||
| 46 | |||
| 47 | =head1 ATTRIBUTES | ||
| 48 | |||
| 49 | |||
| 50 | =head2 B<REQUIRED> OrganizationArn => Str | ||
| 51 | |||
| 52 | The ARN of the Amazon WorkMail organization. An example of an Amazon | ||
| 53 | WorkMail organization ARN is | ||
| 54 | C<arn:aws:workmail:us-west-2:123456789012:organization/m-68755160c4cb4e29a2b2f8fb58f359d7>. | ||
| 55 | For information about Amazon WorkMail organizations, see the Amazon | ||
| 56 | WorkMail Administrator Guide | ||
| 57 | (https://docs.aws.amazon.com/workmail/latest/adminguide/organizations_overview.html). | ||
| 58 | |||
| 59 | |||
| 60 | =head2 TopicArn => Str | ||
| 61 | |||
| 62 | The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when | ||
| 63 | the WorkMail action is called. An example of an Amazon SNS topic ARN is | ||
| 64 | C<arn:aws:sns:us-west-2:123456789012:MyTopic>. For more information | ||
| 65 | about Amazon SNS topics, see the Amazon SNS Developer Guide | ||
| 66 | (https://docs.aws.amazon.com/sns/latest/dg/CreateTopic.html). | ||
| 67 | |||
| 68 | |||
| 69 | |||
| 70 | =head1 SEE ALSO | ||
| 71 | |||
| 72 | This class forms part of L<Paws>, describing an object used in L<Paws::SES> | ||
| 73 | |||
| 74 | =head1 BUGS and CONTRIBUTIONS | ||
| 75 | |||
| 76 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 77 | |||
| 78 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 79 | |||
| 80 | =cut | ||
| 81 |