« blib/lib/Paws/PinpointEmail/EmailContent.pm
↑ Summary
blib/lib/Paws/PinpointEmail/EventDestinationDefinition.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::PinpointEmail::EventDestination; | ||
| 3 | use Moose; | ||
| 4 | has CloudWatchDestination => (is => 'ro', isa => 'Paws::PinpointEmail::CloudWatchDestination'); | ||
| 5 | has Enabled => (is => 'ro', isa => 'Bool'); | ||
| 6 | has KinesisFirehoseDestination => (is => 'ro', isa => 'Paws::PinpointEmail::KinesisFirehoseDestination'); | ||
| 7 | has MatchingEventTypes => (is => 'ro', isa => 'ArrayRef[Str|Undef]', required => 1); | ||
| 8 | has Name => (is => 'ro', isa => 'Str', required => 1); | ||
| 9 | has PinpointDestination => (is => 'ro', isa => 'Paws::PinpointEmail::PinpointDestination'); | ||
| 10 | has SnsDestination => (is => 'ro', isa => 'Paws::PinpointEmail::SnsDestination'); | ||
| 11 | |||
| 12 | 1; | ||
| 13 | |||
| 14 | ### main pod documentation begin ### | ||
| 15 | |||
| 16 | =head1 NAME | ||
| 17 | |||
| 18 | Paws::PinpointEmail::EventDestination | ||
| 19 | |||
| 20 | =head1 USAGE | ||
| 21 | |||
| 22 | This class represents one of two things: | ||
| 23 | |||
| 24 | =head3 Arguments in a call to a service | ||
| 25 | |||
| 26 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 27 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 28 | |||
| 29 | As an example, if Att1 is expected to be a Paws::PinpointEmail::EventDestination object: | ||
| 30 | |||
| 31 | $service_obj->Method(Att1 => { CloudWatchDestination => $value, ..., SnsDestination => $value }); | ||
| 32 | |||
| 33 | =head3 Results returned from an API call | ||
| 34 | |||
| 35 | Use accessors for each attribute. If Att1 is expected to be an Paws::PinpointEmail::EventDestination object: | ||
| 36 | |||
| 37 | $result = $service_obj->Method(...); | ||
| 38 | $result->Att1->CloudWatchDestination | ||
| 39 | |||
| 40 | =head1 DESCRIPTION | ||
| 41 | |||
| 42 | In Amazon Pinpoint, I<events> include message sends, deliveries, opens, | ||
| 43 | clicks, bounces, and complaints. I<Event destinations> are places that | ||
| 44 | you can send information about these events to. For example, you can | ||
| 45 | send event data to Amazon SNS to receive notifications when you receive | ||
| 46 | bounces or complaints, or you can use Amazon Kinesis Data Firehose to | ||
| 47 | stream data to Amazon S3 for long-term storage. | ||
| 48 | |||
| 49 | =head1 ATTRIBUTES | ||
| 50 | |||
| 51 | |||
| 52 | =head2 CloudWatchDestination => L<Paws::PinpointEmail::CloudWatchDestination> | ||
| 53 | |||
| 54 | An object that defines an Amazon CloudWatch destination for email | ||
| 55 | events. You can use Amazon CloudWatch to monitor and gain insights on | ||
| 56 | your email sending metrics. | ||
| 57 | |||
| 58 | |||
| 59 | =head2 Enabled => Bool | ||
| 60 | |||
| 61 | If C<true>, the event destination is enabled. When the event | ||
| 62 | destination is enabled, the specified event types are sent to the | ||
| 63 | destinations in this C<EventDestinationDefinition>. | ||
| 64 | |||
| 65 | If C<false>, the event destination is disabled. When the event | ||
| 66 | destination is disabled, events aren't sent to the specified | ||
| 67 | destinations. | ||
| 68 | |||
| 69 | |||
| 70 | =head2 KinesisFirehoseDestination => L<Paws::PinpointEmail::KinesisFirehoseDestination> | ||
| 71 | |||
| 72 | An object that defines an Amazon Kinesis Data Firehose destination for | ||
| 73 | email events. You can use Amazon Kinesis Data Firehose to stream data | ||
| 74 | to other services, such as Amazon S3 and Amazon Redshift. | ||
| 75 | |||
| 76 | |||
| 77 | =head2 B<REQUIRED> MatchingEventTypes => ArrayRef[Str|Undef] | ||
| 78 | |||
| 79 | The types of events that Amazon Pinpoint sends to the specified event | ||
| 80 | destinations. | ||
| 81 | |||
| 82 | |||
| 83 | =head2 B<REQUIRED> Name => Str | ||
| 84 | |||
| 85 | A name that identifies the event destination. | ||
| 86 | |||
| 87 | |||
| 88 | =head2 PinpointDestination => L<Paws::PinpointEmail::PinpointDestination> | ||
| 89 | |||
| 90 | An object that defines a Amazon Pinpoint destination for email events. | ||
| 91 | You can use Amazon Pinpoint events to create attributes in Amazon | ||
| 92 | Pinpoint projects. You can use these attributes to create segments for | ||
| 93 | your campaigns. | ||
| 94 | |||
| 95 | |||
| 96 | =head2 SnsDestination => L<Paws::PinpointEmail::SnsDestination> | ||
| 97 | |||
| 98 | An object that defines an Amazon SNS destination for email events. You | ||
| 99 | can use Amazon SNS to send notification when certain email events | ||
| 100 | occur. | ||
| 101 | |||
| 102 | |||
| 103 | |||
| 104 | =head1 SEE ALSO | ||
| 105 | |||
| 106 | This class forms part of L<Paws>, describing an object used in L<Paws::PinpointEmail> | ||
| 107 | |||
| 108 | =head1 BUGS and CONTRIBUTIONS | ||
| 109 | |||
| 110 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 111 | |||
| 112 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 113 | |||
| 114 | =cut | ||
| 115 |