« blib/lib/Paws/SESv2/CreateDedicatedIpPoolResponse.pm
↑ Summary
blib/lib/Paws/SESv2/CreateDeliverabilityTestReportResponse.pm »
| 1 | |||
| 2 | package Paws::SESv2::CreateDeliverabilityTestReport; | ||
| 3 | use Moose; | ||
| 4 | has Content => (is => 'ro', isa => 'Paws::SESv2::EmailContent', required => 1); | ||
| 5 | has FromEmailAddress => (is => 'ro', isa => 'Str', required => 1); | ||
| 6 | has ReportName => (is => 'ro', isa => 'Str'); | ||
| 7 | has Tags => (is => 'ro', isa => 'ArrayRef[Paws::SESv2::Tag]'); | ||
| 8 | |||
| 9 | use MooseX::ClassAttribute; | ||
| 10 | |||
| 11 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateDeliverabilityTestReport'); | ||
| 12 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/v2/email/deliverability-dashboard/test'); | ||
| 13 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST'); | ||
| 14 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::SESv2::CreateDeliverabilityTestReportResponse'); | ||
| 15 | 1; | ||
| 16 | |||
| 17 | ### main pod documentation begin ### | ||
| 18 | |||
| 19 | =head1 NAME | ||
| 20 | |||
| 21 | Paws::SESv2::CreateDeliverabilityTestReport - Arguments for method CreateDeliverabilityTestReport on L<Paws::SESv2> | ||
| 22 | |||
| 23 | =head1 DESCRIPTION | ||
| 24 | |||
| 25 | This class represents the parameters used for calling the method CreateDeliverabilityTestReport on the | ||
| 26 | L<Amazon Simple Email Service|Paws::SESv2> service. Use the attributes of this class | ||
| 27 | as arguments to method CreateDeliverabilityTestReport. | ||
| 28 | |||
| 29 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateDeliverabilityTestReport. | ||
| 30 | |||
| 31 | =head1 SYNOPSIS | ||
| 32 | |||
| 33 | my $email = Paws->service('SESv2'); | ||
| 34 | my $CreateDeliverabilityTestReportResponse = | ||
| 35 | $email->CreateDeliverabilityTestReport( | ||
| 36 | Content => { | ||
| 37 | Raw => { | ||
| 38 | Data => 'BlobRawMessageData', | ||
| 39 | |||
| 40 | }, # OPTIONAL | ||
| 41 | Simple => { | ||
| 42 | Body => { | ||
| 43 | Html => { | ||
| 44 | Data => 'MyMessageData', | ||
| 45 | Charset => 'MyCharset', # OPTIONAL | ||
| 46 | }, # OPTIONAL | ||
| 47 | Text => { | ||
| 48 | Data => 'MyMessageData', | ||
| 49 | Charset => 'MyCharset', # OPTIONAL | ||
| 50 | }, # OPTIONAL | ||
| 51 | }, | ||
| 52 | Subject => { | ||
| 53 | Data => 'MyMessageData', | ||
| 54 | Charset => 'MyCharset', # OPTIONAL | ||
| 55 | }, # OPTIONAL | ||
| 56 | |||
| 57 | }, # OPTIONAL | ||
| 58 | Template => { | ||
| 59 | TemplateArn => 'MyAmazonResourceName', # OPTIONAL | ||
| 60 | TemplateData => 'MyEmailTemplateData', # max: 262144; OPTIONAL | ||
| 61 | TemplateName => 'MyEmailTemplateName', # min: 1; OPTIONAL | ||
| 62 | }, # OPTIONAL | ||
| 63 | }, | ||
| 64 | FromEmailAddress => 'MyEmailAddress', | ||
| 65 | ReportName => 'MyReportName', # OPTIONAL | ||
| 66 | Tags => [ | ||
| 67 | { | ||
| 68 | Key => 'MyTagKey', | ||
| 69 | Value => 'MyTagValue', | ||
| 70 | |||
| 71 | }, | ||
| 72 | ... | ||
| 73 | ], # OPTIONAL | ||
| 74 | ); | ||
| 75 | |||
| 76 | # Results: | ||
| 77 | my $DeliverabilityTestStatus = | ||
| 78 | $CreateDeliverabilityTestReportResponse->DeliverabilityTestStatus; | ||
| 79 | my $ReportId = $CreateDeliverabilityTestReportResponse->ReportId; | ||
| 80 | |||
| 81 | # Returns a L<Paws::SESv2::CreateDeliverabilityTestReportResponse> object. | ||
| 82 | |||
| 83 | Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. | ||
| 84 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/email/CreateDeliverabilityTestReport> | ||
| 85 | |||
| 86 | =head1 ATTRIBUTES | ||
| 87 | |||
| 88 | |||
| 89 | =head2 B<REQUIRED> Content => L<Paws::SESv2::EmailContent> | ||
| 90 | |||
| 91 | The HTML body of the message that you sent when you performed the | ||
| 92 | predictive inbox placement test. | ||
| 93 | |||
| 94 | |||
| 95 | |||
| 96 | =head2 B<REQUIRED> FromEmailAddress => Str | ||
| 97 | |||
| 98 | The email address that the predictive inbox placement test email was | ||
| 99 | sent from. | ||
| 100 | |||
| 101 | |||
| 102 | |||
| 103 | =head2 ReportName => Str | ||
| 104 | |||
| 105 | A unique name that helps you to identify the predictive inbox placement | ||
| 106 | test when you retrieve the results. | ||
| 107 | |||
| 108 | |||
| 109 | |||
| 110 | =head2 Tags => ArrayRef[L<Paws::SESv2::Tag>] | ||
| 111 | |||
| 112 | An array of objects that define the tags (keys and values) that you | ||
| 113 | want to associate with the predictive inbox placement test. | ||
| 114 | |||
| 115 | |||
| 116 | |||
| 117 | |||
| 118 | =head1 SEE ALSO | ||
| 119 | |||
| 120 | This class forms part of L<Paws>, documenting arguments for method CreateDeliverabilityTestReport in L<Paws::SESv2> | ||
| 121 | |||
| 122 | =head1 BUGS and CONTRIBUTIONS | ||
| 123 | |||
| 124 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 125 | |||
| 126 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 127 | |||
| 128 | =cut | ||
| 129 |