/
types.go
1556 lines (1237 loc) · 52 KB
/
types.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// Code generated by smithy-go-codegen DO NOT EDIT.
package types
import (
smithydocument "github.com/aws/smithy-go/document"
"time"
)
// An object that contains information about your account details.
type AccountDetails struct {
// Additional email addresses where updates are sent about your account review
// process.
AdditionalContactEmailAddresses []string
// The language you would prefer for the case. The contact language can be one of
// ENGLISH or JAPANESE.
ContactLanguage ContactLanguage
// The type of email your account is sending. The mail type can be one of the
// following:
//
// * MARKETING – Most of your sending traffic is to keep your customers
// informed of your latest offering.
//
// * TRANSACTIONAL – Most of your sending
// traffic is to communicate during a transaction with a customer.
MailType MailType
// Information about the review of the latest details you submitted.
ReviewDetails *ReviewDetails
// A description of the types of email that you plan to send.
UseCaseDescription *string
// The URL of your website. This information helps us better understand the type of
// content that you plan to send.
WebsiteURL *string
noSmithyDocumentSerde
}
// An object that contains information about a blacklisting event that impacts one
// of the dedicated IP addresses that is associated with your account.
type BlacklistEntry struct {
// Additional information about the blacklisting event, as provided by the
// blacklist maintainer.
Description *string
// The time when the blacklisting event occurred, shown in Unix time format.
ListingTime *time.Time
// The name of the blacklist that the IP address appears on.
RblName *string
noSmithyDocumentSerde
}
// Represents the body of the email message.
type Body struct {
// An object that represents the version of the message that is displayed in email
// clients that support HTML. HTML messages can include formatted text, hyperlinks,
// images, and more.
Html *Content
// An object that represents the version of the message that is displayed in email
// clients that don't support HTML, or clients where the recipient has disabled
// HTML rendering.
Text *Content
noSmithyDocumentSerde
}
// An object that contains the body of the message. You can specify a template
// message.
type BulkEmailContent struct {
// The template to use for the bulk email message.
Template *Template
noSmithyDocumentSerde
}
type BulkEmailEntry struct {
// Represents the destination of the message, consisting of To:, CC:, and BCC:
// fields. Amazon SES does not support the SMTPUTF8 extension, as described in
// RFC6531 (https://tools.ietf.org/html/rfc6531). For this reason, the local part
// of a destination email address (the part of the email address that precedes the
// @ sign) may only contain 7-bit ASCII characters
// (https://en.wikipedia.org/wiki/Email_address#Local-part). If the domain part of
// an address (the part after the @ sign) contains non-ASCII characters, they must
// be encoded using Punycode, as described in RFC3492
// (https://tools.ietf.org/html/rfc3492.html).
//
// This member is required.
Destination *Destination
// The ReplacementEmailContent associated with a BulkEmailEntry.
ReplacementEmailContent *ReplacementEmailContent
// A list of tags, in the form of name/value pairs, to apply to an email that you
// send using the SendBulkTemplatedEmail operation. Tags correspond to
// characteristics of the email that you define, so that you can publish email
// sending events.
ReplacementTags []MessageTag
noSmithyDocumentSerde
}
// The result of the SendBulkEmail operation of each specified BulkEmailEntry.
type BulkEmailEntryResult struct {
// A description of an error that prevented a message being sent using the
// SendBulkTemplatedEmail operation.
Error *string
// The unique message identifier returned from the SendBulkTemplatedEmail
// operation.
MessageId *string
// The status of a message sent using the SendBulkTemplatedEmail operation.
// Possible values for this parameter include:
//
// * SUCCESS: Amazon SES accepted the
// message, and will attempt to deliver it to the recipients.
//
// * MESSAGE_REJECTED:
// The message was rejected because it contained a virus.
//
// *
// MAIL_FROM_DOMAIN_NOT_VERIFIED: The sender's email address or domain was not
// verified.
//
// * CONFIGURATION_SET_DOES_NOT_EXIST: The configuration set you
// specified does not exist.
//
// * TEMPLATE_DOES_NOT_EXIST: The template you specified
// does not exist.
//
// * ACCOUNT_SUSPENDED: Your account has been shut down because of
// issues related to your email sending practices.
//
// * ACCOUNT_THROTTLED: The number
// of emails you can send has been reduced because your account has exceeded its
// allocated sending limit.
//
// * ACCOUNT_DAILY_QUOTA_EXCEEDED: You have reached or
// exceeded the maximum number of emails you can send from your account in a
// 24-hour period.
//
// * INVALID_SENDING_POOL_NAME: The configuration set you
// specified refers to an IP pool that does not exist.
//
// * ACCOUNT_SENDING_PAUSED:
// Email sending for the Amazon SES account was disabled using the
// UpdateAccountSendingEnabled
// (https://docs.aws.amazon.com/ses/latest/APIReference/API_UpdateAccountSendingEnabled.html)
// operation.
//
// * CONFIGURATION_SET_SENDING_PAUSED: Email sending for this
// configuration set was disabled using the UpdateConfigurationSetSendingEnabled
// (https://docs.aws.amazon.com/ses/latest/APIReference/API_UpdateConfigurationSetSendingEnabled.html)
// operation.
//
// * INVALID_PARAMETER_VALUE: One or more of the parameters you
// specified when calling this operation was invalid. See the error message for
// additional information.
//
// * TRANSIENT_FAILURE: Amazon SES was unable to process
// your request because of a temporary issue.
//
// * FAILED: Amazon SES was unable to
// process your request. See the error message for additional information.
Status BulkEmailStatus
noSmithyDocumentSerde
}
// An object that defines an Amazon CloudWatch destination for email events. You
// can use Amazon CloudWatch to monitor and gain insights on your email sending
// metrics.
type CloudWatchDestination struct {
// An array of objects that define the dimensions to use when you send email events
// to Amazon CloudWatch.
//
// This member is required.
DimensionConfigurations []CloudWatchDimensionConfiguration
noSmithyDocumentSerde
}
// An object that defines the dimension configuration to use when you send email
// events to Amazon CloudWatch.
type CloudWatchDimensionConfiguration struct {
// The default value of the dimension that is published to Amazon CloudWatch if you
// don't provide the value of the dimension when you send an email. This value has
// to meet the following criteria:
//
// * It can only contain ASCII letters (a–z, A–Z),
// numbers (0–9), underscores (_), or dashes (-).
//
// * It can contain no more than
// 256 characters.
//
// This member is required.
DefaultDimensionValue *string
// The name of an Amazon CloudWatch dimension associated with an email sending
// metric. The name has to meet the following criteria:
//
// * It can only contain
// ASCII letters (a–z, A–Z), numbers (0–9), underscores (_), or dashes (-).
//
// * It
// can contain no more than 256 characters.
//
// This member is required.
DimensionName *string
// The location where the Amazon SES API v2 finds the value of a dimension to
// publish to Amazon CloudWatch. If you want to use the message tags that you
// specify using an X-SES-MESSAGE-TAGS header or a parameter to the SendEmail or
// SendRawEmail API, choose messageTag. If you want to use your own email headers,
// choose emailHeader. If you want to use link tags, choose linkTags.
//
// This member is required.
DimensionValueSource DimensionValueSource
noSmithyDocumentSerde
}
// A contact is the end-user who is receiving the email.
type Contact struct {
// The contact's email address.
EmailAddress *string
// A timestamp noting the last time the contact's information was updated.
LastUpdatedTimestamp *time.Time
// The default topic preferences applied to the contact.
TopicDefaultPreferences []TopicPreference
// The contact's preference for being opted-in to or opted-out of a topic.
TopicPreferences []TopicPreference
// A boolean value status noting if the contact is unsubscribed from all contact
// list topics.
UnsubscribeAll bool
noSmithyDocumentSerde
}
// A list that contains contacts that have subscribed to a particular topic or
// topics.
type ContactList struct {
// The name of the contact list.
ContactListName *string
// A timestamp noting the last time the contact list was updated.
LastUpdatedTimestamp *time.Time
noSmithyDocumentSerde
}
// An object that contains details about the action of a contact list.
type ContactListDestination struct {
// >The type of action that you want to perform on the addresses. Acceptable
// values:
//
// * PUT: add the addresses to the contact list. If the record already
// exists, it will override it with the new value.
//
// * DELETE: remove the addresses
// from the contact list.
//
// This member is required.
ContactListImportAction ContactListImportAction
// The name of the contact list.
//
// This member is required.
ContactListName *string
noSmithyDocumentSerde
}
// An object that represents the content of the email, and optionally a character
// set specification.
type Content struct {
// The content of the message itself.
//
// This member is required.
Data *string
// The character set for the content. Because of the constraints of the SMTP
// protocol, Amazon SES uses 7-bit ASCII by default. If the text includes
// characters outside of the ASCII range, you have to specify a character set. For
// example, you could specify UTF-8, ISO-8859-1, or Shift_JIS.
Charset *string
noSmithyDocumentSerde
}
// Contains information about a custom verification email template.
type CustomVerificationEmailTemplateMetadata struct {
// The URL that the recipient of the verification email is sent to if his or her
// address is not successfully verified.
FailureRedirectionURL *string
// The email address that the custom verification email is sent from.
FromEmailAddress *string
// The URL that the recipient of the verification email is sent to if his or her
// address is successfully verified.
SuccessRedirectionURL *string
// The name of the custom verification email template.
TemplateName *string
// The subject line of the custom verification email.
TemplateSubject *string
noSmithyDocumentSerde
}
// An object that contains information about the volume of email sent on each day
// of the analysis period.
type DailyVolume struct {
// An object that contains inbox placement metrics for a specified day in the
// analysis period, broken out by the recipient's email provider.
DomainIspPlacements []DomainIspPlacement
// The date that the DailyVolume metrics apply to, in Unix time.
StartDate *time.Time
// An object that contains inbox placement metrics for a specific day in the
// analysis period.
VolumeStatistics *VolumeStatistics
noSmithyDocumentSerde
}
// Contains information about a dedicated IP address that is associated with your
// Amazon SES account. To learn more about requesting dedicated IP addresses, see
// Requesting and Relinquishing Dedicated IP Addresses
// (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/dedicated-ip-case.html)
// in the Amazon SES Developer Guide.
type DedicatedIp struct {
// An IPv4 address.
//
// This member is required.
Ip *string
// Indicates how complete the dedicated IP warm-up process is. When this value
// equals 1, the address has completed the warm-up process and is ready for use.
//
// This member is required.
WarmupPercentage *int32
// The warm-up status of a dedicated IP address. The status can have one of the
// following values:
//
// * IN_PROGRESS – The IP address isn't ready to use because the
// dedicated IP warm-up process is ongoing.
//
// * DONE – The dedicated IP warm-up
// process is complete, and the IP address is ready to use.
//
// This member is required.
WarmupStatus WarmupStatus
// The name of the dedicated IP pool that the IP address is associated with.
PoolName *string
noSmithyDocumentSerde
}
// An object that contains metadata related to a predictive inbox placement test.
type DeliverabilityTestReport struct {
// The date and time when the predictive inbox placement test was created, in Unix
// time format.
CreateDate *time.Time
// The status of the predictive inbox placement test. If the status is IN_PROGRESS,
// then the predictive inbox placement test is currently running. Predictive inbox
// placement tests are usually complete within 24 hours of creating the test. If
// the status is COMPLETE, then the test is finished, and you can use the
// GetDeliverabilityTestReport to view the results of the test.
DeliverabilityTestStatus DeliverabilityTestStatus
// The sender address that you specified for the predictive inbox placement test.
FromEmailAddress *string
// A unique string that identifies the predictive inbox placement test.
ReportId *string
// A name that helps you identify a predictive inbox placement test report.
ReportName *string
// The subject line for an email that you submitted in a predictive inbox placement
// test.
Subject *string
noSmithyDocumentSerde
}
// Used to associate a configuration set with a dedicated IP pool.
type DeliveryOptions struct {
// The name of the dedicated IP pool that you want to associate with the
// configuration set.
SendingPoolName *string
// Specifies whether messages that use the configuration set are required to use
// Transport Layer Security (TLS). If the value is Require, messages are only
// delivered if a TLS connection can be established. If the value is Optional,
// messages can be delivered in plain text if a TLS connection can't be
// established.
TlsPolicy TlsPolicy
noSmithyDocumentSerde
}
// An object that describes the recipients for an email.
type Destination struct {
// An array that contains the email addresses of the "BCC" (blind carbon copy)
// recipients for the email.
BccAddresses []string
// An array that contains the email addresses of the "CC" (carbon copy) recipients
// for the email.
CcAddresses []string
// An array that contains the email addresses of the "To" recipients for the email.
ToAddresses []string
noSmithyDocumentSerde
}
// An object that contains information about the DKIM authentication status for an
// email identity. Amazon SES determines the authentication status by searching for
// specific records in the DNS configuration for the domain. If you used Easy DKIM
// (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/easy-dkim.html) to set up
// DKIM authentication, Amazon SES tries to find three unique CNAME records in the
// DNS configuration for your domain. If you provided a public key to perform DKIM
// authentication, Amazon SES tries to find a TXT record that uses the selector
// that you specified. The value of the TXT record must be a public key that's
// paired with the private key that you specified in the process of creating the
// identity
type DkimAttributes struct {
// A string that indicates how DKIM was configured for the identity. There are two
// possible values:
//
// * AWS_SES – Indicates that DKIM was configured for the
// identity by using Easy DKIM
// (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/easy-dkim.html).
//
// *
// EXTERNAL – Indicates that DKIM was configured for the identity by using Bring
// Your Own DKIM (BYODKIM).
SigningAttributesOrigin DkimSigningAttributesOrigin
// If the value is true, then the messages that you send from the identity are
// signed using DKIM. If the value is false, then the messages that you send from
// the identity aren't DKIM-signed.
SigningEnabled bool
// Describes whether or not Amazon SES has successfully located the DKIM records in
// the DNS records for the domain. The status can be one of the following:
//
// *
// PENDING – The verification process was initiated, but Amazon SES hasn't yet
// detected the DKIM records in the DNS configuration for the domain.
//
// * SUCCESS –
// The verification process completed successfully.
//
// * FAILED – The verification
// process failed. This typically occurs when Amazon SES fails to find the DKIM
// records in the DNS configuration of the domain.
//
// * TEMPORARY_FAILURE – A
// temporary issue is preventing Amazon SES from determining the DKIM
// authentication status of the domain.
//
// * NOT_STARTED – The DKIM verification
// process hasn't been initiated for the domain.
Status DkimStatus
// If you used Easy DKIM
// (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/easy-dkim.html) to
// configure DKIM authentication for the domain, then this object contains a set of
// unique strings that you use to create a set of CNAME records that you add to the
// DNS configuration for your domain. When Amazon SES detects these records in the
// DNS configuration for your domain, the DKIM authentication process is complete.
// If you configured DKIM authentication for the domain by providing your own
// public-private key pair, then this object contains the selector for the public
// key. Regardless of the DKIM authentication method you use, Amazon SES searches
// for the appropriate records in the DNS configuration of the domain for up to 72
// hours.
Tokens []string
noSmithyDocumentSerde
}
// An object that contains information about the tokens used for setting up Bring
// Your Own DKIM (BYODKIM).
type DkimSigningAttributes struct {
// A private key that's used to generate a DKIM signature. The private key must use
// 1024-bit RSA encryption, and must be encoded using base64 encoding.
//
// This member is required.
DomainSigningPrivateKey *string
// A string that's used to identify a public key in the DNS configuration for a
// domain.
//
// This member is required.
DomainSigningSelector *string
noSmithyDocumentSerde
}
// An object that contains the deliverability data for a specific campaign. This
// data is available for a campaign only if the campaign sent email by using a
// domain that the Deliverability dashboard is enabled for
// (PutDeliverabilityDashboardOption operation).
type DomainDeliverabilityCampaign struct {
// The unique identifier for the campaign. The Deliverability dashboard
// automatically generates and assigns this identifier to a campaign.
CampaignId *string
// The percentage of email messages that were deleted by recipients, without being
// opened first. Due to technical limitations, this value only includes recipients
// who opened the message by using an email client that supports images.
DeleteRate *float64
// The major email providers who handled the email message.
Esps []string
// The first time, in Unix time format, when the email message was delivered to any
// recipient's inbox. This value can help you determine how long it took for a
// campaign to deliver an email message.
FirstSeenDateTime *time.Time
// The verified email address that the email message was sent from.
FromAddress *string
// The URL of an image that contains a snapshot of the email message that was sent.
ImageUrl *string
// The number of email messages that were delivered to recipients’ inboxes.
InboxCount *int64
// The last time, in Unix time format, when the email message was delivered to any
// recipient's inbox. This value can help you determine how long it took for a
// campaign to deliver an email message.
LastSeenDateTime *time.Time
// The projected number of recipients that the email message was sent to.
ProjectedVolume *int64
// The percentage of email messages that were opened and then deleted by
// recipients. Due to technical limitations, this value only includes recipients
// who opened the message by using an email client that supports images.
ReadDeleteRate *float64
// The percentage of email messages that were opened by recipients. Due to
// technical limitations, this value only includes recipients who opened the
// message by using an email client that supports images.
ReadRate *float64
// The IP addresses that were used to send the email message.
SendingIps []string
// The number of email messages that were delivered to recipients' spam or junk
// mail folders.
SpamCount *int64
// The subject line, or title, of the email message.
Subject *string
noSmithyDocumentSerde
}
// An object that contains information about the Deliverability dashboard
// subscription for a verified domain that you use to send email and currently has
// an active Deliverability dashboard subscription. If a Deliverability dashboard
// subscription is active for a domain, you gain access to reputation, inbox
// placement, and other metrics for the domain.
type DomainDeliverabilityTrackingOption struct {
// A verified domain that’s associated with your AWS account and currently has an
// active Deliverability dashboard subscription.
Domain *string
// An object that contains information about the inbox placement data settings for
// the domain.
InboxPlacementTrackingOption *InboxPlacementTrackingOption
// The date, in Unix time format, when you enabled the Deliverability dashboard for
// the domain.
SubscriptionStartDate *time.Time
noSmithyDocumentSerde
}
// An object that contains inbox placement data for email sent from one of your
// email domains to a specific email provider.
type DomainIspPlacement struct {
// The percentage of messages that were sent from the selected domain to the
// specified email provider that arrived in recipients' inboxes.
InboxPercentage *float64
// The total number of messages that were sent from the selected domain to the
// specified email provider that arrived in recipients' inboxes.
InboxRawCount *int64
// The name of the email provider that the inbox placement data applies to.
IspName *string
// The percentage of messages that were sent from the selected domain to the
// specified email provider that arrived in recipients' spam or junk mail folders.
SpamPercentage *float64
// The total number of messages that were sent from the selected domain to the
// specified email provider that arrived in recipients' spam or junk mail folders.
SpamRawCount *int64
noSmithyDocumentSerde
}
// An object that defines the entire content of the email, including the message
// headers and the body content. You can create a simple email message, in which
// you specify the subject and the text and HTML versions of the message body. You
// can also create raw messages, in which you specify a complete MIME-formatted
// message. Raw messages can include attachments and custom headers.
type EmailContent struct {
// The raw email message. The message has to meet the following criteria:
//
// * The
// message has to contain a header and a body, separated by one blank line.
//
// * All
// of the required header fields must be present in the message.
//
// * Each part of a
// multipart MIME message must be formatted properly.
//
// * If you include
// attachments, they must be in a file format that the Amazon SES API v2
// supports.
//
// * The entire message must be Base64 encoded.
//
// * If any of the MIME
// parts in your message contain content that is outside of the 7-bit ASCII
// character range, you should encode that content to ensure that recipients' email
// clients render the message properly.
//
// * The length of any single line of text in
// the message can't exceed 1,000 characters. This restriction is defined in RFC
// 5321 (https://tools.ietf.org/html/rfc5321).
Raw *RawMessage
// The simple email message. The message consists of a subject and a message body.
Simple *Message
// The template to use for the email message.
Template *Template
noSmithyDocumentSerde
}
// The content of the email, composed of a subject line, an HTML part, and a
// text-only part.
type EmailTemplateContent struct {
// The HTML body of the email.
Html *string
// The subject line of the email.
Subject *string
// The email body that will be visible to recipients whose email clients do not
// display HTML.
Text *string
noSmithyDocumentSerde
}
// Contains information about an email template.
type EmailTemplateMetadata struct {
// The time and date the template was created.
CreatedTimestamp *time.Time
// The name of the template.
TemplateName *string
noSmithyDocumentSerde
}
// In the Amazon SES API v2, events include message sends, deliveries, opens,
// clicks, bounces, complaints and delivery delays. Event destinations are places
// that you can send information about these events to. For example, you can send
// event data to Amazon SNS to receive notifications when you receive bounces or
// complaints, or you can use Amazon Kinesis Data Firehose to stream data to Amazon
// S3 for long-term storage.
type EventDestination struct {
// The types of events that Amazon SES sends to the specified event destinations.
//
// This member is required.
MatchingEventTypes []EventType
// A name that identifies the event destination.
//
// This member is required.
Name *string
// An object that defines an Amazon CloudWatch destination for email events. You
// can use Amazon CloudWatch to monitor and gain insights on your email sending
// metrics.
CloudWatchDestination *CloudWatchDestination
// If true, the event destination is enabled. When the event destination is
// enabled, the specified event types are sent to the destinations in this
// EventDestinationDefinition. If false, the event destination is disabled. When
// the event destination is disabled, events aren't sent to the specified
// destinations.
Enabled bool
// An object that defines an Amazon Kinesis Data Firehose destination for email
// events. You can use Amazon Kinesis Data Firehose to stream data to other
// services, such as Amazon S3 and Amazon Redshift.
KinesisFirehoseDestination *KinesisFirehoseDestination
// An object that defines an Amazon Pinpoint project destination for email events.
// You can send email event data to a Amazon Pinpoint project to view metrics using
// the Transactional Messaging dashboards that are built in to Amazon Pinpoint. For
// more information, see Transactional Messaging Charts
// (https://docs.aws.amazon.com/pinpoint/latest/userguide/analytics-transactional-messages.html)
// in the Amazon Pinpoint User Guide.
PinpointDestination *PinpointDestination
// An object that defines an Amazon SNS destination for email events. You can use
// Amazon SNS to send notification when certain email events occur.
SnsDestination *SnsDestination
noSmithyDocumentSerde
}
// An object that defines the event destination. Specifically, it defines which
// services receive events from emails sent using the configuration set that the
// event destination is associated with. Also defines the types of events that are
// sent to the event destination.
type EventDestinationDefinition struct {
// An object that defines an Amazon CloudWatch destination for email events. You
// can use Amazon CloudWatch to monitor and gain insights on your email sending
// metrics.
CloudWatchDestination *CloudWatchDestination
// If true, the event destination is enabled. When the event destination is
// enabled, the specified event types are sent to the destinations in this
// EventDestinationDefinition. If false, the event destination is disabled. When
// the event destination is disabled, events aren't sent to the specified
// destinations.
Enabled bool
// An object that defines an Amazon Kinesis Data Firehose destination for email
// events. You can use Amazon Kinesis Data Firehose to stream data to other
// services, such as Amazon S3 and Amazon Redshift.
KinesisFirehoseDestination *KinesisFirehoseDestination
// An array that specifies which events the Amazon SES API v2 should send to the
// destinations in this EventDestinationDefinition.
MatchingEventTypes []EventType
// An object that defines an Amazon Pinpoint project destination for email events.
// You can send email event data to a Amazon Pinpoint project to view metrics using
// the Transactional Messaging dashboards that are built in to Amazon Pinpoint. For
// more information, see Transactional Messaging Charts
// (https://docs.aws.amazon.com/pinpoint/latest/userguide/analytics-transactional-messages.html)
// in the Amazon Pinpoint User Guide.
PinpointDestination *PinpointDestination
// An object that defines an Amazon SNS destination for email events. You can use
// Amazon SNS to send notification when certain email events occur.
SnsDestination *SnsDestination
noSmithyDocumentSerde
}
// An object that contains the failure details about an import job.
type FailureInfo struct {
// A message about why the import job failed.
ErrorMessage *string
// An Amazon S3 presigned URL that contains all the failed records and related
// information.
FailedRecordsS3Url *string
noSmithyDocumentSerde
}
// Information about an email identity.
type IdentityInfo struct {
// The address or domain of the identity.
IdentityName *string
// The email identity type. The identity type can be one of the following:
//
// *
// EMAIL_ADDRESS – The identity is an email address.
//
// * DOMAIN – The identity is a
// domain.
//
// * MANAGED_DOMAIN – The identity is a domain that is managed by AWS.
IdentityType IdentityType
// Indicates whether or not you can send email from the identity. An identity is an
// email address or domain that you send email from. Before you can send email from
// an identity, you have to demostrate that you own the identity, and that you
// authorize Amazon SES to send email from that identity.
SendingEnabled bool
noSmithyDocumentSerde
}
// An object that contains details about the data source of the import job.
type ImportDataSource struct {
// The data format of the import job's data source.
//
// This member is required.
DataFormat DataFormat
// An Amazon S3 URL in the format s3:///.
//
// This member is required.
S3Url *string
noSmithyDocumentSerde
}
// An object that contains details about the resource destination the import job is
// going to target.
type ImportDestination struct {
// An object that contains the action of the import job towards a contact list.
ContactListDestination *ContactListDestination
// An object that contains the action of the import job towards suppression list.
SuppressionListDestination *SuppressionListDestination
noSmithyDocumentSerde
}
// A summary of the import job.
type ImportJobSummary struct {
// The date and time when the import job was created.
CreatedTimestamp *time.Time
// An object that contains details about the resource destination the import job is
// going to target.
ImportDestination *ImportDestination
// A string that represents the import job ID.
JobId *string
// The status of the import job.
JobStatus JobStatus
noSmithyDocumentSerde
}
// An object that contains information about the inbox placement data settings for
// a verified domain that’s associated with your AWS account. This data is
// available only if you enabled the Deliverability dashboard for the domain.
type InboxPlacementTrackingOption struct {
// Specifies whether inbox placement data is being tracked for the domain.
Global bool
// An array of strings, one for each major email provider that the inbox placement
// data applies to.
TrackedIsps []string
noSmithyDocumentSerde
}
// An object that describes how email sent during the predictive inbox placement
// test was handled by a certain email provider.
type IspPlacement struct {
// The name of the email provider that the inbox placement data applies to.
IspName *string
// An object that contains inbox placement metrics for a specific email provider.
PlacementStatistics *PlacementStatistics
noSmithyDocumentSerde
}
// An object that defines an Amazon Kinesis Data Firehose destination for email
// events. You can use Amazon Kinesis Data Firehose to stream data to other
// services, such as Amazon S3 and Amazon Redshift.
type KinesisFirehoseDestination struct {
// The Amazon Resource Name (ARN) of the Amazon Kinesis Data Firehose stream that
// the Amazon SES API v2 sends email events to.
//
// This member is required.
DeliveryStreamArn *string
// The Amazon Resource Name (ARN) of the IAM role that the Amazon SES API v2 uses
// to send email events to the Amazon Kinesis Data Firehose stream.
//
// This member is required.
IamRoleArn *string
noSmithyDocumentSerde
}
// A filter that can be applied to a list of contacts.
type ListContactsFilter struct {
// The status by which you are filtering: OPT_IN or OPT_OUT.
FilteredStatus SubscriptionStatus
// Used for filtering by a specific topic preference.
TopicFilter *TopicFilter
noSmithyDocumentSerde
}
// An object used to specify a list or topic to which an email belongs, which will
// be used when a contact chooses to unsubscribe.
type ListManagementOptions struct {
// The name of the contact list.
//
// This member is required.
ContactListName *string
// The name of the topic.
TopicName *string
noSmithyDocumentSerde
}
// A list of attributes that are associated with a MAIL FROM domain.
type MailFromAttributes struct {
// The action that you want to take if the required MX record can't be found when
// you send an email. When you set this value to UseDefaultValue, the mail is sent
// using amazonses.com as the MAIL FROM domain. When you set this value to
// RejectMessage, the Amazon SES API v2 returns a MailFromDomainNotVerified error,
// and doesn't attempt to deliver the email. These behaviors are taken when the
// custom MAIL FROM domain configuration is in the Pending, Failed, and
// TemporaryFailure states.
//
// This member is required.
BehaviorOnMxFailure BehaviorOnMxFailure
// The name of a domain that an email identity uses as a custom MAIL FROM domain.
//
// This member is required.
MailFromDomain *string
// The status of the MAIL FROM domain. This status can have the following
// values:
//
// * PENDING – Amazon SES hasn't started searching for the MX record