« blib/lib/Paws/SES/IdentityDkimAttributes.pm
↑ Summary
blib/lib/Paws/SES/IdentityVerificationAttributes.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::SES::IdentityNotificationAttributes; | ||
| 3 | 1 | ▶ | use Moose; |
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||
| 4 | 1 | has BounceTopic => (is => 'ro', isa => 'Str'); | |
| 5 | 1 | has ComplaintTopic => (is => 'ro', isa => 'Str'); | |
| 6 | 1 | has DeliveryTopic => (is => 'ro', isa => 'Str'); | |
| 7 | 1 | has ForwardingEnabled => (is => 'ro', isa => 'Bool', required => 1); | |
| 8 | 1 | has HeadersInBounceNotificationsEnabled => (is => 'ro', isa => 'Bool'); | |
| 9 | 1 | has HeadersInComplaintNotificationsEnabled => (is => 'ro', isa => 'Bool'); | |
| 10 | 1 | has HeadersInDeliveryNotificationsEnabled => (is => 'ro', isa => 'Bool'); | |
| 11 | |||
| 12 | 1 | 1; | |
| 13 | |||
| 14 | ### main pod documentation begin ### | ||
| 15 | |||
| 16 | =head1 NAME | ||
| 17 | |||
| 18 | Paws::SES::IdentityNotificationAttributes | ||
| 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::SES::IdentityNotificationAttributes object: | ||
| 30 | |||
| 31 | $service_obj->Method(Att1 => { BounceTopic => $value, ..., HeadersInDeliveryNotificationsEnabled => $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::SES::IdentityNotificationAttributes object: | ||
| 36 | |||
| 37 | $result = $service_obj->Method(...); | ||
| 38 | $result->Att1->BounceTopic | ||
| 39 | |||
| 40 | =head1 DESCRIPTION | ||
| 41 | |||
| 42 | Represents the notification attributes of an identity, including | ||
| 43 | whether an identity has Amazon Simple Notification Service (Amazon SNS) | ||
| 44 | topics set for bounce, complaint, and/or delivery notifications, and | ||
| 45 | whether feedback forwarding is enabled for bounce and complaint | ||
| 46 | notifications. | ||
| 47 | |||
| 48 | =head1 ATTRIBUTES | ||
| 49 | |||
| 50 | |||
| 51 | =head2 BounceTopic => Str | ||
| 52 | |||
| 53 | The Amazon Resource Name (ARN) of the Amazon SNS topic where Amazon SES | ||
| 54 | will publish bounce notifications. | ||
| 55 | |||
| 56 | |||
| 57 | =head2 ComplaintTopic => Str | ||
| 58 | |||
| 59 | The Amazon Resource Name (ARN) of the Amazon SNS topic where Amazon SES | ||
| 60 | will publish complaint notifications. | ||
| 61 | |||
| 62 | |||
| 63 | =head2 DeliveryTopic => Str | ||
| 64 | |||
| 65 | The Amazon Resource Name (ARN) of the Amazon SNS topic where Amazon SES | ||
| 66 | will publish delivery notifications. | ||
| 67 | |||
| 68 | |||
| 69 | =head2 B<REQUIRED> ForwardingEnabled => Bool | ||
| 70 | |||
| 71 | Describes whether Amazon SES will forward bounce and complaint | ||
| 72 | notifications as email. C<true> indicates that Amazon SES will forward | ||
| 73 | bounce and complaint notifications as email, while C<false> indicates | ||
| 74 | that bounce and complaint notifications will be published only to the | ||
| 75 | specified bounce and complaint Amazon SNS topics. | ||
| 76 | |||
| 77 | |||
| 78 | =head2 HeadersInBounceNotificationsEnabled => Bool | ||
| 79 | |||
| 80 | Describes whether Amazon SES includes the original email headers in | ||
| 81 | Amazon SNS notifications of type C<Bounce>. A value of C<true> | ||
| 82 | specifies that Amazon SES will include headers in bounce notifications, | ||
| 83 | and a value of C<false> specifies that Amazon SES will not include | ||
| 84 | headers in bounce notifications. | ||
| 85 | |||
| 86 | |||
| 87 | =head2 HeadersInComplaintNotificationsEnabled => Bool | ||
| 88 | |||
| 89 | Describes whether Amazon SES includes the original email headers in | ||
| 90 | Amazon SNS notifications of type C<Complaint>. A value of C<true> | ||
| 91 | specifies that Amazon SES will include headers in complaint | ||
| 92 | notifications, and a value of C<false> specifies that Amazon SES will | ||
| 93 | not include headers in complaint notifications. | ||
| 94 | |||
| 95 | |||
| 96 | =head2 HeadersInDeliveryNotificationsEnabled => Bool | ||
| 97 | |||
| 98 | Describes whether Amazon SES includes the original email headers in | ||
| 99 | Amazon SNS notifications of type C<Delivery>. A value of C<true> | ||
| 100 | specifies that Amazon SES will include headers in delivery | ||
| 101 | notifications, and a value of C<false> specifies that Amazon SES will | ||
| 102 | not include headers in delivery notifications. | ||
| 103 | |||
| 104 | |||
| 105 | |||
| 106 | =head1 SEE ALSO | ||
| 107 | |||
| 108 | This class forms part of L<Paws>, describing an object used in L<Paws::SES> | ||
| 109 | |||
| 110 | =head1 BUGS and CONTRIBUTIONS | ||
| 111 | |||
| 112 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 113 | |||
| 114 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 115 | |||
| 116 | =cut | ||
| 117 | |||