« blib/lib/Paws/Pinpoint/DirectMessageConfiguration.pm
↑ Summary
blib/lib/Paws/Pinpoint/EmailChannelResponse.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::Pinpoint::EmailChannelRequest; | ||
| 3 | use Moose; | ||
| 4 | has ConfigurationSet => (is => 'ro', isa => 'Str'); | ||
| 5 | has Enabled => (is => 'ro', isa => 'Bool'); | ||
| 6 | has FromAddress => (is => 'ro', isa => 'Str', required => 1); | ||
| 7 | has Identity => (is => 'ro', isa => 'Str', required => 1); | ||
| 8 | has RoleArn => (is => 'ro', isa => 'Str'); | ||
| 9 | |||
| 10 | 1; | ||
| 11 | |||
| 12 | ### main pod documentation begin ### | ||
| 13 | |||
| 14 | =head1 NAME | ||
| 15 | |||
| 16 | Paws::Pinpoint::EmailChannelRequest | ||
| 17 | |||
| 18 | =head1 USAGE | ||
| 19 | |||
| 20 | This class represents one of two things: | ||
| 21 | |||
| 22 | =head3 Arguments in a call to a service | ||
| 23 | |||
| 24 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 25 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 26 | |||
| 27 | As an example, if Att1 is expected to be a Paws::Pinpoint::EmailChannelRequest object: | ||
| 28 | |||
| 29 | $service_obj->Method(Att1 => { ConfigurationSet => $value, ..., RoleArn => $value }); | ||
| 30 | |||
| 31 | =head3 Results returned from an API call | ||
| 32 | |||
| 33 | Use accessors for each attribute. If Att1 is expected to be an Paws::Pinpoint::EmailChannelRequest object: | ||
| 34 | |||
| 35 | $result = $service_obj->Method(...); | ||
| 36 | $result->Att1->ConfigurationSet | ||
| 37 | |||
| 38 | =head1 DESCRIPTION | ||
| 39 | |||
| 40 | Specifies the status and settings of the email channel for an | ||
| 41 | application. | ||
| 42 | |||
| 43 | =head1 ATTRIBUTES | ||
| 44 | |||
| 45 | |||
| 46 | =head2 ConfigurationSet => Str | ||
| 47 | |||
| 48 | The Amazon SES configuration set | ||
| 49 | (https://docs.aws.amazon.com/ses/latest/APIReference/API_ConfigurationSet.html) | ||
| 50 | that you want to apply to messages that you send through the channel. | ||
| 51 | |||
| 52 | |||
| 53 | =head2 Enabled => Bool | ||
| 54 | |||
| 55 | Specifies whether to enable the email channel for the application. | ||
| 56 | |||
| 57 | |||
| 58 | =head2 B<REQUIRED> FromAddress => Str | ||
| 59 | |||
| 60 | The verified email address that you want to send email from when you | ||
| 61 | send email through the channel. | ||
| 62 | |||
| 63 | |||
| 64 | =head2 B<REQUIRED> Identity => Str | ||
| 65 | |||
| 66 | The Amazon Resource Name (ARN) of the identity, verified with Amazon | ||
| 67 | Simple Email Service (Amazon SES), that you want to use when you send | ||
| 68 | email through the channel. | ||
| 69 | |||
| 70 | |||
| 71 | =head2 RoleArn => Str | ||
| 72 | |||
| 73 | The ARN of the AWS Identity and Access Management (IAM) role that you | ||
| 74 | want Amazon Pinpoint to use when it submits email-related event data | ||
| 75 | for the channel. | ||
| 76 | |||
| 77 | |||
| 78 | |||
| 79 | =head1 SEE ALSO | ||
| 80 | |||
| 81 | This class forms part of L<Paws>, describing an object used in L<Paws::Pinpoint> | ||
| 82 | |||
| 83 | =head1 BUGS and CONTRIBUTIONS | ||
| 84 | |||
| 85 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 86 | |||
| 87 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 88 | |||
| 89 | =cut | ||
| 90 |