@aws-sdk/client-sesv2 3.379.1 → 3.382.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist-types/models/models_0.d.ts +549 -0
- package/package.json +5 -5
|
@@ -44,6 +44,7 @@ export type ReviewStatus = (typeof ReviewStatus)[keyof typeof ReviewStatus];
|
|
|
44
44
|
*/
|
|
45
45
|
export interface ReviewDetails {
|
|
46
46
|
/**
|
|
47
|
+
* @public
|
|
47
48
|
* <p>The status of the latest review of your account. The status can be one of the
|
|
48
49
|
* following:</p>
|
|
49
50
|
* <ul>
|
|
@@ -71,6 +72,7 @@ export interface ReviewDetails {
|
|
|
71
72
|
*/
|
|
72
73
|
Status?: ReviewStatus | string;
|
|
73
74
|
/**
|
|
75
|
+
* @public
|
|
74
76
|
* <p>The associated support center case ID (if any).</p>
|
|
75
77
|
*/
|
|
76
78
|
CaseId?: string;
|
|
@@ -81,6 +83,7 @@ export interface ReviewDetails {
|
|
|
81
83
|
*/
|
|
82
84
|
export interface AccountDetails {
|
|
83
85
|
/**
|
|
86
|
+
* @public
|
|
84
87
|
* <p>The type of email your account is sending. The mail type can be one of the
|
|
85
88
|
* following:</p>
|
|
86
89
|
* <ul>
|
|
@@ -98,25 +101,30 @@ export interface AccountDetails {
|
|
|
98
101
|
*/
|
|
99
102
|
MailType?: MailType | string;
|
|
100
103
|
/**
|
|
104
|
+
* @public
|
|
101
105
|
* <p>The URL of your website. This information helps us better understand the type of
|
|
102
106
|
* content that you plan to send.</p>
|
|
103
107
|
*/
|
|
104
108
|
WebsiteURL?: string;
|
|
105
109
|
/**
|
|
110
|
+
* @public
|
|
106
111
|
* <p>The language you would prefer for the case. The contact language can be one of
|
|
107
112
|
* <code>ENGLISH</code> or <code>JAPANESE</code>.</p>
|
|
108
113
|
*/
|
|
109
114
|
ContactLanguage?: ContactLanguage | string;
|
|
110
115
|
/**
|
|
116
|
+
* @public
|
|
111
117
|
* <p>A description of the types of email that you plan to send.</p>
|
|
112
118
|
*/
|
|
113
119
|
UseCaseDescription?: string;
|
|
114
120
|
/**
|
|
121
|
+
* @public
|
|
115
122
|
* <p>Additional email addresses where updates are sent about your account review
|
|
116
123
|
* process.</p>
|
|
117
124
|
*/
|
|
118
125
|
AdditionalContactEmailAddresses?: string[];
|
|
119
126
|
/**
|
|
127
|
+
* @public
|
|
120
128
|
* <p>Information about the review of the latest details you submitted.</p>
|
|
121
129
|
*/
|
|
122
130
|
ReviewDetails?: ReviewDetails;
|
|
@@ -208,15 +216,18 @@ export type MetricNamespace = (typeof MetricNamespace)[keyof typeof MetricNamesp
|
|
|
208
216
|
*/
|
|
209
217
|
export interface BatchGetMetricDataQuery {
|
|
210
218
|
/**
|
|
219
|
+
* @public
|
|
211
220
|
* <p>The query identifier.</p>
|
|
212
221
|
*/
|
|
213
222
|
Id: string | undefined;
|
|
214
223
|
/**
|
|
224
|
+
* @public
|
|
215
225
|
* <p>The query namespace - e.g. <code>VDM</code>
|
|
216
226
|
* </p>
|
|
217
227
|
*/
|
|
218
228
|
Namespace: MetricNamespace | string | undefined;
|
|
219
229
|
/**
|
|
230
|
+
* @public
|
|
220
231
|
* <p>The queried metric. This can be one of the following:</p>
|
|
221
232
|
* <ul>
|
|
222
233
|
* <li>
|
|
@@ -284,15 +295,18 @@ export interface BatchGetMetricDataQuery {
|
|
|
284
295
|
*/
|
|
285
296
|
Metric: Metric | string | undefined;
|
|
286
297
|
/**
|
|
298
|
+
* @public
|
|
287
299
|
* <p>An object that contains mapping between <code>MetricDimensionName</code>
|
|
288
300
|
* and <code>MetricDimensionValue</code> to filter metrics by.</p>
|
|
289
301
|
*/
|
|
290
302
|
Dimensions?: Record<string, string>;
|
|
291
303
|
/**
|
|
304
|
+
* @public
|
|
292
305
|
* <p>Represents the start date for the query interval.</p>
|
|
293
306
|
*/
|
|
294
307
|
StartDate: Date | undefined;
|
|
295
308
|
/**
|
|
309
|
+
* @public
|
|
296
310
|
* <p>Represents the end date for the query interval.</p>
|
|
297
311
|
*/
|
|
298
312
|
EndDate: Date | undefined;
|
|
@@ -303,6 +317,7 @@ export interface BatchGetMetricDataQuery {
|
|
|
303
317
|
*/
|
|
304
318
|
export interface BatchGetMetricDataRequest {
|
|
305
319
|
/**
|
|
320
|
+
* @public
|
|
306
321
|
* <p>A list of queries for metrics to be retrieved.</p>
|
|
307
322
|
*/
|
|
308
323
|
Queries: BatchGetMetricDataQuery[] | undefined;
|
|
@@ -325,10 +340,12 @@ export type QueryErrorCode = (typeof QueryErrorCode)[keyof typeof QueryErrorCode
|
|
|
325
340
|
*/
|
|
326
341
|
export interface MetricDataError {
|
|
327
342
|
/**
|
|
343
|
+
* @public
|
|
328
344
|
* <p>The query identifier.</p>
|
|
329
345
|
*/
|
|
330
346
|
Id?: string;
|
|
331
347
|
/**
|
|
348
|
+
* @public
|
|
332
349
|
* <p>The query error code. Can be one of:</p>
|
|
333
350
|
* <ul>
|
|
334
351
|
* <li>
|
|
@@ -344,6 +361,7 @@ export interface MetricDataError {
|
|
|
344
361
|
*/
|
|
345
362
|
Code?: QueryErrorCode | string;
|
|
346
363
|
/**
|
|
364
|
+
* @public
|
|
347
365
|
* <p>The error message associated with the current query error.</p>
|
|
348
366
|
*/
|
|
349
367
|
Message?: string;
|
|
@@ -354,14 +372,17 @@ export interface MetricDataError {
|
|
|
354
372
|
*/
|
|
355
373
|
export interface MetricDataResult {
|
|
356
374
|
/**
|
|
375
|
+
* @public
|
|
357
376
|
* <p>The query identifier.</p>
|
|
358
377
|
*/
|
|
359
378
|
Id?: string;
|
|
360
379
|
/**
|
|
380
|
+
* @public
|
|
361
381
|
* <p>A list of timestamps for the metric data results.</p>
|
|
362
382
|
*/
|
|
363
383
|
Timestamps?: Date[];
|
|
364
384
|
/**
|
|
385
|
+
* @public
|
|
365
386
|
* <p>A list of values (cumulative / sum) for the metric data results.</p>
|
|
366
387
|
*/
|
|
367
388
|
Values?: number[];
|
|
@@ -372,10 +393,12 @@ export interface MetricDataResult {
|
|
|
372
393
|
*/
|
|
373
394
|
export interface BatchGetMetricDataResponse {
|
|
374
395
|
/**
|
|
396
|
+
* @public
|
|
375
397
|
* <p>A list of successfully retrieved <code>MetricDataResult</code>.</p>
|
|
376
398
|
*/
|
|
377
399
|
Results?: MetricDataResult[];
|
|
378
400
|
/**
|
|
401
|
+
* @public
|
|
379
402
|
* <p>A list of <code>MetricDataError</code> encountered while processing your metric data batch request.</p>
|
|
380
403
|
*/
|
|
381
404
|
Errors?: MetricDataError[];
|
|
@@ -435,14 +458,17 @@ export type BehaviorOnMxFailure = (typeof BehaviorOnMxFailure)[keyof typeof Beha
|
|
|
435
458
|
*/
|
|
436
459
|
export interface BlacklistEntry {
|
|
437
460
|
/**
|
|
461
|
+
* @public
|
|
438
462
|
* <p>The name of the blacklist that the IP address appears on.</p>
|
|
439
463
|
*/
|
|
440
464
|
RblName?: string;
|
|
441
465
|
/**
|
|
466
|
+
* @public
|
|
442
467
|
* <p>The time when the blacklisting event occurred.</p>
|
|
443
468
|
*/
|
|
444
469
|
ListingTime?: Date;
|
|
445
470
|
/**
|
|
471
|
+
* @public
|
|
446
472
|
* <p>Additional information about the blacklisting event, as provided by the blacklist
|
|
447
473
|
* maintainer.</p>
|
|
448
474
|
*/
|
|
@@ -455,10 +481,12 @@ export interface BlacklistEntry {
|
|
|
455
481
|
*/
|
|
456
482
|
export interface Content {
|
|
457
483
|
/**
|
|
484
|
+
* @public
|
|
458
485
|
* <p>The content of the message itself.</p>
|
|
459
486
|
*/
|
|
460
487
|
Data: string | undefined;
|
|
461
488
|
/**
|
|
489
|
+
* @public
|
|
462
490
|
* <p>The character set for the content. Because of the constraints of the SMTP protocol,
|
|
463
491
|
* Amazon SES uses 7-bit ASCII by default. If the text includes characters outside of the ASCII
|
|
464
492
|
* range, you have to specify a character set. For example, you could specify
|
|
@@ -472,12 +500,14 @@ export interface Content {
|
|
|
472
500
|
*/
|
|
473
501
|
export interface Body {
|
|
474
502
|
/**
|
|
503
|
+
* @public
|
|
475
504
|
* <p>An object that represents the version of the message that is displayed in email
|
|
476
505
|
* clients that don't support HTML, or clients where the recipient has disabled HTML
|
|
477
506
|
* rendering.</p>
|
|
478
507
|
*/
|
|
479
508
|
Text?: Content;
|
|
480
509
|
/**
|
|
510
|
+
* @public
|
|
481
511
|
* <p>An object that represents the version of the message that is displayed in email
|
|
482
512
|
* clients that support HTML. HTML messages can include formatted text, hyperlinks, images,
|
|
483
513
|
* and more. </p>
|
|
@@ -493,16 +523,19 @@ export interface Body {
|
|
|
493
523
|
*/
|
|
494
524
|
export interface Template {
|
|
495
525
|
/**
|
|
526
|
+
* @public
|
|
496
527
|
* <p>The name of the template. You will refer to this name when you send email using the
|
|
497
528
|
* <code>SendTemplatedEmail</code> or <code>SendBulkTemplatedEmail</code> operations.
|
|
498
529
|
* </p>
|
|
499
530
|
*/
|
|
500
531
|
TemplateName?: string;
|
|
501
532
|
/**
|
|
533
|
+
* @public
|
|
502
534
|
* <p>The Amazon Resource Name (ARN) of the template.</p>
|
|
503
535
|
*/
|
|
504
536
|
TemplateArn?: string;
|
|
505
537
|
/**
|
|
538
|
+
* @public
|
|
506
539
|
* <p>An object that defines the values to use for message variables in the template. This
|
|
507
540
|
* object is a set of key-value pairs. Each key defines a message variable in the template.
|
|
508
541
|
* The corresponding value defines the value to use for that variable.</p>
|
|
@@ -516,6 +549,7 @@ export interface Template {
|
|
|
516
549
|
*/
|
|
517
550
|
export interface BulkEmailContent {
|
|
518
551
|
/**
|
|
552
|
+
* @public
|
|
519
553
|
* <p>The template to use for the bulk email message.</p>
|
|
520
554
|
*/
|
|
521
555
|
Template?: Template;
|
|
@@ -534,16 +568,19 @@ export interface BulkEmailContent {
|
|
|
534
568
|
*/
|
|
535
569
|
export interface Destination {
|
|
536
570
|
/**
|
|
571
|
+
* @public
|
|
537
572
|
* <p>An array that contains the email addresses of the "To" recipients for the
|
|
538
573
|
* email.</p>
|
|
539
574
|
*/
|
|
540
575
|
ToAddresses?: string[];
|
|
541
576
|
/**
|
|
577
|
+
* @public
|
|
542
578
|
* <p>An array that contains the email addresses of the "CC" (carbon copy) recipients for
|
|
543
579
|
* the email.</p>
|
|
544
580
|
*/
|
|
545
581
|
CcAddresses?: string[];
|
|
546
582
|
/**
|
|
583
|
+
* @public
|
|
547
584
|
* <p>An array that contains the email addresses of the "BCC" (blind carbon copy) recipients
|
|
548
585
|
* for the email.</p>
|
|
549
586
|
*/
|
|
@@ -556,6 +593,7 @@ export interface Destination {
|
|
|
556
593
|
*/
|
|
557
594
|
export interface ReplacementTemplate {
|
|
558
595
|
/**
|
|
596
|
+
* @public
|
|
559
597
|
* <p>A list of replacement values to apply to the template. This parameter is a JSON
|
|
560
598
|
* object, typically consisting of key-value pairs in which the keys correspond to
|
|
561
599
|
* replacement tags in the email template.</p>
|
|
@@ -570,6 +608,7 @@ export interface ReplacementTemplate {
|
|
|
570
608
|
*/
|
|
571
609
|
export interface ReplacementEmailContent {
|
|
572
610
|
/**
|
|
611
|
+
* @public
|
|
573
612
|
* <p>The <code>ReplacementTemplate</code> associated with
|
|
574
613
|
* <code>ReplacementEmailContent</code>.</p>
|
|
575
614
|
*/
|
|
@@ -583,6 +622,7 @@ export interface ReplacementEmailContent {
|
|
|
583
622
|
*/
|
|
584
623
|
export interface MessageTag {
|
|
585
624
|
/**
|
|
625
|
+
* @public
|
|
586
626
|
* <p>The name of the message tag. The message tag name has to meet the following
|
|
587
627
|
* criteria:</p>
|
|
588
628
|
* <ul>
|
|
@@ -597,6 +637,7 @@ export interface MessageTag {
|
|
|
597
637
|
*/
|
|
598
638
|
Name: string | undefined;
|
|
599
639
|
/**
|
|
640
|
+
* @public
|
|
600
641
|
* <p>The value of the message tag. The message tag value has to meet the following
|
|
601
642
|
* criteria:</p>
|
|
602
643
|
* <ul>
|
|
@@ -616,6 +657,7 @@ export interface MessageTag {
|
|
|
616
657
|
*/
|
|
617
658
|
export interface BulkEmailEntry {
|
|
618
659
|
/**
|
|
660
|
+
* @public
|
|
619
661
|
* <p>Represents the destination of the message, consisting of To:, CC:, and BCC:
|
|
620
662
|
* fields.</p>
|
|
621
663
|
* <note>
|
|
@@ -629,6 +671,7 @@ export interface BulkEmailEntry {
|
|
|
629
671
|
*/
|
|
630
672
|
Destination: Destination | undefined;
|
|
631
673
|
/**
|
|
674
|
+
* @public
|
|
632
675
|
* <p>A list of tags, in the form of name/value pairs, to apply to an email that you send
|
|
633
676
|
* using the <code>SendBulkTemplatedEmail</code> operation. Tags correspond to
|
|
634
677
|
* characteristics of the email that you define, so that you can publish email sending
|
|
@@ -636,6 +679,7 @@ export interface BulkEmailEntry {
|
|
|
636
679
|
*/
|
|
637
680
|
ReplacementTags?: MessageTag[];
|
|
638
681
|
/**
|
|
682
|
+
* @public
|
|
639
683
|
* <p>The <code>ReplacementEmailContent</code> associated with a
|
|
640
684
|
* <code>BulkEmailEntry</code>.</p>
|
|
641
685
|
*/
|
|
@@ -672,6 +716,7 @@ export type BulkEmailStatus = (typeof BulkEmailStatus)[keyof typeof BulkEmailSta
|
|
|
672
716
|
*/
|
|
673
717
|
export interface BulkEmailEntryResult {
|
|
674
718
|
/**
|
|
719
|
+
* @public
|
|
675
720
|
* <p>The status of a message sent using the <code>SendBulkTemplatedEmail</code>
|
|
676
721
|
* operation.</p>
|
|
677
722
|
* <p>Possible values for this parameter include:</p>
|
|
@@ -736,11 +781,13 @@ export interface BulkEmailEntryResult {
|
|
|
736
781
|
*/
|
|
737
782
|
Status?: BulkEmailStatus | string;
|
|
738
783
|
/**
|
|
784
|
+
* @public
|
|
739
785
|
* <p>A description of an error that prevented a message being sent using the
|
|
740
786
|
* <code>SendBulkTemplatedEmail</code> operation.</p>
|
|
741
787
|
*/
|
|
742
788
|
Error?: string;
|
|
743
789
|
/**
|
|
790
|
+
* @public
|
|
744
791
|
* <p>The unique message identifier returned from the <code>SendBulkTemplatedEmail</code>
|
|
745
792
|
* operation.</p>
|
|
746
793
|
*/
|
|
@@ -766,6 +813,7 @@ export type DimensionValueSource = (typeof DimensionValueSource)[keyof typeof Di
|
|
|
766
813
|
*/
|
|
767
814
|
export interface CloudWatchDimensionConfiguration {
|
|
768
815
|
/**
|
|
816
|
+
* @public
|
|
769
817
|
* <p>The name of an Amazon CloudWatch dimension associated with an email sending metric. The name has to
|
|
770
818
|
* meet the following criteria:</p>
|
|
771
819
|
* <ul>
|
|
@@ -780,6 +828,7 @@ export interface CloudWatchDimensionConfiguration {
|
|
|
780
828
|
*/
|
|
781
829
|
DimensionName: string | undefined;
|
|
782
830
|
/**
|
|
831
|
+
* @public
|
|
783
832
|
* <p>The location where the Amazon SES API v2 finds the value of a dimension to publish to Amazon CloudWatch. To
|
|
784
833
|
* use the message tags that you specify using an <code>X-SES-MESSAGE-TAGS</code> header or
|
|
785
834
|
* a parameter to the <code>SendEmail</code> or <code>SendRawEmail</code> API, choose
|
|
@@ -788,6 +837,7 @@ export interface CloudWatchDimensionConfiguration {
|
|
|
788
837
|
*/
|
|
789
838
|
DimensionValueSource: DimensionValueSource | string | undefined;
|
|
790
839
|
/**
|
|
840
|
+
* @public
|
|
791
841
|
* <p>The default value of the dimension that is published to Amazon CloudWatch if you don't provide the
|
|
792
842
|
* value of the dimension when you send an email. This value has to meet the following
|
|
793
843
|
* criteria:</p>
|
|
@@ -810,6 +860,7 @@ export interface CloudWatchDimensionConfiguration {
|
|
|
810
860
|
*/
|
|
811
861
|
export interface CloudWatchDestination {
|
|
812
862
|
/**
|
|
863
|
+
* @public
|
|
813
864
|
* <p>An array of objects that define the dimensions to use when you send email events to
|
|
814
865
|
* Amazon CloudWatch.</p>
|
|
815
866
|
*/
|
|
@@ -857,10 +908,12 @@ export type SubscriptionStatus = (typeof SubscriptionStatus)[keyof typeof Subscr
|
|
|
857
908
|
*/
|
|
858
909
|
export interface TopicPreference {
|
|
859
910
|
/**
|
|
911
|
+
* @public
|
|
860
912
|
* <p>The name of the topic.</p>
|
|
861
913
|
*/
|
|
862
914
|
TopicName: string | undefined;
|
|
863
915
|
/**
|
|
916
|
+
* @public
|
|
864
917
|
* <p>The contact's subscription status to a topic which is either <code>OPT_IN</code> or
|
|
865
918
|
* <code>OPT_OUT</code>.</p>
|
|
866
919
|
*/
|
|
@@ -872,23 +925,28 @@ export interface TopicPreference {
|
|
|
872
925
|
*/
|
|
873
926
|
export interface Contact {
|
|
874
927
|
/**
|
|
928
|
+
* @public
|
|
875
929
|
* <p>The contact's email address.</p>
|
|
876
930
|
*/
|
|
877
931
|
EmailAddress?: string;
|
|
878
932
|
/**
|
|
933
|
+
* @public
|
|
879
934
|
* <p>The contact's preference for being opted-in to or opted-out of a topic.</p>
|
|
880
935
|
*/
|
|
881
936
|
TopicPreferences?: TopicPreference[];
|
|
882
937
|
/**
|
|
938
|
+
* @public
|
|
883
939
|
* <p>The default topic preferences applied to the contact.</p>
|
|
884
940
|
*/
|
|
885
941
|
TopicDefaultPreferences?: TopicPreference[];
|
|
886
942
|
/**
|
|
943
|
+
* @public
|
|
887
944
|
* <p>A boolean value status noting if the contact is unsubscribed from all contact list
|
|
888
945
|
* topics.</p>
|
|
889
946
|
*/
|
|
890
947
|
UnsubscribeAll?: boolean;
|
|
891
948
|
/**
|
|
949
|
+
* @public
|
|
892
950
|
* <p>A timestamp noting the last time the contact's information was updated.</p>
|
|
893
951
|
*/
|
|
894
952
|
LastUpdatedTimestamp?: Date;
|
|
@@ -900,10 +958,12 @@ export interface Contact {
|
|
|
900
958
|
*/
|
|
901
959
|
export interface ContactList {
|
|
902
960
|
/**
|
|
961
|
+
* @public
|
|
903
962
|
* <p>The name of the contact list.</p>
|
|
904
963
|
*/
|
|
905
964
|
ContactListName?: string;
|
|
906
965
|
/**
|
|
966
|
+
* @public
|
|
907
967
|
* <p>A timestamp noting the last time the contact list was updated.</p>
|
|
908
968
|
*/
|
|
909
969
|
LastUpdatedTimestamp?: Date;
|
|
@@ -926,10 +986,12 @@ export type ContactListImportAction = (typeof ContactListImportAction)[keyof typ
|
|
|
926
986
|
*/
|
|
927
987
|
export interface ContactListDestination {
|
|
928
988
|
/**
|
|
989
|
+
* @public
|
|
929
990
|
* <p>The name of the contact list.</p>
|
|
930
991
|
*/
|
|
931
992
|
ContactListName: string | undefined;
|
|
932
993
|
/**
|
|
994
|
+
* @public
|
|
933
995
|
* <p>>The type of action to perform on the addresses. The following are the
|
|
934
996
|
* possible values:</p>
|
|
935
997
|
* <ul>
|
|
@@ -962,6 +1024,7 @@ export type TlsPolicy = (typeof TlsPolicy)[keyof typeof TlsPolicy];
|
|
|
962
1024
|
*/
|
|
963
1025
|
export interface DeliveryOptions {
|
|
964
1026
|
/**
|
|
1027
|
+
* @public
|
|
965
1028
|
* <p>Specifies whether messages that use the configuration set are required to use
|
|
966
1029
|
* Transport Layer Security (TLS). If the value is <code>Require</code>, messages are only
|
|
967
1030
|
* delivered if a TLS connection can be established. If the value is <code>Optional</code>,
|
|
@@ -969,6 +1032,7 @@ export interface DeliveryOptions {
|
|
|
969
1032
|
*/
|
|
970
1033
|
TlsPolicy?: TlsPolicy | string;
|
|
971
1034
|
/**
|
|
1035
|
+
* @public
|
|
972
1036
|
* <p>The name of the dedicated IP pool to associate with the configuration set.</p>
|
|
973
1037
|
*/
|
|
974
1038
|
SendingPoolName?: string;
|
|
@@ -980,12 +1044,14 @@ export interface DeliveryOptions {
|
|
|
980
1044
|
*/
|
|
981
1045
|
export interface ReputationOptions {
|
|
982
1046
|
/**
|
|
1047
|
+
* @public
|
|
983
1048
|
* <p>If <code>true</code>, tracking of reputation metrics is enabled for the configuration
|
|
984
1049
|
* set. If <code>false</code>, tracking of reputation metrics is disabled for the
|
|
985
1050
|
* configuration set.</p>
|
|
986
1051
|
*/
|
|
987
1052
|
ReputationMetricsEnabled?: boolean;
|
|
988
1053
|
/**
|
|
1054
|
+
* @public
|
|
989
1055
|
* <p>The date and time (in Unix time) when the reputation metrics were last given a fresh
|
|
990
1056
|
* start. When your account is given a fresh start, your reputation metrics are calculated
|
|
991
1057
|
* starting from the date of the fresh start.</p>
|
|
@@ -999,6 +1065,7 @@ export interface ReputationOptions {
|
|
|
999
1065
|
*/
|
|
1000
1066
|
export interface SendingOptions {
|
|
1001
1067
|
/**
|
|
1068
|
+
* @public
|
|
1002
1069
|
* <p>If <code>true</code>, email sending is enabled for the configuration set. If
|
|
1003
1070
|
* <code>false</code>, email sending is disabled for the configuration set.</p>
|
|
1004
1071
|
*/
|
|
@@ -1023,6 +1090,7 @@ export type SuppressionListReason = (typeof SuppressionListReason)[keyof typeof
|
|
|
1023
1090
|
*/
|
|
1024
1091
|
export interface SuppressionOptions {
|
|
1025
1092
|
/**
|
|
1093
|
+
* @public
|
|
1026
1094
|
* <p>A list that contains the reasons that email addresses are automatically added to the
|
|
1027
1095
|
* suppression list for your account. This list can contain any or all of the
|
|
1028
1096
|
* following:</p>
|
|
@@ -1081,11 +1149,13 @@ export interface SuppressionOptions {
|
|
|
1081
1149
|
*/
|
|
1082
1150
|
export interface Tag {
|
|
1083
1151
|
/**
|
|
1152
|
+
* @public
|
|
1084
1153
|
* <p>One part of a key-value pair that defines a tag. The maximum length of a tag key is
|
|
1085
1154
|
* 128 characters. The minimum length is 1 character.</p>
|
|
1086
1155
|
*/
|
|
1087
1156
|
Key: string | undefined;
|
|
1088
1157
|
/**
|
|
1158
|
+
* @public
|
|
1089
1159
|
* <p>The optional part of a key-value pair that defines a tag. The maximum length of a tag
|
|
1090
1160
|
* value is 256 characters. The minimum length is 0 characters. If you don't want a
|
|
1091
1161
|
* resource to have a specific tag value, don't specify a value for this parameter. If you
|
|
@@ -1105,6 +1175,7 @@ export interface Tag {
|
|
|
1105
1175
|
*/
|
|
1106
1176
|
export interface TrackingOptions {
|
|
1107
1177
|
/**
|
|
1178
|
+
* @public
|
|
1108
1179
|
* <p>The domain to use for tracking open and click events.</p>
|
|
1109
1180
|
*/
|
|
1110
1181
|
CustomRedirectDomain: string | undefined;
|
|
@@ -1128,6 +1199,7 @@ export type FeatureStatus = (typeof FeatureStatus)[keyof typeof FeatureStatus];
|
|
|
1128
1199
|
*/
|
|
1129
1200
|
export interface DashboardOptions {
|
|
1130
1201
|
/**
|
|
1202
|
+
* @public
|
|
1131
1203
|
* <p>Specifies the status of your VDM engagement metrics collection. Can be one of the
|
|
1132
1204
|
* following:</p>
|
|
1133
1205
|
* <ul>
|
|
@@ -1152,6 +1224,7 @@ export interface DashboardOptions {
|
|
|
1152
1224
|
*/
|
|
1153
1225
|
export interface GuardianOptions {
|
|
1154
1226
|
/**
|
|
1227
|
+
* @public
|
|
1155
1228
|
* <p>Specifies the status of your VDM optimized shared delivery. Can be one of the
|
|
1156
1229
|
* following:</p>
|
|
1157
1230
|
* <ul>
|
|
@@ -1176,11 +1249,13 @@ export interface GuardianOptions {
|
|
|
1176
1249
|
*/
|
|
1177
1250
|
export interface VdmOptions {
|
|
1178
1251
|
/**
|
|
1252
|
+
* @public
|
|
1179
1253
|
* <p>Specifies additional settings for your VDM configuration as applicable to the
|
|
1180
1254
|
* Dashboard.</p>
|
|
1181
1255
|
*/
|
|
1182
1256
|
DashboardOptions?: DashboardOptions;
|
|
1183
1257
|
/**
|
|
1258
|
+
* @public
|
|
1184
1259
|
* <p>Specifies additional settings for your VDM configuration as applicable to the
|
|
1185
1260
|
* Guardian.</p>
|
|
1186
1261
|
*/
|
|
@@ -1192,41 +1267,49 @@ export interface VdmOptions {
|
|
|
1192
1267
|
*/
|
|
1193
1268
|
export interface CreateConfigurationSetRequest {
|
|
1194
1269
|
/**
|
|
1270
|
+
* @public
|
|
1195
1271
|
* <p>The name of the configuration set. The name can contain up to 64 alphanumeric
|
|
1196
1272
|
* characters, including letters, numbers, hyphens (-) and underscores (_) only.</p>
|
|
1197
1273
|
*/
|
|
1198
1274
|
ConfigurationSetName: string | undefined;
|
|
1199
1275
|
/**
|
|
1276
|
+
* @public
|
|
1200
1277
|
* <p>An object that defines the open and click tracking options for emails that you send
|
|
1201
1278
|
* using the configuration set.</p>
|
|
1202
1279
|
*/
|
|
1203
1280
|
TrackingOptions?: TrackingOptions;
|
|
1204
1281
|
/**
|
|
1282
|
+
* @public
|
|
1205
1283
|
* <p>An object that defines the dedicated IP pool that is used to send emails that you send
|
|
1206
1284
|
* using the configuration set.</p>
|
|
1207
1285
|
*/
|
|
1208
1286
|
DeliveryOptions?: DeliveryOptions;
|
|
1209
1287
|
/**
|
|
1288
|
+
* @public
|
|
1210
1289
|
* <p>An object that defines whether or not Amazon SES collects reputation metrics for the emails
|
|
1211
1290
|
* that you send that use the configuration set.</p>
|
|
1212
1291
|
*/
|
|
1213
1292
|
ReputationOptions?: ReputationOptions;
|
|
1214
1293
|
/**
|
|
1294
|
+
* @public
|
|
1215
1295
|
* <p>An object that defines whether or not Amazon SES can send email that you send using the
|
|
1216
1296
|
* configuration set.</p>
|
|
1217
1297
|
*/
|
|
1218
1298
|
SendingOptions?: SendingOptions;
|
|
1219
1299
|
/**
|
|
1300
|
+
* @public
|
|
1220
1301
|
* <p>An array of objects that define the tags (keys and values) to associate with the
|
|
1221
1302
|
* configuration set.</p>
|
|
1222
1303
|
*/
|
|
1223
1304
|
Tags?: Tag[];
|
|
1224
1305
|
/**
|
|
1306
|
+
* @public
|
|
1225
1307
|
* <p>An object that contains information about the suppression list preferences for your
|
|
1226
1308
|
* account.</p>
|
|
1227
1309
|
*/
|
|
1228
1310
|
SuppressionOptions?: SuppressionOptions;
|
|
1229
1311
|
/**
|
|
1312
|
+
* @public
|
|
1230
1313
|
* <p>An object that defines the VDM options for emails that you send using the
|
|
1231
1314
|
* configuration set.</p>
|
|
1232
1315
|
*/
|
|
@@ -1258,11 +1341,13 @@ export declare class LimitExceededException extends __BaseException {
|
|
|
1258
1341
|
*/
|
|
1259
1342
|
export interface KinesisFirehoseDestination {
|
|
1260
1343
|
/**
|
|
1344
|
+
* @public
|
|
1261
1345
|
* <p>The Amazon Resource Name (ARN) of the IAM role that the Amazon SES API v2 uses to send email
|
|
1262
1346
|
* events to the Amazon Kinesis Data Firehose stream.</p>
|
|
1263
1347
|
*/
|
|
1264
1348
|
IamRoleArn: string | undefined;
|
|
1265
1349
|
/**
|
|
1350
|
+
* @public
|
|
1266
1351
|
* <p>The Amazon Resource Name (ARN) of the Amazon Kinesis Data Firehose stream that the Amazon SES API v2 sends email
|
|
1267
1352
|
* events to.</p>
|
|
1268
1353
|
*/
|
|
@@ -1297,6 +1382,7 @@ export type EventType = (typeof EventType)[keyof typeof EventType];
|
|
|
1297
1382
|
*/
|
|
1298
1383
|
export interface PinpointDestination {
|
|
1299
1384
|
/**
|
|
1385
|
+
* @public
|
|
1300
1386
|
* <p>The Amazon Resource Name (ARN) of the Amazon Pinpoint project to send email events to.</p>
|
|
1301
1387
|
*/
|
|
1302
1388
|
ApplicationArn?: string;
|
|
@@ -1308,6 +1394,7 @@ export interface PinpointDestination {
|
|
|
1308
1394
|
*/
|
|
1309
1395
|
export interface SnsDestination {
|
|
1310
1396
|
/**
|
|
1397
|
+
* @public
|
|
1311
1398
|
* <p>The Amazon Resource Name (ARN) of the Amazon SNS topic to publish email events to. For
|
|
1312
1399
|
* more information about Amazon SNS topics, see the <a href="https://docs.aws.amazon.com/sns/latest/dg/CreateTopic.html">Amazon SNS Developer Guide</a>.</p>
|
|
1313
1400
|
*/
|
|
@@ -1322,6 +1409,7 @@ export interface SnsDestination {
|
|
|
1322
1409
|
*/
|
|
1323
1410
|
export interface EventDestinationDefinition {
|
|
1324
1411
|
/**
|
|
1412
|
+
* @public
|
|
1325
1413
|
* <p>If <code>true</code>, the event destination is enabled. When the event destination is
|
|
1326
1414
|
* enabled, the specified event types are sent to the destinations in this
|
|
1327
1415
|
* <code>EventDestinationDefinition</code>.</p>
|
|
@@ -1330,26 +1418,31 @@ export interface EventDestinationDefinition {
|
|
|
1330
1418
|
*/
|
|
1331
1419
|
Enabled?: boolean;
|
|
1332
1420
|
/**
|
|
1421
|
+
* @public
|
|
1333
1422
|
* <p>An array that specifies which events the Amazon SES API v2 should send to the destinations in
|
|
1334
1423
|
* this <code>EventDestinationDefinition</code>.</p>
|
|
1335
1424
|
*/
|
|
1336
1425
|
MatchingEventTypes?: (EventType | string)[];
|
|
1337
1426
|
/**
|
|
1427
|
+
* @public
|
|
1338
1428
|
* <p>An object that defines an Amazon Kinesis Data Firehose destination for email events. You can use Amazon Kinesis Data Firehose to
|
|
1339
1429
|
* stream data to other services, such as Amazon S3 and Amazon Redshift.</p>
|
|
1340
1430
|
*/
|
|
1341
1431
|
KinesisFirehoseDestination?: KinesisFirehoseDestination;
|
|
1342
1432
|
/**
|
|
1433
|
+
* @public
|
|
1343
1434
|
* <p>An object that defines an Amazon CloudWatch destination for email events. You can use Amazon CloudWatch to
|
|
1344
1435
|
* monitor and gain insights on your email sending metrics.</p>
|
|
1345
1436
|
*/
|
|
1346
1437
|
CloudWatchDestination?: CloudWatchDestination;
|
|
1347
1438
|
/**
|
|
1439
|
+
* @public
|
|
1348
1440
|
* <p>An object that defines an Amazon SNS destination for email events. You can use Amazon SNS to
|
|
1349
1441
|
* send notification when certain email events occur.</p>
|
|
1350
1442
|
*/
|
|
1351
1443
|
SnsDestination?: SnsDestination;
|
|
1352
1444
|
/**
|
|
1445
|
+
* @public
|
|
1353
1446
|
* <p>An object that defines an Amazon Pinpoint project destination for email events. You can send
|
|
1354
1447
|
* email event data to a Amazon Pinpoint project to view metrics using the Transactional Messaging
|
|
1355
1448
|
* dashboards that are built in to Amazon Pinpoint. For more information, see <a href="https://docs.aws.amazon.com/pinpoint/latest/userguide/analytics-transactional-messages.html">Transactional
|
|
@@ -1363,14 +1456,17 @@ export interface EventDestinationDefinition {
|
|
|
1363
1456
|
*/
|
|
1364
1457
|
export interface CreateConfigurationSetEventDestinationRequest {
|
|
1365
1458
|
/**
|
|
1459
|
+
* @public
|
|
1366
1460
|
* <p>The name of the configuration set .</p>
|
|
1367
1461
|
*/
|
|
1368
1462
|
ConfigurationSetName: string | undefined;
|
|
1369
1463
|
/**
|
|
1464
|
+
* @public
|
|
1370
1465
|
* <p>A name that identifies the event destination within the configuration set.</p>
|
|
1371
1466
|
*/
|
|
1372
1467
|
EventDestinationName: string | undefined;
|
|
1373
1468
|
/**
|
|
1469
|
+
* @public
|
|
1374
1470
|
* <p>An object that defines the event destination.</p>
|
|
1375
1471
|
*/
|
|
1376
1472
|
EventDestination: EventDestinationDefinition | undefined;
|
|
@@ -1387,23 +1483,28 @@ export interface CreateConfigurationSetEventDestinationResponse {
|
|
|
1387
1483
|
*/
|
|
1388
1484
|
export interface CreateContactRequest {
|
|
1389
1485
|
/**
|
|
1486
|
+
* @public
|
|
1390
1487
|
* <p>The name of the contact list to which the contact should be added.</p>
|
|
1391
1488
|
*/
|
|
1392
1489
|
ContactListName: string | undefined;
|
|
1393
1490
|
/**
|
|
1491
|
+
* @public
|
|
1394
1492
|
* <p>The contact's email address.</p>
|
|
1395
1493
|
*/
|
|
1396
1494
|
EmailAddress: string | undefined;
|
|
1397
1495
|
/**
|
|
1496
|
+
* @public
|
|
1398
1497
|
* <p>The contact's preferences for being opted-in to or opted-out of topics.</p>
|
|
1399
1498
|
*/
|
|
1400
1499
|
TopicPreferences?: TopicPreference[];
|
|
1401
1500
|
/**
|
|
1501
|
+
* @public
|
|
1402
1502
|
* <p>A boolean value status noting if the contact is unsubscribed from all contact list
|
|
1403
1503
|
* topics.</p>
|
|
1404
1504
|
*/
|
|
1405
1505
|
UnsubscribeAll?: boolean;
|
|
1406
1506
|
/**
|
|
1507
|
+
* @public
|
|
1407
1508
|
* <p>The attribute data attached to a contact.</p>
|
|
1408
1509
|
*/
|
|
1409
1510
|
AttributesData?: string;
|
|
@@ -1420,18 +1521,22 @@ export interface CreateContactResponse {
|
|
|
1420
1521
|
*/
|
|
1421
1522
|
export interface Topic {
|
|
1422
1523
|
/**
|
|
1524
|
+
* @public
|
|
1423
1525
|
* <p>The name of the topic.</p>
|
|
1424
1526
|
*/
|
|
1425
1527
|
TopicName: string | undefined;
|
|
1426
1528
|
/**
|
|
1529
|
+
* @public
|
|
1427
1530
|
* <p>The name of the topic the contact will see.</p>
|
|
1428
1531
|
*/
|
|
1429
1532
|
DisplayName: string | undefined;
|
|
1430
1533
|
/**
|
|
1534
|
+
* @public
|
|
1431
1535
|
* <p>A description of what the topic is about, which the contact will see.</p>
|
|
1432
1536
|
*/
|
|
1433
1537
|
Description?: string;
|
|
1434
1538
|
/**
|
|
1539
|
+
* @public
|
|
1435
1540
|
* <p>The default subscription status to be applied to a contact if the contact has not
|
|
1436
1541
|
* noted their preference for subscribing to a topic.</p>
|
|
1437
1542
|
*/
|
|
@@ -1442,19 +1547,23 @@ export interface Topic {
|
|
|
1442
1547
|
*/
|
|
1443
1548
|
export interface CreateContactListRequest {
|
|
1444
1549
|
/**
|
|
1550
|
+
* @public
|
|
1445
1551
|
* <p>The name of the contact list.</p>
|
|
1446
1552
|
*/
|
|
1447
1553
|
ContactListName: string | undefined;
|
|
1448
1554
|
/**
|
|
1555
|
+
* @public
|
|
1449
1556
|
* <p>An interest group, theme, or label within a list. A contact list can have multiple
|
|
1450
1557
|
* topics.</p>
|
|
1451
1558
|
*/
|
|
1452
1559
|
Topics?: Topic[];
|
|
1453
1560
|
/**
|
|
1561
|
+
* @public
|
|
1454
1562
|
* <p>A description of what the contact list is about.</p>
|
|
1455
1563
|
*/
|
|
1456
1564
|
Description?: string;
|
|
1457
1565
|
/**
|
|
1566
|
+
* @public
|
|
1458
1567
|
* <p>The tags associated with a contact list.</p>
|
|
1459
1568
|
*/
|
|
1460
1569
|
Tags?: Tag[];
|
|
@@ -1470,18 +1579,22 @@ export interface CreateContactListResponse {
|
|
|
1470
1579
|
*/
|
|
1471
1580
|
export interface CreateCustomVerificationEmailTemplateRequest {
|
|
1472
1581
|
/**
|
|
1582
|
+
* @public
|
|
1473
1583
|
* <p>The name of the custom verification email template.</p>
|
|
1474
1584
|
*/
|
|
1475
1585
|
TemplateName: string | undefined;
|
|
1476
1586
|
/**
|
|
1587
|
+
* @public
|
|
1477
1588
|
* <p>The email address that the custom verification email is sent from.</p>
|
|
1478
1589
|
*/
|
|
1479
1590
|
FromEmailAddress: string | undefined;
|
|
1480
1591
|
/**
|
|
1592
|
+
* @public
|
|
1481
1593
|
* <p>The subject line of the custom verification email.</p>
|
|
1482
1594
|
*/
|
|
1483
1595
|
TemplateSubject: string | undefined;
|
|
1484
1596
|
/**
|
|
1597
|
+
* @public
|
|
1485
1598
|
* <p>The content of the custom verification email. The total size of the email must be less
|
|
1486
1599
|
* than 10 MB. The message body may contain HTML, with some limitations. For more
|
|
1487
1600
|
* information, see <a href="https://docs.aws.amazon.com/ses/latest/dg/creating-identities.html#send-email-verify-address-custom-faq">Custom verification email frequently asked questions</a> in the <i>Amazon SES
|
|
@@ -1489,11 +1602,13 @@ export interface CreateCustomVerificationEmailTemplateRequest {
|
|
|
1489
1602
|
*/
|
|
1490
1603
|
TemplateContent: string | undefined;
|
|
1491
1604
|
/**
|
|
1605
|
+
* @public
|
|
1492
1606
|
* <p>The URL that the recipient of the verification email is sent to if his or her address
|
|
1493
1607
|
* is successfully verified.</p>
|
|
1494
1608
|
*/
|
|
1495
1609
|
SuccessRedirectionURL: string | undefined;
|
|
1496
1610
|
/**
|
|
1611
|
+
* @public
|
|
1497
1612
|
* <p>The URL that the recipient of the verification email is sent to if his or her address
|
|
1498
1613
|
* is not successfully verified.</p>
|
|
1499
1614
|
*/
|
|
@@ -1524,15 +1639,18 @@ export type ScalingMode = (typeof ScalingMode)[keyof typeof ScalingMode];
|
|
|
1524
1639
|
*/
|
|
1525
1640
|
export interface CreateDedicatedIpPoolRequest {
|
|
1526
1641
|
/**
|
|
1642
|
+
* @public
|
|
1527
1643
|
* <p>The name of the dedicated IP pool.</p>
|
|
1528
1644
|
*/
|
|
1529
1645
|
PoolName: string | undefined;
|
|
1530
1646
|
/**
|
|
1647
|
+
* @public
|
|
1531
1648
|
* <p>An object that defines the tags (keys and values) that you want to associate with the
|
|
1532
1649
|
* pool.</p>
|
|
1533
1650
|
*/
|
|
1534
1651
|
Tags?: Tag[];
|
|
1535
1652
|
/**
|
|
1653
|
+
* @public
|
|
1536
1654
|
* <p>The type of scaling mode.</p>
|
|
1537
1655
|
*/
|
|
1538
1656
|
ScalingMode?: ScalingMode | string;
|
|
@@ -1550,6 +1668,7 @@ export interface CreateDedicatedIpPoolResponse {
|
|
|
1550
1668
|
*/
|
|
1551
1669
|
export interface RawMessage {
|
|
1552
1670
|
/**
|
|
1671
|
+
* @public
|
|
1553
1672
|
* <p>The raw email message. The message has to meet the following criteria:</p>
|
|
1554
1673
|
* <ul>
|
|
1555
1674
|
* <li>
|
|
@@ -1588,12 +1707,14 @@ export interface RawMessage {
|
|
|
1588
1707
|
*/
|
|
1589
1708
|
export interface Message {
|
|
1590
1709
|
/**
|
|
1710
|
+
* @public
|
|
1591
1711
|
* <p>The subject line of the email. The subject line can only contain 7-bit ASCII
|
|
1592
1712
|
* characters. However, you can specify non-ASCII characters in the subject line by using
|
|
1593
1713
|
* encoded-word syntax, as described in <a href="https://tools.ietf.org/html/rfc2047">RFC 2047</a>.</p>
|
|
1594
1714
|
*/
|
|
1595
1715
|
Subject: Content | undefined;
|
|
1596
1716
|
/**
|
|
1717
|
+
* @public
|
|
1597
1718
|
* <p>The body of the message. You can specify an HTML version of the message, a text-only
|
|
1598
1719
|
* version of the message, or both.</p>
|
|
1599
1720
|
*/
|
|
@@ -1609,10 +1730,12 @@ export interface Message {
|
|
|
1609
1730
|
*/
|
|
1610
1731
|
export interface EmailContent {
|
|
1611
1732
|
/**
|
|
1733
|
+
* @public
|
|
1612
1734
|
* <p>The simple email message. The message consists of a subject and a message body.</p>
|
|
1613
1735
|
*/
|
|
1614
1736
|
Simple?: Message;
|
|
1615
1737
|
/**
|
|
1738
|
+
* @public
|
|
1616
1739
|
* <p>The raw email message. The message has to meet the following criteria:</p>
|
|
1617
1740
|
* <ul>
|
|
1618
1741
|
* <li>
|
|
@@ -1646,6 +1769,7 @@ export interface EmailContent {
|
|
|
1646
1769
|
*/
|
|
1647
1770
|
Raw?: RawMessage;
|
|
1648
1771
|
/**
|
|
1772
|
+
* @public
|
|
1649
1773
|
* <p>The template to use for the email message.</p>
|
|
1650
1774
|
*/
|
|
1651
1775
|
Template?: Template;
|
|
@@ -1662,19 +1786,23 @@ export interface EmailContent {
|
|
|
1662
1786
|
*/
|
|
1663
1787
|
export interface CreateDeliverabilityTestReportRequest {
|
|
1664
1788
|
/**
|
|
1789
|
+
* @public
|
|
1665
1790
|
* <p>A unique name that helps you to identify the predictive inbox placement test when you retrieve the
|
|
1666
1791
|
* results.</p>
|
|
1667
1792
|
*/
|
|
1668
1793
|
ReportName?: string;
|
|
1669
1794
|
/**
|
|
1795
|
+
* @public
|
|
1670
1796
|
* <p>The email address that the predictive inbox placement test email was sent from.</p>
|
|
1671
1797
|
*/
|
|
1672
1798
|
FromEmailAddress: string | undefined;
|
|
1673
1799
|
/**
|
|
1800
|
+
* @public
|
|
1674
1801
|
* <p>The HTML body of the message that you sent when you performed the predictive inbox placement test.</p>
|
|
1675
1802
|
*/
|
|
1676
1803
|
Content: EmailContent | undefined;
|
|
1677
1804
|
/**
|
|
1805
|
+
* @public
|
|
1678
1806
|
* <p>An array of objects that define the tags (keys and values) that you want to associate
|
|
1679
1807
|
* with the predictive inbox placement test.</p>
|
|
1680
1808
|
*/
|
|
@@ -1698,10 +1826,12 @@ export type DeliverabilityTestStatus = (typeof DeliverabilityTestStatus)[keyof t
|
|
|
1698
1826
|
*/
|
|
1699
1827
|
export interface CreateDeliverabilityTestReportResponse {
|
|
1700
1828
|
/**
|
|
1829
|
+
* @public
|
|
1701
1830
|
* <p>A unique string that identifies the predictive inbox placement test.</p>
|
|
1702
1831
|
*/
|
|
1703
1832
|
ReportId: string | undefined;
|
|
1704
1833
|
/**
|
|
1834
|
+
* @public
|
|
1705
1835
|
* <p>The status of the predictive inbox placement test. If the status is <code>IN_PROGRESS</code>, then the predictive inbox placement test
|
|
1706
1836
|
* is currently running. Predictive inbox placement tests are usually complete within 24 hours of creating the
|
|
1707
1837
|
* test. If the status is <code>COMPLETE</code>, then the test is finished, and you can use
|
|
@@ -1764,17 +1894,20 @@ export type DkimSigningKeyLength = (typeof DkimSigningKeyLength)[keyof typeof Dk
|
|
|
1764
1894
|
*/
|
|
1765
1895
|
export interface DkimSigningAttributes {
|
|
1766
1896
|
/**
|
|
1897
|
+
* @public
|
|
1767
1898
|
* <p>[Bring Your Own DKIM] A string that's used to identify a public key in the DNS configuration for a
|
|
1768
1899
|
* domain.</p>
|
|
1769
1900
|
*/
|
|
1770
1901
|
DomainSigningSelector?: string;
|
|
1771
1902
|
/**
|
|
1903
|
+
* @public
|
|
1772
1904
|
* <p>[Bring Your Own DKIM] A private key that's used to generate a DKIM signature.</p>
|
|
1773
1905
|
* <p>The private key must use 1024 or 2048-bit RSA encryption, and must be encoded using
|
|
1774
1906
|
* base64 encoding.</p>
|
|
1775
1907
|
*/
|
|
1776
1908
|
DomainSigningPrivateKey?: string;
|
|
1777
1909
|
/**
|
|
1910
|
+
* @public
|
|
1778
1911
|
* <p>[Easy DKIM] The key length of the future DKIM key pair to be generated. This can be changed at most once per day.</p>
|
|
1779
1912
|
*/
|
|
1780
1913
|
NextSigningKeyLength?: DkimSigningKeyLength | string;
|
|
@@ -1786,15 +1919,18 @@ export interface DkimSigningAttributes {
|
|
|
1786
1919
|
*/
|
|
1787
1920
|
export interface CreateEmailIdentityRequest {
|
|
1788
1921
|
/**
|
|
1922
|
+
* @public
|
|
1789
1923
|
* <p>The email address or domain to verify.</p>
|
|
1790
1924
|
*/
|
|
1791
1925
|
EmailIdentity: string | undefined;
|
|
1792
1926
|
/**
|
|
1927
|
+
* @public
|
|
1793
1928
|
* <p>An array of objects that define the tags (keys and values) to associate with the email
|
|
1794
1929
|
* identity.</p>
|
|
1795
1930
|
*/
|
|
1796
1931
|
Tags?: Tag[];
|
|
1797
1932
|
/**
|
|
1933
|
+
* @public
|
|
1798
1934
|
* <p>If your request includes this object, Amazon SES configures the identity to use Bring Your
|
|
1799
1935
|
* Own DKIM (BYODKIM) for DKIM authentication purposes, or, configures the key length to be
|
|
1800
1936
|
* used for <a href="https://docs.aws.amazon.com/ses/latest/DeveloperGuide/easy-dkim.html">Easy
|
|
@@ -1804,6 +1940,7 @@ export interface CreateEmailIdentityRequest {
|
|
|
1804
1940
|
*/
|
|
1805
1941
|
DkimSigningAttributes?: DkimSigningAttributes;
|
|
1806
1942
|
/**
|
|
1943
|
+
* @public
|
|
1807
1944
|
* <p>The configuration set to use by default when sending from this identity. Note that any
|
|
1808
1945
|
* configuration set defined in the email sending request takes precedence. </p>
|
|
1809
1946
|
*/
|
|
@@ -1850,12 +1987,14 @@ export type DkimStatus = (typeof DkimStatus)[keyof typeof DkimStatus];
|
|
|
1850
1987
|
*/
|
|
1851
1988
|
export interface DkimAttributes {
|
|
1852
1989
|
/**
|
|
1990
|
+
* @public
|
|
1853
1991
|
* <p>If the value is <code>true</code>, then the messages that you send from the identity
|
|
1854
1992
|
* are signed using DKIM. If the value is <code>false</code>, then the messages that you
|
|
1855
1993
|
* send from the identity aren't DKIM-signed.</p>
|
|
1856
1994
|
*/
|
|
1857
1995
|
SigningEnabled?: boolean;
|
|
1858
1996
|
/**
|
|
1997
|
+
* @public
|
|
1859
1998
|
* <p>Describes whether or not Amazon SES has successfully located the DKIM records in the DNS
|
|
1860
1999
|
* records for the domain. The status can be one of the following:</p>
|
|
1861
2000
|
* <ul>
|
|
@@ -1890,6 +2029,7 @@ export interface DkimAttributes {
|
|
|
1890
2029
|
*/
|
|
1891
2030
|
Status?: DkimStatus | string;
|
|
1892
2031
|
/**
|
|
2032
|
+
* @public
|
|
1893
2033
|
* <p>If you used <a href="https://docs.aws.amazon.com/ses/latest/DeveloperGuide/easy-dkim.html">Easy DKIM</a> to configure DKIM authentication for the domain, then this object
|
|
1894
2034
|
* contains a set of unique strings that you use to create a set of CNAME records that you
|
|
1895
2035
|
* add to the DNS configuration for your domain. When Amazon SES detects these records in the
|
|
@@ -1902,6 +2042,7 @@ export interface DkimAttributes {
|
|
|
1902
2042
|
*/
|
|
1903
2043
|
Tokens?: string[];
|
|
1904
2044
|
/**
|
|
2045
|
+
* @public
|
|
1905
2046
|
* <p>A string that indicates how DKIM was configured for the identity. These are the
|
|
1906
2047
|
* possible values:</p>
|
|
1907
2048
|
* <ul>
|
|
@@ -1919,14 +2060,17 @@ export interface DkimAttributes {
|
|
|
1919
2060
|
*/
|
|
1920
2061
|
SigningAttributesOrigin?: DkimSigningAttributesOrigin | string;
|
|
1921
2062
|
/**
|
|
2063
|
+
* @public
|
|
1922
2064
|
* <p>[Easy DKIM] The key length of the future DKIM key pair to be generated. This can be changed at most once per day.</p>
|
|
1923
2065
|
*/
|
|
1924
2066
|
NextSigningKeyLength?: DkimSigningKeyLength | string;
|
|
1925
2067
|
/**
|
|
2068
|
+
* @public
|
|
1926
2069
|
* <p>[Easy DKIM] The key length of the DKIM key pair in use.</p>
|
|
1927
2070
|
*/
|
|
1928
2071
|
CurrentSigningKeyLength?: DkimSigningKeyLength | string;
|
|
1929
2072
|
/**
|
|
2073
|
+
* @public
|
|
1930
2074
|
* <p>[Easy DKIM] The last time a key pair was generated for this identity.</p>
|
|
1931
2075
|
*/
|
|
1932
2076
|
LastKeyGenerationTimestamp?: Date;
|
|
@@ -1952,17 +2096,20 @@ export type IdentityType = (typeof IdentityType)[keyof typeof IdentityType];
|
|
|
1952
2096
|
*/
|
|
1953
2097
|
export interface CreateEmailIdentityResponse {
|
|
1954
2098
|
/**
|
|
2099
|
+
* @public
|
|
1955
2100
|
* <p>The email identity type. Note: the <code>MANAGED_DOMAIN</code> identity type is not
|
|
1956
2101
|
* supported.</p>
|
|
1957
2102
|
*/
|
|
1958
2103
|
IdentityType?: IdentityType | string;
|
|
1959
2104
|
/**
|
|
2105
|
+
* @public
|
|
1960
2106
|
* <p>Specifies whether or not the identity is verified. You can only send email from
|
|
1961
2107
|
* verified email addresses or domains. For more information about verifying identities,
|
|
1962
2108
|
* see the <a href="https://docs.aws.amazon.com/pinpoint/latest/userguide/channels-email-manage-verify.html">Amazon Pinpoint User Guide</a>.</p>
|
|
1963
2109
|
*/
|
|
1964
2110
|
VerifiedForSendingStatus?: boolean;
|
|
1965
2111
|
/**
|
|
2112
|
+
* @public
|
|
1966
2113
|
* <p>An object that contains information about the DKIM attributes for the identity.</p>
|
|
1967
2114
|
*/
|
|
1968
2115
|
DkimAttributes?: DkimAttributes;
|
|
@@ -1975,16 +2122,19 @@ export interface CreateEmailIdentityResponse {
|
|
|
1975
2122
|
*/
|
|
1976
2123
|
export interface CreateEmailIdentityPolicyRequest {
|
|
1977
2124
|
/**
|
|
2125
|
+
* @public
|
|
1978
2126
|
* <p>The email identity.</p>
|
|
1979
2127
|
*/
|
|
1980
2128
|
EmailIdentity: string | undefined;
|
|
1981
2129
|
/**
|
|
2130
|
+
* @public
|
|
1982
2131
|
* <p>The name of the policy.</p>
|
|
1983
2132
|
* <p>The policy name cannot exceed 64 characters and can only include alphanumeric
|
|
1984
2133
|
* characters, dashes, and underscores.</p>
|
|
1985
2134
|
*/
|
|
1986
2135
|
PolicyName: string | undefined;
|
|
1987
2136
|
/**
|
|
2137
|
+
* @public
|
|
1988
2138
|
* <p>The text of the policy in JSON format. The policy cannot exceed 4 KB.</p>
|
|
1989
2139
|
* <p>For information about the syntax of sending authorization policies, see the <a href="https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization-policies.html">Amazon SES Developer
|
|
1990
2140
|
* Guide</a>.</p>
|
|
@@ -2005,15 +2155,18 @@ export interface CreateEmailIdentityPolicyResponse {
|
|
|
2005
2155
|
*/
|
|
2006
2156
|
export interface EmailTemplateContent {
|
|
2007
2157
|
/**
|
|
2158
|
+
* @public
|
|
2008
2159
|
* <p>The subject line of the email.</p>
|
|
2009
2160
|
*/
|
|
2010
2161
|
Subject?: string;
|
|
2011
2162
|
/**
|
|
2163
|
+
* @public
|
|
2012
2164
|
* <p>The email body that will be visible to recipients whose email clients do not display
|
|
2013
2165
|
* HTML.</p>
|
|
2014
2166
|
*/
|
|
2015
2167
|
Text?: string;
|
|
2016
2168
|
/**
|
|
2169
|
+
* @public
|
|
2017
2170
|
* <p>The HTML body of the email.</p>
|
|
2018
2171
|
*/
|
|
2019
2172
|
Html?: string;
|
|
@@ -2025,10 +2178,12 @@ export interface EmailTemplateContent {
|
|
|
2025
2178
|
*/
|
|
2026
2179
|
export interface CreateEmailTemplateRequest {
|
|
2027
2180
|
/**
|
|
2181
|
+
* @public
|
|
2028
2182
|
* <p>The name of the template.</p>
|
|
2029
2183
|
*/
|
|
2030
2184
|
TemplateName: string | undefined;
|
|
2031
2185
|
/**
|
|
2186
|
+
* @public
|
|
2032
2187
|
* <p>The content of the email template, composed of a subject line, an HTML part, and a
|
|
2033
2188
|
* text-only part.</p>
|
|
2034
2189
|
*/
|
|
@@ -2059,11 +2214,13 @@ export type DataFormat = (typeof DataFormat)[keyof typeof DataFormat];
|
|
|
2059
2214
|
*/
|
|
2060
2215
|
export interface ImportDataSource {
|
|
2061
2216
|
/**
|
|
2217
|
+
* @public
|
|
2062
2218
|
* <p>An Amazon S3 URL in the format
|
|
2063
2219
|
* s3://<i><bucket_name></i>/<i><object></i>.</p>
|
|
2064
2220
|
*/
|
|
2065
2221
|
S3Url: string | undefined;
|
|
2066
2222
|
/**
|
|
2223
|
+
* @public
|
|
2067
2224
|
* <p>The data format of the import job's data source.</p>
|
|
2068
2225
|
*/
|
|
2069
2226
|
DataFormat: DataFormat | string | undefined;
|
|
@@ -2086,6 +2243,7 @@ export type SuppressionListImportAction = (typeof SuppressionListImportAction)[k
|
|
|
2086
2243
|
*/
|
|
2087
2244
|
export interface SuppressionListDestination {
|
|
2088
2245
|
/**
|
|
2246
|
+
* @public
|
|
2089
2247
|
* <p>The type of action to perform on the address. The following are possible values:</p>
|
|
2090
2248
|
* <ul>
|
|
2091
2249
|
* <li>
|
|
@@ -2106,10 +2264,12 @@ export interface SuppressionListDestination {
|
|
|
2106
2264
|
*/
|
|
2107
2265
|
export interface ImportDestination {
|
|
2108
2266
|
/**
|
|
2267
|
+
* @public
|
|
2109
2268
|
* <p>An object that contains the action of the import job towards suppression list.</p>
|
|
2110
2269
|
*/
|
|
2111
2270
|
SuppressionListDestination?: SuppressionListDestination;
|
|
2112
2271
|
/**
|
|
2272
|
+
* @public
|
|
2113
2273
|
* <p>An object that contains the action of the import job towards a contact list.</p>
|
|
2114
2274
|
*/
|
|
2115
2275
|
ContactListDestination?: ContactListDestination;
|
|
@@ -2121,10 +2281,12 @@ export interface ImportDestination {
|
|
|
2121
2281
|
*/
|
|
2122
2282
|
export interface CreateImportJobRequest {
|
|
2123
2283
|
/**
|
|
2284
|
+
* @public
|
|
2124
2285
|
* <p>The destination for the import job.</p>
|
|
2125
2286
|
*/
|
|
2126
2287
|
ImportDestination: ImportDestination | undefined;
|
|
2127
2288
|
/**
|
|
2289
|
+
* @public
|
|
2128
2290
|
* <p>The data source for the import job.</p>
|
|
2129
2291
|
*/
|
|
2130
2292
|
ImportDataSource: ImportDataSource | undefined;
|
|
@@ -2136,6 +2298,7 @@ export interface CreateImportJobRequest {
|
|
|
2136
2298
|
*/
|
|
2137
2299
|
export interface CreateImportJobResponse {
|
|
2138
2300
|
/**
|
|
2301
|
+
* @public
|
|
2139
2302
|
* <p>A string that represents the import job ID.</p>
|
|
2140
2303
|
*/
|
|
2141
2304
|
JobId?: string;
|
|
@@ -2146,23 +2309,28 @@ export interface CreateImportJobResponse {
|
|
|
2146
2309
|
*/
|
|
2147
2310
|
export interface CustomVerificationEmailTemplateMetadata {
|
|
2148
2311
|
/**
|
|
2312
|
+
* @public
|
|
2149
2313
|
* <p>The name of the custom verification email template.</p>
|
|
2150
2314
|
*/
|
|
2151
2315
|
TemplateName?: string;
|
|
2152
2316
|
/**
|
|
2317
|
+
* @public
|
|
2153
2318
|
* <p>The email address that the custom verification email is sent from.</p>
|
|
2154
2319
|
*/
|
|
2155
2320
|
FromEmailAddress?: string;
|
|
2156
2321
|
/**
|
|
2322
|
+
* @public
|
|
2157
2323
|
* <p>The subject line of the custom verification email.</p>
|
|
2158
2324
|
*/
|
|
2159
2325
|
TemplateSubject?: string;
|
|
2160
2326
|
/**
|
|
2327
|
+
* @public
|
|
2161
2328
|
* <p>The URL that the recipient of the verification email is sent to if his or her address
|
|
2162
2329
|
* is successfully verified.</p>
|
|
2163
2330
|
*/
|
|
2164
2331
|
SuccessRedirectionURL?: string;
|
|
2165
2332
|
/**
|
|
2333
|
+
* @public
|
|
2166
2334
|
* <p>The URL that the recipient of the verification email is sent to if his or her address
|
|
2167
2335
|
* is not successfully verified.</p>
|
|
2168
2336
|
*/
|
|
@@ -2175,25 +2343,30 @@ export interface CustomVerificationEmailTemplateMetadata {
|
|
|
2175
2343
|
*/
|
|
2176
2344
|
export interface DomainIspPlacement {
|
|
2177
2345
|
/**
|
|
2346
|
+
* @public
|
|
2178
2347
|
* <p>The name of the email provider that the inbox placement data applies to.</p>
|
|
2179
2348
|
*/
|
|
2180
2349
|
IspName?: string;
|
|
2181
2350
|
/**
|
|
2351
|
+
* @public
|
|
2182
2352
|
* <p>The total number of messages that were sent from the selected domain to the specified
|
|
2183
2353
|
* email provider that arrived in recipients' inboxes.</p>
|
|
2184
2354
|
*/
|
|
2185
2355
|
InboxRawCount?: number;
|
|
2186
2356
|
/**
|
|
2357
|
+
* @public
|
|
2187
2358
|
* <p>The total number of messages that were sent from the selected domain to the specified
|
|
2188
2359
|
* email provider that arrived in recipients' spam or junk mail folders.</p>
|
|
2189
2360
|
*/
|
|
2190
2361
|
SpamRawCount?: number;
|
|
2191
2362
|
/**
|
|
2363
|
+
* @public
|
|
2192
2364
|
* <p>The percentage of messages that were sent from the selected domain to the specified
|
|
2193
2365
|
* email provider that arrived in recipients' inboxes.</p>
|
|
2194
2366
|
*/
|
|
2195
2367
|
InboxPercentage?: number;
|
|
2196
2368
|
/**
|
|
2369
|
+
* @public
|
|
2197
2370
|
* <p>The percentage of messages that were sent from the selected domain to the specified
|
|
2198
2371
|
* email provider that arrived in recipients' spam or junk mail folders.</p>
|
|
2199
2372
|
*/
|
|
@@ -2206,20 +2379,24 @@ export interface DomainIspPlacement {
|
|
|
2206
2379
|
*/
|
|
2207
2380
|
export interface VolumeStatistics {
|
|
2208
2381
|
/**
|
|
2382
|
+
* @public
|
|
2209
2383
|
* <p>The total number of emails that arrived in recipients' inboxes.</p>
|
|
2210
2384
|
*/
|
|
2211
2385
|
InboxRawCount?: number;
|
|
2212
2386
|
/**
|
|
2387
|
+
* @public
|
|
2213
2388
|
* <p>The total number of emails that arrived in recipients' spam or junk mail
|
|
2214
2389
|
* folders.</p>
|
|
2215
2390
|
*/
|
|
2216
2391
|
SpamRawCount?: number;
|
|
2217
2392
|
/**
|
|
2393
|
+
* @public
|
|
2218
2394
|
* <p>An estimate of the percentage of emails sent from the current domain that will arrive
|
|
2219
2395
|
* in recipients' inboxes.</p>
|
|
2220
2396
|
*/
|
|
2221
2397
|
ProjectedInbox?: number;
|
|
2222
2398
|
/**
|
|
2399
|
+
* @public
|
|
2223
2400
|
* <p>An estimate of the percentage of emails sent from the current domain that will arrive
|
|
2224
2401
|
* in recipients' spam or junk mail folders.</p>
|
|
2225
2402
|
*/
|
|
@@ -2232,15 +2409,18 @@ export interface VolumeStatistics {
|
|
|
2232
2409
|
*/
|
|
2233
2410
|
export interface DailyVolume {
|
|
2234
2411
|
/**
|
|
2412
|
+
* @public
|
|
2235
2413
|
* <p>The date that the DailyVolume metrics apply to, in Unix time.</p>
|
|
2236
2414
|
*/
|
|
2237
2415
|
StartDate?: Date;
|
|
2238
2416
|
/**
|
|
2417
|
+
* @public
|
|
2239
2418
|
* <p>An object that contains inbox placement metrics for a specific day in the analysis
|
|
2240
2419
|
* period.</p>
|
|
2241
2420
|
*/
|
|
2242
2421
|
VolumeStatistics?: VolumeStatistics;
|
|
2243
2422
|
/**
|
|
2423
|
+
* @public
|
|
2244
2424
|
* <p>An object that contains inbox placement metrics for a specified day in the analysis
|
|
2245
2425
|
* period, broken out by the recipient's email provider.</p>
|
|
2246
2426
|
*/
|
|
@@ -2252,6 +2432,7 @@ export interface DailyVolume {
|
|
|
2252
2432
|
*/
|
|
2253
2433
|
export interface DashboardAttributes {
|
|
2254
2434
|
/**
|
|
2435
|
+
* @public
|
|
2255
2436
|
* <p>Specifies the status of your VDM engagement metrics collection. Can be one of the following:</p>
|
|
2256
2437
|
* <ul>
|
|
2257
2438
|
* <li>
|
|
@@ -2288,10 +2469,12 @@ export type WarmupStatus = (typeof WarmupStatus)[keyof typeof WarmupStatus];
|
|
|
2288
2469
|
*/
|
|
2289
2470
|
export interface DedicatedIp {
|
|
2290
2471
|
/**
|
|
2472
|
+
* @public
|
|
2291
2473
|
* <p>An IPv4 address.</p>
|
|
2292
2474
|
*/
|
|
2293
2475
|
Ip: string | undefined;
|
|
2294
2476
|
/**
|
|
2477
|
+
* @public
|
|
2295
2478
|
* <p>The warm-up status of a dedicated IP address. The status can have one of the following
|
|
2296
2479
|
* values:</p>
|
|
2297
2480
|
* <ul>
|
|
@@ -2309,11 +2492,13 @@ export interface DedicatedIp {
|
|
|
2309
2492
|
*/
|
|
2310
2493
|
WarmupStatus: WarmupStatus | string | undefined;
|
|
2311
2494
|
/**
|
|
2495
|
+
* @public
|
|
2312
2496
|
* <p>Indicates how complete the dedicated IP warm-up process is. When this value equals 1,
|
|
2313
2497
|
* the address has completed the warm-up process and is ready for use.</p>
|
|
2314
2498
|
*/
|
|
2315
2499
|
WarmupPercentage: number | undefined;
|
|
2316
2500
|
/**
|
|
2501
|
+
* @public
|
|
2317
2502
|
* <p>The name of the dedicated IP pool that the IP address is associated with.</p>
|
|
2318
2503
|
*/
|
|
2319
2504
|
PoolName?: string;
|
|
@@ -2324,10 +2509,12 @@ export interface DedicatedIp {
|
|
|
2324
2509
|
*/
|
|
2325
2510
|
export interface DedicatedIpPool {
|
|
2326
2511
|
/**
|
|
2512
|
+
* @public
|
|
2327
2513
|
* <p>The name of the dedicated IP pool.</p>
|
|
2328
2514
|
*/
|
|
2329
2515
|
PoolName: string | undefined;
|
|
2330
2516
|
/**
|
|
2517
|
+
* @public
|
|
2331
2518
|
* <p>The type of the dedicated IP pool.</p>
|
|
2332
2519
|
* <ul>
|
|
2333
2520
|
* <li>
|
|
@@ -2350,6 +2537,7 @@ export interface DedicatedIpPool {
|
|
|
2350
2537
|
*/
|
|
2351
2538
|
export interface DeleteConfigurationSetRequest {
|
|
2352
2539
|
/**
|
|
2540
|
+
* @public
|
|
2353
2541
|
* <p>The name of the configuration set.</p>
|
|
2354
2542
|
*/
|
|
2355
2543
|
ConfigurationSetName: string | undefined;
|
|
@@ -2367,11 +2555,13 @@ export interface DeleteConfigurationSetResponse {
|
|
|
2367
2555
|
*/
|
|
2368
2556
|
export interface DeleteConfigurationSetEventDestinationRequest {
|
|
2369
2557
|
/**
|
|
2558
|
+
* @public
|
|
2370
2559
|
* <p>The name of the configuration set that contains the event destination to
|
|
2371
2560
|
* delete.</p>
|
|
2372
2561
|
*/
|
|
2373
2562
|
ConfigurationSetName: string | undefined;
|
|
2374
2563
|
/**
|
|
2564
|
+
* @public
|
|
2375
2565
|
* <p>The name of the event destination to delete.</p>
|
|
2376
2566
|
*/
|
|
2377
2567
|
EventDestinationName: string | undefined;
|
|
@@ -2388,10 +2578,12 @@ export interface DeleteConfigurationSetEventDestinationResponse {
|
|
|
2388
2578
|
*/
|
|
2389
2579
|
export interface DeleteContactRequest {
|
|
2390
2580
|
/**
|
|
2581
|
+
* @public
|
|
2391
2582
|
* <p>The name of the contact list from which the contact should be removed.</p>
|
|
2392
2583
|
*/
|
|
2393
2584
|
ContactListName: string | undefined;
|
|
2394
2585
|
/**
|
|
2586
|
+
* @public
|
|
2395
2587
|
* <p>The contact's email address.</p>
|
|
2396
2588
|
*/
|
|
2397
2589
|
EmailAddress: string | undefined;
|
|
@@ -2406,6 +2598,7 @@ export interface DeleteContactResponse {
|
|
|
2406
2598
|
*/
|
|
2407
2599
|
export interface DeleteContactListRequest {
|
|
2408
2600
|
/**
|
|
2601
|
+
* @public
|
|
2409
2602
|
* <p>The name of the contact list.</p>
|
|
2410
2603
|
*/
|
|
2411
2604
|
ContactListName: string | undefined;
|
|
@@ -2421,6 +2614,7 @@ export interface DeleteContactListResponse {
|
|
|
2421
2614
|
*/
|
|
2422
2615
|
export interface DeleteCustomVerificationEmailTemplateRequest {
|
|
2423
2616
|
/**
|
|
2617
|
+
* @public
|
|
2424
2618
|
* <p>The name of the custom verification email template that you want to delete.</p>
|
|
2425
2619
|
*/
|
|
2426
2620
|
TemplateName: string | undefined;
|
|
@@ -2438,6 +2632,7 @@ export interface DeleteCustomVerificationEmailTemplateResponse {
|
|
|
2438
2632
|
*/
|
|
2439
2633
|
export interface DeleteDedicatedIpPoolRequest {
|
|
2440
2634
|
/**
|
|
2635
|
+
* @public
|
|
2441
2636
|
* <p>The name of the dedicated IP pool that you want to delete.</p>
|
|
2442
2637
|
*/
|
|
2443
2638
|
PoolName: string | undefined;
|
|
@@ -2457,6 +2652,7 @@ export interface DeleteDedicatedIpPoolResponse {
|
|
|
2457
2652
|
*/
|
|
2458
2653
|
export interface DeleteEmailIdentityRequest {
|
|
2459
2654
|
/**
|
|
2655
|
+
* @public
|
|
2460
2656
|
* <p>The identity (that is, the email address or domain) to delete.</p>
|
|
2461
2657
|
*/
|
|
2462
2658
|
EmailIdentity: string | undefined;
|
|
@@ -2476,10 +2672,12 @@ export interface DeleteEmailIdentityResponse {
|
|
|
2476
2672
|
*/
|
|
2477
2673
|
export interface DeleteEmailIdentityPolicyRequest {
|
|
2478
2674
|
/**
|
|
2675
|
+
* @public
|
|
2479
2676
|
* <p>The email identity.</p>
|
|
2480
2677
|
*/
|
|
2481
2678
|
EmailIdentity: string | undefined;
|
|
2482
2679
|
/**
|
|
2680
|
+
* @public
|
|
2483
2681
|
* <p>The name of the policy.</p>
|
|
2484
2682
|
* <p>The policy name cannot exceed 64 characters and can only include alphanumeric
|
|
2485
2683
|
* characters, dashes, and underscores.</p>
|
|
@@ -2500,6 +2698,7 @@ export interface DeleteEmailIdentityPolicyResponse {
|
|
|
2500
2698
|
*/
|
|
2501
2699
|
export interface DeleteEmailTemplateRequest {
|
|
2502
2700
|
/**
|
|
2701
|
+
* @public
|
|
2503
2702
|
* <p>The name of the template to be deleted.</p>
|
|
2504
2703
|
*/
|
|
2505
2704
|
TemplateName: string | undefined;
|
|
@@ -2518,6 +2717,7 @@ export interface DeleteEmailTemplateResponse {
|
|
|
2518
2717
|
*/
|
|
2519
2718
|
export interface DeleteSuppressedDestinationRequest {
|
|
2520
2719
|
/**
|
|
2720
|
+
* @public
|
|
2521
2721
|
* <p>The suppressed email destination to remove from the account suppression list.</p>
|
|
2522
2722
|
*/
|
|
2523
2723
|
EmailAddress: string | undefined;
|
|
@@ -2548,26 +2748,32 @@ export type DeliverabilityDashboardAccountStatus = (typeof DeliverabilityDashboa
|
|
|
2548
2748
|
*/
|
|
2549
2749
|
export interface DeliverabilityTestReport {
|
|
2550
2750
|
/**
|
|
2751
|
+
* @public
|
|
2551
2752
|
* <p>A unique string that identifies the predictive inbox placement test.</p>
|
|
2552
2753
|
*/
|
|
2553
2754
|
ReportId?: string;
|
|
2554
2755
|
/**
|
|
2756
|
+
* @public
|
|
2555
2757
|
* <p>A name that helps you identify a predictive inbox placement test report.</p>
|
|
2556
2758
|
*/
|
|
2557
2759
|
ReportName?: string;
|
|
2558
2760
|
/**
|
|
2761
|
+
* @public
|
|
2559
2762
|
* <p>The subject line for an email that you submitted in a predictive inbox placement test.</p>
|
|
2560
2763
|
*/
|
|
2561
2764
|
Subject?: string;
|
|
2562
2765
|
/**
|
|
2766
|
+
* @public
|
|
2563
2767
|
* <p>The sender address that you specified for the predictive inbox placement test.</p>
|
|
2564
2768
|
*/
|
|
2565
2769
|
FromEmailAddress?: string;
|
|
2566
2770
|
/**
|
|
2771
|
+
* @public
|
|
2567
2772
|
* <p>The date and time when the predictive inbox placement test was created.</p>
|
|
2568
2773
|
*/
|
|
2569
2774
|
CreateDate?: Date;
|
|
2570
2775
|
/**
|
|
2776
|
+
* @public
|
|
2571
2777
|
* <p>The status of the predictive inbox placement test. If the status is <code>IN_PROGRESS</code>, then the predictive inbox placement test
|
|
2572
2778
|
* is currently running. Predictive inbox placement tests are usually complete within 24 hours of creating the
|
|
2573
2779
|
* test. If the status is <code>COMPLETE</code>, then the test is finished, and you can use
|
|
@@ -2584,71 +2790,85 @@ export interface DeliverabilityTestReport {
|
|
|
2584
2790
|
*/
|
|
2585
2791
|
export interface DomainDeliverabilityCampaign {
|
|
2586
2792
|
/**
|
|
2793
|
+
* @public
|
|
2587
2794
|
* <p>The unique identifier for the campaign. The Deliverability dashboard automatically generates
|
|
2588
2795
|
* and assigns this identifier to a campaign.</p>
|
|
2589
2796
|
*/
|
|
2590
2797
|
CampaignId?: string;
|
|
2591
2798
|
/**
|
|
2799
|
+
* @public
|
|
2592
2800
|
* <p>The URL of an image that contains a snapshot of the email message that was
|
|
2593
2801
|
* sent.</p>
|
|
2594
2802
|
*/
|
|
2595
2803
|
ImageUrl?: string;
|
|
2596
2804
|
/**
|
|
2805
|
+
* @public
|
|
2597
2806
|
* <p>The subject line, or title, of the email message.</p>
|
|
2598
2807
|
*/
|
|
2599
2808
|
Subject?: string;
|
|
2600
2809
|
/**
|
|
2810
|
+
* @public
|
|
2601
2811
|
* <p>The verified email address that the email message was sent from.</p>
|
|
2602
2812
|
*/
|
|
2603
2813
|
FromAddress?: string;
|
|
2604
2814
|
/**
|
|
2815
|
+
* @public
|
|
2605
2816
|
* <p>The IP addresses that were used to send the email message.</p>
|
|
2606
2817
|
*/
|
|
2607
2818
|
SendingIps?: string[];
|
|
2608
2819
|
/**
|
|
2820
|
+
* @public
|
|
2609
2821
|
* <p>The first time when the email message was delivered to any
|
|
2610
2822
|
* recipient's inbox. This value can help you determine how long it took for a campaign to
|
|
2611
2823
|
* deliver an email message.</p>
|
|
2612
2824
|
*/
|
|
2613
2825
|
FirstSeenDateTime?: Date;
|
|
2614
2826
|
/**
|
|
2827
|
+
* @public
|
|
2615
2828
|
* <p>The last time when the email message was delivered to any
|
|
2616
2829
|
* recipient's inbox. This value can help you determine how long it took for a campaign to
|
|
2617
2830
|
* deliver an email message.</p>
|
|
2618
2831
|
*/
|
|
2619
2832
|
LastSeenDateTime?: Date;
|
|
2620
2833
|
/**
|
|
2834
|
+
* @public
|
|
2621
2835
|
* <p>The number of email messages that were delivered to recipients’ inboxes.</p>
|
|
2622
2836
|
*/
|
|
2623
2837
|
InboxCount?: number;
|
|
2624
2838
|
/**
|
|
2839
|
+
* @public
|
|
2625
2840
|
* <p>The number of email messages that were delivered to recipients' spam or junk mail
|
|
2626
2841
|
* folders.</p>
|
|
2627
2842
|
*/
|
|
2628
2843
|
SpamCount?: number;
|
|
2629
2844
|
/**
|
|
2845
|
+
* @public
|
|
2630
2846
|
* <p>The percentage of email messages that were opened by recipients. Due to technical
|
|
2631
2847
|
* limitations, this value only includes recipients who opened the message by using an
|
|
2632
2848
|
* email client that supports images.</p>
|
|
2633
2849
|
*/
|
|
2634
2850
|
ReadRate?: number;
|
|
2635
2851
|
/**
|
|
2852
|
+
* @public
|
|
2636
2853
|
* <p>The percentage of email messages that were deleted by recipients, without being opened
|
|
2637
2854
|
* first. Due to technical limitations, this value only includes recipients who opened the
|
|
2638
2855
|
* message by using an email client that supports images.</p>
|
|
2639
2856
|
*/
|
|
2640
2857
|
DeleteRate?: number;
|
|
2641
2858
|
/**
|
|
2859
|
+
* @public
|
|
2642
2860
|
* <p>The percentage of email messages that were opened and then deleted by recipients. Due
|
|
2643
2861
|
* to technical limitations, this value only includes recipients who opened the message by
|
|
2644
2862
|
* using an email client that supports images.</p>
|
|
2645
2863
|
*/
|
|
2646
2864
|
ReadDeleteRate?: number;
|
|
2647
2865
|
/**
|
|
2866
|
+
* @public
|
|
2648
2867
|
* <p>The projected number of recipients that the email message was sent to.</p>
|
|
2649
2868
|
*/
|
|
2650
2869
|
ProjectedVolume?: number;
|
|
2651
2870
|
/**
|
|
2871
|
+
* @public
|
|
2652
2872
|
* <p>The major email providers who handled the email message.</p>
|
|
2653
2873
|
*/
|
|
2654
2874
|
Esps?: string[];
|
|
@@ -2661,10 +2881,12 @@ export interface DomainDeliverabilityCampaign {
|
|
|
2661
2881
|
*/
|
|
2662
2882
|
export interface InboxPlacementTrackingOption {
|
|
2663
2883
|
/**
|
|
2884
|
+
* @public
|
|
2664
2885
|
* <p>Specifies whether inbox placement data is being tracked for the domain.</p>
|
|
2665
2886
|
*/
|
|
2666
2887
|
Global?: boolean;
|
|
2667
2888
|
/**
|
|
2889
|
+
* @public
|
|
2668
2890
|
* <p>An array of strings, one for each major email provider that the inbox placement data
|
|
2669
2891
|
* applies to.</p>
|
|
2670
2892
|
*/
|
|
@@ -2679,16 +2901,19 @@ export interface InboxPlacementTrackingOption {
|
|
|
2679
2901
|
*/
|
|
2680
2902
|
export interface DomainDeliverabilityTrackingOption {
|
|
2681
2903
|
/**
|
|
2904
|
+
* @public
|
|
2682
2905
|
* <p>A verified domain that’s associated with your Amazon Web Services account and currently has an
|
|
2683
2906
|
* active Deliverability dashboard subscription.</p>
|
|
2684
2907
|
*/
|
|
2685
2908
|
Domain?: string;
|
|
2686
2909
|
/**
|
|
2910
|
+
* @public
|
|
2687
2911
|
* <p>The date when you enabled the Deliverability dashboard for the
|
|
2688
2912
|
* domain.</p>
|
|
2689
2913
|
*/
|
|
2690
2914
|
SubscriptionStartDate?: Date;
|
|
2691
2915
|
/**
|
|
2916
|
+
* @public
|
|
2692
2917
|
* <p>An object that contains information about the inbox placement data settings for the
|
|
2693
2918
|
* domain.</p>
|
|
2694
2919
|
*/
|
|
@@ -2700,10 +2925,12 @@ export interface DomainDeliverabilityTrackingOption {
|
|
|
2700
2925
|
*/
|
|
2701
2926
|
export interface EmailTemplateMetadata {
|
|
2702
2927
|
/**
|
|
2928
|
+
* @public
|
|
2703
2929
|
* <p>The name of the template.</p>
|
|
2704
2930
|
*/
|
|
2705
2931
|
TemplateName?: string;
|
|
2706
2932
|
/**
|
|
2933
|
+
* @public
|
|
2707
2934
|
* <p>The time and date the template was created.</p>
|
|
2708
2935
|
*/
|
|
2709
2936
|
CreatedTimestamp?: Date;
|
|
@@ -2718,10 +2945,12 @@ export interface EmailTemplateMetadata {
|
|
|
2718
2945
|
*/
|
|
2719
2946
|
export interface EventDestination {
|
|
2720
2947
|
/**
|
|
2948
|
+
* @public
|
|
2721
2949
|
* <p>A name that identifies the event destination.</p>
|
|
2722
2950
|
*/
|
|
2723
2951
|
Name: string | undefined;
|
|
2724
2952
|
/**
|
|
2953
|
+
* @public
|
|
2725
2954
|
* <p>If <code>true</code>, the event destination is enabled. When the event destination is
|
|
2726
2955
|
* enabled, the specified event types are sent to the destinations in this
|
|
2727
2956
|
* <code>EventDestinationDefinition</code>.</p>
|
|
@@ -2730,6 +2959,7 @@ export interface EventDestination {
|
|
|
2730
2959
|
*/
|
|
2731
2960
|
Enabled?: boolean;
|
|
2732
2961
|
/**
|
|
2962
|
+
* @public
|
|
2733
2963
|
* <p>The types of events that Amazon SES sends to the specified event destinations.</p>
|
|
2734
2964
|
* <ul>
|
|
2735
2965
|
* <li>
|
|
@@ -2801,21 +3031,25 @@ export interface EventDestination {
|
|
|
2801
3031
|
*/
|
|
2802
3032
|
MatchingEventTypes: (EventType | string)[] | undefined;
|
|
2803
3033
|
/**
|
|
3034
|
+
* @public
|
|
2804
3035
|
* <p>An object that defines an Amazon Kinesis Data Firehose destination for email events. You can use Amazon Kinesis Data Firehose to
|
|
2805
3036
|
* stream data to other services, such as Amazon S3 and Amazon Redshift.</p>
|
|
2806
3037
|
*/
|
|
2807
3038
|
KinesisFirehoseDestination?: KinesisFirehoseDestination;
|
|
2808
3039
|
/**
|
|
3040
|
+
* @public
|
|
2809
3041
|
* <p>An object that defines an Amazon CloudWatch destination for email events. You can use Amazon CloudWatch to
|
|
2810
3042
|
* monitor and gain insights on your email sending metrics.</p>
|
|
2811
3043
|
*/
|
|
2812
3044
|
CloudWatchDestination?: CloudWatchDestination;
|
|
2813
3045
|
/**
|
|
3046
|
+
* @public
|
|
2814
3047
|
* <p>An object that defines an Amazon SNS destination for email events. You can use Amazon SNS to
|
|
2815
3048
|
* send notification when certain email events occur.</p>
|
|
2816
3049
|
*/
|
|
2817
3050
|
SnsDestination?: SnsDestination;
|
|
2818
3051
|
/**
|
|
3052
|
+
* @public
|
|
2819
3053
|
* <p>An object that defines an Amazon Pinpoint project destination for email events. You can send
|
|
2820
3054
|
* email event data to a Amazon Pinpoint project to view metrics using the Transactional Messaging
|
|
2821
3055
|
* dashboards that are built in to Amazon Pinpoint. For more information, see <a href="https://docs.aws.amazon.com/pinpoint/latest/userguide/analytics-transactional-messages.html">Transactional
|
|
@@ -2829,11 +3063,13 @@ export interface EventDestination {
|
|
|
2829
3063
|
*/
|
|
2830
3064
|
export interface FailureInfo {
|
|
2831
3065
|
/**
|
|
3066
|
+
* @public
|
|
2832
3067
|
* <p>An Amazon S3 presigned URL that contains all the failed records and related
|
|
2833
3068
|
* information.</p>
|
|
2834
3069
|
*/
|
|
2835
3070
|
FailedRecordsS3Url?: string;
|
|
2836
3071
|
/**
|
|
3072
|
+
* @public
|
|
2837
3073
|
* <p>A message about why the import job failed.</p>
|
|
2838
3074
|
*/
|
|
2839
3075
|
ErrorMessage?: string;
|
|
@@ -2852,18 +3088,21 @@ export interface GetAccountRequest {
|
|
|
2852
3088
|
*/
|
|
2853
3089
|
export interface SendQuota {
|
|
2854
3090
|
/**
|
|
3091
|
+
* @public
|
|
2855
3092
|
* <p>The maximum number of emails that you can send in the current Amazon Web Services Region over a
|
|
2856
3093
|
* 24-hour period. A value of -1 signifies an unlimited quota. (This value is also referred
|
|
2857
3094
|
* to as your <i>sending quota</i>.)</p>
|
|
2858
3095
|
*/
|
|
2859
3096
|
Max24HourSend?: number;
|
|
2860
3097
|
/**
|
|
3098
|
+
* @public
|
|
2861
3099
|
* <p>The maximum number of emails that you can send per second in the current Amazon Web Services Region.
|
|
2862
3100
|
* This value is also called your <i>maximum sending rate</i> or your
|
|
2863
3101
|
* <i>maximum TPS (transactions per second) rate</i>.</p>
|
|
2864
3102
|
*/
|
|
2865
3103
|
MaxSendRate?: number;
|
|
2866
3104
|
/**
|
|
3105
|
+
* @public
|
|
2867
3106
|
* <p>The number of emails sent from your Amazon SES account in the current Amazon Web Services Region over the
|
|
2868
3107
|
* past 24 hours.</p>
|
|
2869
3108
|
*/
|
|
@@ -2876,6 +3115,7 @@ export interface SendQuota {
|
|
|
2876
3115
|
*/
|
|
2877
3116
|
export interface SuppressionAttributes {
|
|
2878
3117
|
/**
|
|
3118
|
+
* @public
|
|
2879
3119
|
* <p>A list that contains the reasons that email addresses will be automatically added to
|
|
2880
3120
|
* the suppression list for your account. This list can contain any or all of the
|
|
2881
3121
|
* following:</p>
|
|
@@ -2902,6 +3142,7 @@ export interface SuppressionAttributes {
|
|
|
2902
3142
|
*/
|
|
2903
3143
|
export interface GuardianAttributes {
|
|
2904
3144
|
/**
|
|
3145
|
+
* @public
|
|
2905
3146
|
* <p>Specifies the status of your VDM optimized shared delivery. Can be one of the following:</p>
|
|
2906
3147
|
* <ul>
|
|
2907
3148
|
* <li>
|
|
@@ -2922,6 +3163,7 @@ export interface GuardianAttributes {
|
|
|
2922
3163
|
*/
|
|
2923
3164
|
export interface VdmAttributes {
|
|
2924
3165
|
/**
|
|
3166
|
+
* @public
|
|
2925
3167
|
* <p>Specifies the status of your VDM configuration. Can be one of the following:</p>
|
|
2926
3168
|
* <ul>
|
|
2927
3169
|
* <li>
|
|
@@ -2936,10 +3178,12 @@ export interface VdmAttributes {
|
|
|
2936
3178
|
*/
|
|
2937
3179
|
VdmEnabled: FeatureStatus | string | undefined;
|
|
2938
3180
|
/**
|
|
3181
|
+
* @public
|
|
2939
3182
|
* <p>Specifies additional settings for your VDM configuration as applicable to the Dashboard.</p>
|
|
2940
3183
|
*/
|
|
2941
3184
|
DashboardAttributes?: DashboardAttributes;
|
|
2942
3185
|
/**
|
|
3186
|
+
* @public
|
|
2943
3187
|
* <p>Specifies additional settings for your VDM configuration as applicable to the Guardian.</p>
|
|
2944
3188
|
*/
|
|
2945
3189
|
GuardianAttributes?: GuardianAttributes;
|
|
@@ -2951,11 +3195,13 @@ export interface VdmAttributes {
|
|
|
2951
3195
|
*/
|
|
2952
3196
|
export interface GetAccountResponse {
|
|
2953
3197
|
/**
|
|
3198
|
+
* @public
|
|
2954
3199
|
* <p>Indicates whether or not the automatic warm-up feature is enabled for dedicated IP
|
|
2955
3200
|
* addresses that are associated with your account.</p>
|
|
2956
3201
|
*/
|
|
2957
3202
|
DedicatedIpAutoWarmupEnabled?: boolean;
|
|
2958
3203
|
/**
|
|
3204
|
+
* @public
|
|
2959
3205
|
* <p>The reputation status of your Amazon SES account. The status can be one of the
|
|
2960
3206
|
* following:</p>
|
|
2961
3207
|
* <ul>
|
|
@@ -2981,6 +3227,7 @@ export interface GetAccountResponse {
|
|
|
2981
3227
|
*/
|
|
2982
3228
|
EnforcementStatus?: string;
|
|
2983
3229
|
/**
|
|
3230
|
+
* @public
|
|
2984
3231
|
* <p>Indicates whether or not your account has production access in the current Amazon Web Services
|
|
2985
3232
|
* Region.</p>
|
|
2986
3233
|
* <p>If the value is <code>false</code>, then your account is in the
|
|
@@ -2994,25 +3241,30 @@ export interface GetAccountResponse {
|
|
|
2994
3241
|
*/
|
|
2995
3242
|
ProductionAccessEnabled?: boolean;
|
|
2996
3243
|
/**
|
|
3244
|
+
* @public
|
|
2997
3245
|
* <p>An object that contains information about the per-day and per-second sending limits
|
|
2998
3246
|
* for your Amazon SES account in the current Amazon Web Services Region.</p>
|
|
2999
3247
|
*/
|
|
3000
3248
|
SendQuota?: SendQuota;
|
|
3001
3249
|
/**
|
|
3250
|
+
* @public
|
|
3002
3251
|
* <p>Indicates whether or not email sending is enabled for your Amazon SES account in the
|
|
3003
3252
|
* current Amazon Web Services Region.</p>
|
|
3004
3253
|
*/
|
|
3005
3254
|
SendingEnabled?: boolean;
|
|
3006
3255
|
/**
|
|
3256
|
+
* @public
|
|
3007
3257
|
* <p>An object that contains information about the email address suppression preferences
|
|
3008
3258
|
* for your account in the current Amazon Web Services Region.</p>
|
|
3009
3259
|
*/
|
|
3010
3260
|
SuppressionAttributes?: SuppressionAttributes;
|
|
3011
3261
|
/**
|
|
3262
|
+
* @public
|
|
3012
3263
|
* <p>An object that defines your account details.</p>
|
|
3013
3264
|
*/
|
|
3014
3265
|
Details?: AccountDetails;
|
|
3015
3266
|
/**
|
|
3267
|
+
* @public
|
|
3016
3268
|
* <p>The VDM attributes that apply to your Amazon SES account.</p>
|
|
3017
3269
|
*/
|
|
3018
3270
|
VdmAttributes?: VdmAttributes;
|
|
@@ -3024,6 +3276,7 @@ export interface GetAccountResponse {
|
|
|
3024
3276
|
*/
|
|
3025
3277
|
export interface GetBlacklistReportsRequest {
|
|
3026
3278
|
/**
|
|
3279
|
+
* @public
|
|
3027
3280
|
* <p>A list of IP addresses that you want to retrieve blacklist information about. You can
|
|
3028
3281
|
* only specify the dedicated IP addresses that you use to send email using Amazon SES or
|
|
3029
3282
|
* Amazon Pinpoint.</p>
|
|
@@ -3036,6 +3289,7 @@ export interface GetBlacklistReportsRequest {
|
|
|
3036
3289
|
*/
|
|
3037
3290
|
export interface GetBlacklistReportsResponse {
|
|
3038
3291
|
/**
|
|
3292
|
+
* @public
|
|
3039
3293
|
* <p>An object that contains information about a blacklist that one of your dedicated IP
|
|
3040
3294
|
* addresses appears on.</p>
|
|
3041
3295
|
*/
|
|
@@ -3047,6 +3301,7 @@ export interface GetBlacklistReportsResponse {
|
|
|
3047
3301
|
*/
|
|
3048
3302
|
export interface GetConfigurationSetRequest {
|
|
3049
3303
|
/**
|
|
3304
|
+
* @public
|
|
3050
3305
|
* <p>The name of the configuration set.</p>
|
|
3051
3306
|
*/
|
|
3052
3307
|
ConfigurationSetName: string | undefined;
|
|
@@ -3057,40 +3312,48 @@ export interface GetConfigurationSetRequest {
|
|
|
3057
3312
|
*/
|
|
3058
3313
|
export interface GetConfigurationSetResponse {
|
|
3059
3314
|
/**
|
|
3315
|
+
* @public
|
|
3060
3316
|
* <p>The name of the configuration set.</p>
|
|
3061
3317
|
*/
|
|
3062
3318
|
ConfigurationSetName?: string;
|
|
3063
3319
|
/**
|
|
3320
|
+
* @public
|
|
3064
3321
|
* <p>An object that defines the open and click tracking options for emails that you send
|
|
3065
3322
|
* using the configuration set.</p>
|
|
3066
3323
|
*/
|
|
3067
3324
|
TrackingOptions?: TrackingOptions;
|
|
3068
3325
|
/**
|
|
3326
|
+
* @public
|
|
3069
3327
|
* <p>An object that defines the dedicated IP pool that is used to send emails that you send
|
|
3070
3328
|
* using the configuration set.</p>
|
|
3071
3329
|
*/
|
|
3072
3330
|
DeliveryOptions?: DeliveryOptions;
|
|
3073
3331
|
/**
|
|
3332
|
+
* @public
|
|
3074
3333
|
* <p>An object that defines whether or not Amazon SES collects reputation metrics for the emails
|
|
3075
3334
|
* that you send that use the configuration set.</p>
|
|
3076
3335
|
*/
|
|
3077
3336
|
ReputationOptions?: ReputationOptions;
|
|
3078
3337
|
/**
|
|
3338
|
+
* @public
|
|
3079
3339
|
* <p>An object that defines whether or not Amazon SES can send email that you send using the
|
|
3080
3340
|
* configuration set.</p>
|
|
3081
3341
|
*/
|
|
3082
3342
|
SendingOptions?: SendingOptions;
|
|
3083
3343
|
/**
|
|
3344
|
+
* @public
|
|
3084
3345
|
* <p>An array of objects that define the tags (keys and values) that are associated with
|
|
3085
3346
|
* the configuration set.</p>
|
|
3086
3347
|
*/
|
|
3087
3348
|
Tags?: Tag[];
|
|
3088
3349
|
/**
|
|
3350
|
+
* @public
|
|
3089
3351
|
* <p>An object that contains information about the suppression list preferences for your
|
|
3090
3352
|
* account.</p>
|
|
3091
3353
|
*/
|
|
3092
3354
|
SuppressionOptions?: SuppressionOptions;
|
|
3093
3355
|
/**
|
|
3356
|
+
* @public
|
|
3094
3357
|
* <p>An object that contains information about the VDM preferences for your configuration
|
|
3095
3358
|
* set.</p>
|
|
3096
3359
|
*/
|
|
@@ -3103,6 +3366,7 @@ export interface GetConfigurationSetResponse {
|
|
|
3103
3366
|
*/
|
|
3104
3367
|
export interface GetConfigurationSetEventDestinationsRequest {
|
|
3105
3368
|
/**
|
|
3369
|
+
* @public
|
|
3106
3370
|
* <p>The name of the configuration set that contains the event destination.</p>
|
|
3107
3371
|
*/
|
|
3108
3372
|
ConfigurationSetName: string | undefined;
|
|
@@ -3113,6 +3377,7 @@ export interface GetConfigurationSetEventDestinationsRequest {
|
|
|
3113
3377
|
*/
|
|
3114
3378
|
export interface GetConfigurationSetEventDestinationsResponse {
|
|
3115
3379
|
/**
|
|
3380
|
+
* @public
|
|
3116
3381
|
* <p>An array that includes all of the events destinations that have been configured for
|
|
3117
3382
|
* the configuration set.</p>
|
|
3118
3383
|
*/
|
|
@@ -3123,10 +3388,12 @@ export interface GetConfigurationSetEventDestinationsResponse {
|
|
|
3123
3388
|
*/
|
|
3124
3389
|
export interface GetContactRequest {
|
|
3125
3390
|
/**
|
|
3391
|
+
* @public
|
|
3126
3392
|
* <p>The name of the contact list to which the contact belongs.</p>
|
|
3127
3393
|
*/
|
|
3128
3394
|
ContactListName: string | undefined;
|
|
3129
3395
|
/**
|
|
3396
|
+
* @public
|
|
3130
3397
|
* <p>The contact's email address.</p>
|
|
3131
3398
|
*/
|
|
3132
3399
|
EmailAddress: string | undefined;
|
|
@@ -3136,35 +3403,43 @@ export interface GetContactRequest {
|
|
|
3136
3403
|
*/
|
|
3137
3404
|
export interface GetContactResponse {
|
|
3138
3405
|
/**
|
|
3406
|
+
* @public
|
|
3139
3407
|
* <p>The name of the contact list to which the contact belongs.</p>
|
|
3140
3408
|
*/
|
|
3141
3409
|
ContactListName?: string;
|
|
3142
3410
|
/**
|
|
3411
|
+
* @public
|
|
3143
3412
|
* <p>The contact's email address.</p>
|
|
3144
3413
|
*/
|
|
3145
3414
|
EmailAddress?: string;
|
|
3146
3415
|
/**
|
|
3416
|
+
* @public
|
|
3147
3417
|
* <p>The contact's preference for being opted-in to or opted-out of a topic.></p>
|
|
3148
3418
|
*/
|
|
3149
3419
|
TopicPreferences?: TopicPreference[];
|
|
3150
3420
|
/**
|
|
3421
|
+
* @public
|
|
3151
3422
|
* <p>The default topic preferences applied to the contact.</p>
|
|
3152
3423
|
*/
|
|
3153
3424
|
TopicDefaultPreferences?: TopicPreference[];
|
|
3154
3425
|
/**
|
|
3426
|
+
* @public
|
|
3155
3427
|
* <p>A boolean value status noting if the contact is unsubscribed from all contact list
|
|
3156
3428
|
* topics.</p>
|
|
3157
3429
|
*/
|
|
3158
3430
|
UnsubscribeAll?: boolean;
|
|
3159
3431
|
/**
|
|
3432
|
+
* @public
|
|
3160
3433
|
* <p>The attribute data attached to a contact.</p>
|
|
3161
3434
|
*/
|
|
3162
3435
|
AttributesData?: string;
|
|
3163
3436
|
/**
|
|
3437
|
+
* @public
|
|
3164
3438
|
* <p>A timestamp noting when the contact was created.</p>
|
|
3165
3439
|
*/
|
|
3166
3440
|
CreatedTimestamp?: Date;
|
|
3167
3441
|
/**
|
|
3442
|
+
* @public
|
|
3168
3443
|
* <p>A timestamp noting the last time the contact's information was updated.</p>
|
|
3169
3444
|
*/
|
|
3170
3445
|
LastUpdatedTimestamp?: Date;
|
|
@@ -3174,6 +3449,7 @@ export interface GetContactResponse {
|
|
|
3174
3449
|
*/
|
|
3175
3450
|
export interface GetContactListRequest {
|
|
3176
3451
|
/**
|
|
3452
|
+
* @public
|
|
3177
3453
|
* <p>The name of the contact list.</p>
|
|
3178
3454
|
*/
|
|
3179
3455
|
ContactListName: string | undefined;
|
|
@@ -3183,27 +3459,33 @@ export interface GetContactListRequest {
|
|
|
3183
3459
|
*/
|
|
3184
3460
|
export interface GetContactListResponse {
|
|
3185
3461
|
/**
|
|
3462
|
+
* @public
|
|
3186
3463
|
* <p>The name of the contact list.</p>
|
|
3187
3464
|
*/
|
|
3188
3465
|
ContactListName?: string;
|
|
3189
3466
|
/**
|
|
3467
|
+
* @public
|
|
3190
3468
|
* <p>An interest group, theme, or label within a list. A contact list can have multiple
|
|
3191
3469
|
* topics.</p>
|
|
3192
3470
|
*/
|
|
3193
3471
|
Topics?: Topic[];
|
|
3194
3472
|
/**
|
|
3473
|
+
* @public
|
|
3195
3474
|
* <p>A description of what the contact list is about.</p>
|
|
3196
3475
|
*/
|
|
3197
3476
|
Description?: string;
|
|
3198
3477
|
/**
|
|
3478
|
+
* @public
|
|
3199
3479
|
* <p>A timestamp noting when the contact list was created.</p>
|
|
3200
3480
|
*/
|
|
3201
3481
|
CreatedTimestamp?: Date;
|
|
3202
3482
|
/**
|
|
3483
|
+
* @public
|
|
3203
3484
|
* <p>A timestamp noting the last time the contact list was updated.</p>
|
|
3204
3485
|
*/
|
|
3205
3486
|
LastUpdatedTimestamp?: Date;
|
|
3206
3487
|
/**
|
|
3488
|
+
* @public
|
|
3207
3489
|
* <p>The tags associated with a contact list.</p>
|
|
3208
3490
|
*/
|
|
3209
3491
|
Tags?: Tag[];
|
|
@@ -3215,6 +3497,7 @@ export interface GetContactListResponse {
|
|
|
3215
3497
|
*/
|
|
3216
3498
|
export interface GetCustomVerificationEmailTemplateRequest {
|
|
3217
3499
|
/**
|
|
3500
|
+
* @public
|
|
3218
3501
|
* <p>The name of the custom verification email template that you want to retrieve.</p>
|
|
3219
3502
|
*/
|
|
3220
3503
|
TemplateName: string | undefined;
|
|
@@ -3225,27 +3508,33 @@ export interface GetCustomVerificationEmailTemplateRequest {
|
|
|
3225
3508
|
*/
|
|
3226
3509
|
export interface GetCustomVerificationEmailTemplateResponse {
|
|
3227
3510
|
/**
|
|
3511
|
+
* @public
|
|
3228
3512
|
* <p>The name of the custom verification email template.</p>
|
|
3229
3513
|
*/
|
|
3230
3514
|
TemplateName?: string;
|
|
3231
3515
|
/**
|
|
3516
|
+
* @public
|
|
3232
3517
|
* <p>The email address that the custom verification email is sent from.</p>
|
|
3233
3518
|
*/
|
|
3234
3519
|
FromEmailAddress?: string;
|
|
3235
3520
|
/**
|
|
3521
|
+
* @public
|
|
3236
3522
|
* <p>The subject line of the custom verification email.</p>
|
|
3237
3523
|
*/
|
|
3238
3524
|
TemplateSubject?: string;
|
|
3239
3525
|
/**
|
|
3526
|
+
* @public
|
|
3240
3527
|
* <p>The content of the custom verification email.</p>
|
|
3241
3528
|
*/
|
|
3242
3529
|
TemplateContent?: string;
|
|
3243
3530
|
/**
|
|
3531
|
+
* @public
|
|
3244
3532
|
* <p>The URL that the recipient of the verification email is sent to if his or her address
|
|
3245
3533
|
* is successfully verified.</p>
|
|
3246
3534
|
*/
|
|
3247
3535
|
SuccessRedirectionURL?: string;
|
|
3248
3536
|
/**
|
|
3537
|
+
* @public
|
|
3249
3538
|
* <p>The URL that the recipient of the verification email is sent to if his or her address
|
|
3250
3539
|
* is not successfully verified.</p>
|
|
3251
3540
|
*/
|
|
@@ -3257,6 +3546,7 @@ export interface GetCustomVerificationEmailTemplateResponse {
|
|
|
3257
3546
|
*/
|
|
3258
3547
|
export interface GetDedicatedIpRequest {
|
|
3259
3548
|
/**
|
|
3549
|
+
* @public
|
|
3260
3550
|
* <p>The IP address that you want to obtain more information about. The value you specify
|
|
3261
3551
|
* has to be a dedicated IP address that's assocaited with your Amazon Web Services account.</p>
|
|
3262
3552
|
*/
|
|
@@ -3268,6 +3558,7 @@ export interface GetDedicatedIpRequest {
|
|
|
3268
3558
|
*/
|
|
3269
3559
|
export interface GetDedicatedIpResponse {
|
|
3270
3560
|
/**
|
|
3561
|
+
* @public
|
|
3271
3562
|
* <p>An object that contains information about a dedicated IP address.</p>
|
|
3272
3563
|
*/
|
|
3273
3564
|
DedicatedIp?: DedicatedIp;
|
|
@@ -3278,6 +3569,7 @@ export interface GetDedicatedIpResponse {
|
|
|
3278
3569
|
*/
|
|
3279
3570
|
export interface GetDedicatedIpPoolRequest {
|
|
3280
3571
|
/**
|
|
3572
|
+
* @public
|
|
3281
3573
|
* <p>The name of the dedicated IP pool to retrieve.</p>
|
|
3282
3574
|
*/
|
|
3283
3575
|
PoolName: string | undefined;
|
|
@@ -3288,6 +3580,7 @@ export interface GetDedicatedIpPoolRequest {
|
|
|
3288
3580
|
*/
|
|
3289
3581
|
export interface GetDedicatedIpPoolResponse {
|
|
3290
3582
|
/**
|
|
3583
|
+
* @public
|
|
3291
3584
|
* <p>An object that contains information about a dedicated IP pool.</p>
|
|
3292
3585
|
*/
|
|
3293
3586
|
DedicatedIpPool?: DedicatedIpPool;
|
|
@@ -3298,15 +3591,18 @@ export interface GetDedicatedIpPoolResponse {
|
|
|
3298
3591
|
*/
|
|
3299
3592
|
export interface GetDedicatedIpsRequest {
|
|
3300
3593
|
/**
|
|
3594
|
+
* @public
|
|
3301
3595
|
* <p>The name of the IP pool that the dedicated IP address is associated with.</p>
|
|
3302
3596
|
*/
|
|
3303
3597
|
PoolName?: string;
|
|
3304
3598
|
/**
|
|
3599
|
+
* @public
|
|
3305
3600
|
* <p>A token returned from a previous call to <code>GetDedicatedIps</code> to indicate the
|
|
3306
3601
|
* position of the dedicated IP pool in the list of IP pools.</p>
|
|
3307
3602
|
*/
|
|
3308
3603
|
NextToken?: string;
|
|
3309
3604
|
/**
|
|
3605
|
+
* @public
|
|
3310
3606
|
* <p>The number of results to show in a single call to <code>GetDedicatedIpsRequest</code>.
|
|
3311
3607
|
* If the number of results is larger than the number you specified in this parameter, then
|
|
3312
3608
|
* the response includes a <code>NextToken</code> element, which you can use to obtain
|
|
@@ -3321,10 +3617,12 @@ export interface GetDedicatedIpsRequest {
|
|
|
3321
3617
|
*/
|
|
3322
3618
|
export interface GetDedicatedIpsResponse {
|
|
3323
3619
|
/**
|
|
3620
|
+
* @public
|
|
3324
3621
|
* <p>A list of dedicated IP addresses that are associated with your Amazon Web Services account.</p>
|
|
3325
3622
|
*/
|
|
3326
3623
|
DedicatedIps?: DedicatedIp[];
|
|
3327
3624
|
/**
|
|
3625
|
+
* @public
|
|
3328
3626
|
* <p>A token that indicates that there are additional dedicated IP addresses to list. To
|
|
3329
3627
|
* view additional addresses, issue another request to <code>GetDedicatedIps</code>,
|
|
3330
3628
|
* passing this token in the <code>NextToken</code> parameter.</p>
|
|
@@ -3348,11 +3646,13 @@ export interface GetDeliverabilityDashboardOptionsRequest {
|
|
|
3348
3646
|
*/
|
|
3349
3647
|
export interface GetDeliverabilityDashboardOptionsResponse {
|
|
3350
3648
|
/**
|
|
3649
|
+
* @public
|
|
3351
3650
|
* <p>Specifies whether the Deliverability dashboard is enabled. If this value is <code>true</code>,
|
|
3352
3651
|
* the dashboard is enabled.</p>
|
|
3353
3652
|
*/
|
|
3354
3653
|
DashboardEnabled: boolean | undefined;
|
|
3355
3654
|
/**
|
|
3655
|
+
* @public
|
|
3356
3656
|
* <p>The date when your current subscription to the Deliverability dashboard
|
|
3357
3657
|
* is scheduled to expire, if your subscription is scheduled to expire at the end of the
|
|
3358
3658
|
* current calendar month. This value is null if you have an active subscription that isn’t
|
|
@@ -3360,18 +3660,21 @@ export interface GetDeliverabilityDashboardOptionsResponse {
|
|
|
3360
3660
|
*/
|
|
3361
3661
|
SubscriptionExpiryDate?: Date;
|
|
3362
3662
|
/**
|
|
3663
|
+
* @public
|
|
3363
3664
|
* <p>The current status of your Deliverability dashboard subscription. If this value is
|
|
3364
3665
|
* <code>PENDING_EXPIRATION</code>, your subscription is scheduled to expire at the end
|
|
3365
3666
|
* of the current calendar month.</p>
|
|
3366
3667
|
*/
|
|
3367
3668
|
AccountStatus?: DeliverabilityDashboardAccountStatus | string;
|
|
3368
3669
|
/**
|
|
3670
|
+
* @public
|
|
3369
3671
|
* <p>An array of objects, one for each verified domain that you use to send email and
|
|
3370
3672
|
* currently has an active Deliverability dashboard subscription that isn’t scheduled to expire at
|
|
3371
3673
|
* the end of the current calendar month.</p>
|
|
3372
3674
|
*/
|
|
3373
3675
|
ActiveSubscribedDomains?: DomainDeliverabilityTrackingOption[];
|
|
3374
3676
|
/**
|
|
3677
|
+
* @public
|
|
3375
3678
|
* <p>An array of objects, one for each verified domain that you use to send email and
|
|
3376
3679
|
* currently has an active Deliverability dashboard subscription that's scheduled to expire at the
|
|
3377
3680
|
* end of the current calendar month.</p>
|
|
@@ -3384,6 +3687,7 @@ export interface GetDeliverabilityDashboardOptionsResponse {
|
|
|
3384
3687
|
*/
|
|
3385
3688
|
export interface GetDeliverabilityTestReportRequest {
|
|
3386
3689
|
/**
|
|
3690
|
+
* @public
|
|
3387
3691
|
* <p>A unique string that identifies the predictive inbox placement test.</p>
|
|
3388
3692
|
*/
|
|
3389
3693
|
ReportId: string | undefined;
|
|
@@ -3394,25 +3698,30 @@ export interface GetDeliverabilityTestReportRequest {
|
|
|
3394
3698
|
*/
|
|
3395
3699
|
export interface PlacementStatistics {
|
|
3396
3700
|
/**
|
|
3701
|
+
* @public
|
|
3397
3702
|
* <p>The percentage of emails that arrived in recipients' inboxes during the predictive inbox placement test.</p>
|
|
3398
3703
|
*/
|
|
3399
3704
|
InboxPercentage?: number;
|
|
3400
3705
|
/**
|
|
3706
|
+
* @public
|
|
3401
3707
|
* <p>The percentage of emails that arrived in recipients' spam or junk mail folders during
|
|
3402
3708
|
* the predictive inbox placement test.</p>
|
|
3403
3709
|
*/
|
|
3404
3710
|
SpamPercentage?: number;
|
|
3405
3711
|
/**
|
|
3712
|
+
* @public
|
|
3406
3713
|
* <p>The percentage of emails that didn't arrive in recipients' inboxes at all during the
|
|
3407
3714
|
* predictive inbox placement test.</p>
|
|
3408
3715
|
*/
|
|
3409
3716
|
MissingPercentage?: number;
|
|
3410
3717
|
/**
|
|
3718
|
+
* @public
|
|
3411
3719
|
* <p>The percentage of emails that were authenticated by using Sender Policy Framework
|
|
3412
3720
|
* (SPF) during the predictive inbox placement test.</p>
|
|
3413
3721
|
*/
|
|
3414
3722
|
SpfPercentage?: number;
|
|
3415
3723
|
/**
|
|
3724
|
+
* @public
|
|
3416
3725
|
* <p>The percentage of emails that were authenticated by using DomainKeys Identified Mail
|
|
3417
3726
|
* (DKIM) during the predictive inbox placement test.</p>
|
|
3418
3727
|
*/
|
|
@@ -3425,10 +3734,12 @@ export interface PlacementStatistics {
|
|
|
3425
3734
|
*/
|
|
3426
3735
|
export interface IspPlacement {
|
|
3427
3736
|
/**
|
|
3737
|
+
* @public
|
|
3428
3738
|
* <p>The name of the email provider that the inbox placement data applies to.</p>
|
|
3429
3739
|
*/
|
|
3430
3740
|
IspName?: string;
|
|
3431
3741
|
/**
|
|
3742
|
+
* @public
|
|
3432
3743
|
* <p>An object that contains inbox placement metrics for a specific email provider.</p>
|
|
3433
3744
|
*/
|
|
3434
3745
|
PlacementStatistics?: PlacementStatistics;
|
|
@@ -3439,26 +3750,31 @@ export interface IspPlacement {
|
|
|
3439
3750
|
*/
|
|
3440
3751
|
export interface GetDeliverabilityTestReportResponse {
|
|
3441
3752
|
/**
|
|
3753
|
+
* @public
|
|
3442
3754
|
* <p>An object that contains the results of the predictive inbox placement test.</p>
|
|
3443
3755
|
*/
|
|
3444
3756
|
DeliverabilityTestReport: DeliverabilityTestReport | undefined;
|
|
3445
3757
|
/**
|
|
3758
|
+
* @public
|
|
3446
3759
|
* <p>An object that specifies how many test messages that were sent during the predictive inbox placement test were
|
|
3447
3760
|
* delivered to recipients' inboxes, how many were sent to recipients' spam folders, and
|
|
3448
3761
|
* how many weren't delivered.</p>
|
|
3449
3762
|
*/
|
|
3450
3763
|
OverallPlacement: PlacementStatistics | undefined;
|
|
3451
3764
|
/**
|
|
3765
|
+
* @public
|
|
3452
3766
|
* <p>An object that describes how the test email was handled by several email providers,
|
|
3453
3767
|
* including Gmail, Hotmail, Yahoo, AOL, and others.</p>
|
|
3454
3768
|
*/
|
|
3455
3769
|
IspPlacements: IspPlacement[] | undefined;
|
|
3456
3770
|
/**
|
|
3771
|
+
* @public
|
|
3457
3772
|
* <p>An object that contains the message that you sent when you performed this
|
|
3458
3773
|
* predictive inbox placement test.</p>
|
|
3459
3774
|
*/
|
|
3460
3775
|
Message?: string;
|
|
3461
3776
|
/**
|
|
3777
|
+
* @public
|
|
3462
3778
|
* <p>An array of objects that define the tags (keys and values) that are associated with
|
|
3463
3779
|
* the predictive inbox placement test.</p>
|
|
3464
3780
|
*/
|
|
@@ -3473,6 +3789,7 @@ export interface GetDeliverabilityTestReportResponse {
|
|
|
3473
3789
|
*/
|
|
3474
3790
|
export interface GetDomainDeliverabilityCampaignRequest {
|
|
3475
3791
|
/**
|
|
3792
|
+
* @public
|
|
3476
3793
|
* <p>The unique identifier for the campaign. The Deliverability dashboard automatically generates
|
|
3477
3794
|
* and assigns this identifier to a campaign.</p>
|
|
3478
3795
|
*/
|
|
@@ -3486,6 +3803,7 @@ export interface GetDomainDeliverabilityCampaignRequest {
|
|
|
3486
3803
|
*/
|
|
3487
3804
|
export interface GetDomainDeliverabilityCampaignResponse {
|
|
3488
3805
|
/**
|
|
3806
|
+
* @public
|
|
3489
3807
|
* <p>An object that contains the deliverability data for the campaign.</p>
|
|
3490
3808
|
*/
|
|
3491
3809
|
DomainDeliverabilityCampaign: DomainDeliverabilityCampaign | undefined;
|
|
@@ -3496,15 +3814,18 @@ export interface GetDomainDeliverabilityCampaignResponse {
|
|
|
3496
3814
|
*/
|
|
3497
3815
|
export interface GetDomainStatisticsReportRequest {
|
|
3498
3816
|
/**
|
|
3817
|
+
* @public
|
|
3499
3818
|
* <p>The domain that you want to obtain deliverability metrics for.</p>
|
|
3500
3819
|
*/
|
|
3501
3820
|
Domain: string | undefined;
|
|
3502
3821
|
/**
|
|
3822
|
+
* @public
|
|
3503
3823
|
* <p>The first day (in Unix time) that you want to obtain domain deliverability metrics
|
|
3504
3824
|
* for.</p>
|
|
3505
3825
|
*/
|
|
3506
3826
|
StartDate: Date | undefined;
|
|
3507
3827
|
/**
|
|
3828
|
+
* @public
|
|
3508
3829
|
* <p>The last day (in Unix time) that you want to obtain domain deliverability metrics for.
|
|
3509
3830
|
* The <code>EndDate</code> that you specify has to be less than or equal to 30 days after
|
|
3510
3831
|
* the <code>StartDate</code>.</p>
|
|
@@ -3518,16 +3839,19 @@ export interface GetDomainStatisticsReportRequest {
|
|
|
3518
3839
|
*/
|
|
3519
3840
|
export interface OverallVolume {
|
|
3520
3841
|
/**
|
|
3842
|
+
* @public
|
|
3521
3843
|
* <p>An object that contains information about the numbers of messages that arrived in
|
|
3522
3844
|
* recipients' inboxes and junk mail folders.</p>
|
|
3523
3845
|
*/
|
|
3524
3846
|
VolumeStatistics?: VolumeStatistics;
|
|
3525
3847
|
/**
|
|
3848
|
+
* @public
|
|
3526
3849
|
* <p>The percentage of emails that were sent from the domain that were read by their
|
|
3527
3850
|
* recipients.</p>
|
|
3528
3851
|
*/
|
|
3529
3852
|
ReadRatePercent?: number;
|
|
3530
3853
|
/**
|
|
3854
|
+
* @public
|
|
3531
3855
|
* <p>An object that contains inbox and junk mail placement metrics for individual email
|
|
3532
3856
|
* providers.</p>
|
|
3533
3857
|
*/
|
|
@@ -3540,12 +3864,14 @@ export interface OverallVolume {
|
|
|
3540
3864
|
*/
|
|
3541
3865
|
export interface GetDomainStatisticsReportResponse {
|
|
3542
3866
|
/**
|
|
3867
|
+
* @public
|
|
3543
3868
|
* <p>An object that contains deliverability metrics for the domain that you specified. The
|
|
3544
3869
|
* data in this object is a summary of all of the data that was collected from the
|
|
3545
3870
|
* <code>StartDate</code> to the <code>EndDate</code>.</p>
|
|
3546
3871
|
*/
|
|
3547
3872
|
OverallVolume: OverallVolume | undefined;
|
|
3548
3873
|
/**
|
|
3874
|
+
* @public
|
|
3549
3875
|
* <p>An object that contains deliverability metrics for the domain that you specified. This
|
|
3550
3876
|
* object contains data for each day, starting on the <code>StartDate</code> and ending on
|
|
3551
3877
|
* the <code>EndDate</code>.</p>
|
|
@@ -3558,6 +3884,7 @@ export interface GetDomainStatisticsReportResponse {
|
|
|
3558
3884
|
*/
|
|
3559
3885
|
export interface GetEmailIdentityRequest {
|
|
3560
3886
|
/**
|
|
3887
|
+
* @public
|
|
3561
3888
|
* <p>The email identity.</p>
|
|
3562
3889
|
*/
|
|
3563
3890
|
EmailIdentity: string | undefined;
|
|
@@ -3582,10 +3909,12 @@ export type MailFromDomainStatus = (typeof MailFromDomainStatus)[keyof typeof Ma
|
|
|
3582
3909
|
*/
|
|
3583
3910
|
export interface MailFromAttributes {
|
|
3584
3911
|
/**
|
|
3912
|
+
* @public
|
|
3585
3913
|
* <p>The name of a domain that an email identity uses as a custom MAIL FROM domain.</p>
|
|
3586
3914
|
*/
|
|
3587
3915
|
MailFromDomain: string | undefined;
|
|
3588
3916
|
/**
|
|
3917
|
+
* @public
|
|
3589
3918
|
* <p>The status of the MAIL FROM domain. This status can have the following values:</p>
|
|
3590
3919
|
* <ul>
|
|
3591
3920
|
* <li>
|
|
@@ -3612,6 +3941,7 @@ export interface MailFromAttributes {
|
|
|
3612
3941
|
*/
|
|
3613
3942
|
MailFromDomainStatus: MailFromDomainStatus | string | undefined;
|
|
3614
3943
|
/**
|
|
3944
|
+
* @public
|
|
3615
3945
|
* <p>The action to take if the required MX record can't be found when you send an email.
|
|
3616
3946
|
* When you set this value to <code>USE_DEFAULT_VALUE</code>, the mail is sent using
|
|
3617
3947
|
* <i>amazonses.com</i> as the MAIL FROM domain. When you set this value
|
|
@@ -3645,11 +3975,13 @@ export type VerificationStatus = (typeof VerificationStatus)[keyof typeof Verifi
|
|
|
3645
3975
|
*/
|
|
3646
3976
|
export interface GetEmailIdentityResponse {
|
|
3647
3977
|
/**
|
|
3978
|
+
* @public
|
|
3648
3979
|
* <p>The email identity type. Note: the <code>MANAGED_DOMAIN</code> identity type is not
|
|
3649
3980
|
* supported.</p>
|
|
3650
3981
|
*/
|
|
3651
3982
|
IdentityType?: IdentityType | string;
|
|
3652
3983
|
/**
|
|
3984
|
+
* @public
|
|
3653
3985
|
* <p>The feedback forwarding configuration for the identity.</p>
|
|
3654
3986
|
* <p>If the value is <code>true</code>, you receive email notifications when bounce or
|
|
3655
3987
|
* complaint events occur. These notifications are sent to the address that you specified
|
|
@@ -3661,34 +3993,41 @@ export interface GetEmailIdentityResponse {
|
|
|
3661
3993
|
*/
|
|
3662
3994
|
FeedbackForwardingStatus?: boolean;
|
|
3663
3995
|
/**
|
|
3996
|
+
* @public
|
|
3664
3997
|
* <p>Specifies whether or not the identity is verified. You can only send email from
|
|
3665
3998
|
* verified email addresses or domains. For more information about verifying identities,
|
|
3666
3999
|
* see the <a href="https://docs.aws.amazon.com/pinpoint/latest/userguide/channels-email-manage-verify.html">Amazon Pinpoint User Guide</a>.</p>
|
|
3667
4000
|
*/
|
|
3668
4001
|
VerifiedForSendingStatus?: boolean;
|
|
3669
4002
|
/**
|
|
4003
|
+
* @public
|
|
3670
4004
|
* <p>An object that contains information about the DKIM attributes for the identity.</p>
|
|
3671
4005
|
*/
|
|
3672
4006
|
DkimAttributes?: DkimAttributes;
|
|
3673
4007
|
/**
|
|
4008
|
+
* @public
|
|
3674
4009
|
* <p>An object that contains information about the Mail-From attributes for the email
|
|
3675
4010
|
* identity.</p>
|
|
3676
4011
|
*/
|
|
3677
4012
|
MailFromAttributes?: MailFromAttributes;
|
|
3678
4013
|
/**
|
|
4014
|
+
* @public
|
|
3679
4015
|
* <p>A map of policy names to policies.</p>
|
|
3680
4016
|
*/
|
|
3681
4017
|
Policies?: Record<string, string>;
|
|
3682
4018
|
/**
|
|
4019
|
+
* @public
|
|
3683
4020
|
* <p>An array of objects that define the tags (keys and values) that are associated with
|
|
3684
4021
|
* the email identity.</p>
|
|
3685
4022
|
*/
|
|
3686
4023
|
Tags?: Tag[];
|
|
3687
4024
|
/**
|
|
4025
|
+
* @public
|
|
3688
4026
|
* <p>The configuration set used by default when sending from this identity.</p>
|
|
3689
4027
|
*/
|
|
3690
4028
|
ConfigurationSetName?: string;
|
|
3691
4029
|
/**
|
|
4030
|
+
* @public
|
|
3692
4031
|
* <p>The verification status of the identity. The status can be one of the following:</p>
|
|
3693
4032
|
* <ul>
|
|
3694
4033
|
* <li>
|
|
@@ -3725,6 +4064,7 @@ export interface GetEmailIdentityResponse {
|
|
|
3725
4064
|
*/
|
|
3726
4065
|
export interface GetEmailIdentityPoliciesRequest {
|
|
3727
4066
|
/**
|
|
4067
|
+
* @public
|
|
3728
4068
|
* <p>The email identity.</p>
|
|
3729
4069
|
*/
|
|
3730
4070
|
EmailIdentity: string | undefined;
|
|
@@ -3735,6 +4075,7 @@ export interface GetEmailIdentityPoliciesRequest {
|
|
|
3735
4075
|
*/
|
|
3736
4076
|
export interface GetEmailIdentityPoliciesResponse {
|
|
3737
4077
|
/**
|
|
4078
|
+
* @public
|
|
3738
4079
|
* <p>A map of policy names to policies.</p>
|
|
3739
4080
|
*/
|
|
3740
4081
|
Policies?: Record<string, string>;
|
|
@@ -3746,6 +4087,7 @@ export interface GetEmailIdentityPoliciesResponse {
|
|
|
3746
4087
|
*/
|
|
3747
4088
|
export interface GetEmailTemplateRequest {
|
|
3748
4089
|
/**
|
|
4090
|
+
* @public
|
|
3749
4091
|
* <p>The name of the template.</p>
|
|
3750
4092
|
*/
|
|
3751
4093
|
TemplateName: string | undefined;
|
|
@@ -3756,10 +4098,12 @@ export interface GetEmailTemplateRequest {
|
|
|
3756
4098
|
*/
|
|
3757
4099
|
export interface GetEmailTemplateResponse {
|
|
3758
4100
|
/**
|
|
4101
|
+
* @public
|
|
3759
4102
|
* <p>The name of the template.</p>
|
|
3760
4103
|
*/
|
|
3761
4104
|
TemplateName: string | undefined;
|
|
3762
4105
|
/**
|
|
4106
|
+
* @public
|
|
3763
4107
|
* <p>The content of the email template, composed of a subject line, an HTML part, and a
|
|
3764
4108
|
* text-only part.</p>
|
|
3765
4109
|
*/
|
|
@@ -3772,6 +4116,7 @@ export interface GetEmailTemplateResponse {
|
|
|
3772
4116
|
*/
|
|
3773
4117
|
export interface GetImportJobRequest {
|
|
3774
4118
|
/**
|
|
4119
|
+
* @public
|
|
3775
4120
|
* <p>The ID of the import job.</p>
|
|
3776
4121
|
*/
|
|
3777
4122
|
JobId: string | undefined;
|
|
@@ -3797,38 +4142,47 @@ export type JobStatus = (typeof JobStatus)[keyof typeof JobStatus];
|
|
|
3797
4142
|
*/
|
|
3798
4143
|
export interface GetImportJobResponse {
|
|
3799
4144
|
/**
|
|
4145
|
+
* @public
|
|
3800
4146
|
* <p>A string that represents the import job ID.</p>
|
|
3801
4147
|
*/
|
|
3802
4148
|
JobId?: string;
|
|
3803
4149
|
/**
|
|
4150
|
+
* @public
|
|
3804
4151
|
* <p>The destination of the import job.</p>
|
|
3805
4152
|
*/
|
|
3806
4153
|
ImportDestination?: ImportDestination;
|
|
3807
4154
|
/**
|
|
4155
|
+
* @public
|
|
3808
4156
|
* <p>The data source of the import job.</p>
|
|
3809
4157
|
*/
|
|
3810
4158
|
ImportDataSource?: ImportDataSource;
|
|
3811
4159
|
/**
|
|
4160
|
+
* @public
|
|
3812
4161
|
* <p>The failure details about an import job.</p>
|
|
3813
4162
|
*/
|
|
3814
4163
|
FailureInfo?: FailureInfo;
|
|
3815
4164
|
/**
|
|
4165
|
+
* @public
|
|
3816
4166
|
* <p>The status of the import job.</p>
|
|
3817
4167
|
*/
|
|
3818
4168
|
JobStatus?: JobStatus | string;
|
|
3819
4169
|
/**
|
|
4170
|
+
* @public
|
|
3820
4171
|
* <p>The time stamp of when the import job was created.</p>
|
|
3821
4172
|
*/
|
|
3822
4173
|
CreatedTimestamp?: Date;
|
|
3823
4174
|
/**
|
|
4175
|
+
* @public
|
|
3824
4176
|
* <p>The time stamp of when the import job was completed.</p>
|
|
3825
4177
|
*/
|
|
3826
4178
|
CompletedTimestamp?: Date;
|
|
3827
4179
|
/**
|
|
4180
|
+
* @public
|
|
3828
4181
|
* <p>The current number of records processed.</p>
|
|
3829
4182
|
*/
|
|
3830
4183
|
ProcessedRecordsCount?: number;
|
|
3831
4184
|
/**
|
|
4185
|
+
* @public
|
|
3832
4186
|
* <p>The number of records that failed processing because of invalid input or other
|
|
3833
4187
|
* reasons.</p>
|
|
3834
4188
|
*/
|
|
@@ -3841,6 +4195,7 @@ export interface GetImportJobResponse {
|
|
|
3841
4195
|
*/
|
|
3842
4196
|
export interface GetSuppressedDestinationRequest {
|
|
3843
4197
|
/**
|
|
4198
|
+
* @public
|
|
3844
4199
|
* <p>The email address that's on the account suppression list.</p>
|
|
3845
4200
|
*/
|
|
3846
4201
|
EmailAddress: string | undefined;
|
|
@@ -3852,11 +4207,13 @@ export interface GetSuppressedDestinationRequest {
|
|
|
3852
4207
|
*/
|
|
3853
4208
|
export interface SuppressedDestinationAttributes {
|
|
3854
4209
|
/**
|
|
4210
|
+
* @public
|
|
3855
4211
|
* <p>The unique identifier of the email message that caused the email address to be added
|
|
3856
4212
|
* to the suppression list for your account.</p>
|
|
3857
4213
|
*/
|
|
3858
4214
|
MessageId?: string;
|
|
3859
4215
|
/**
|
|
4216
|
+
* @public
|
|
3860
4217
|
* <p>A unique identifier that's generated when an email address is added to the suppression
|
|
3861
4218
|
* list for your account.</p>
|
|
3862
4219
|
*/
|
|
@@ -3869,19 +4226,23 @@ export interface SuppressedDestinationAttributes {
|
|
|
3869
4226
|
*/
|
|
3870
4227
|
export interface SuppressedDestination {
|
|
3871
4228
|
/**
|
|
4229
|
+
* @public
|
|
3872
4230
|
* <p>The email address that is on the suppression list for your account.</p>
|
|
3873
4231
|
*/
|
|
3874
4232
|
EmailAddress: string | undefined;
|
|
3875
4233
|
/**
|
|
4234
|
+
* @public
|
|
3876
4235
|
* <p>The reason that the address was added to the suppression list for your account.</p>
|
|
3877
4236
|
*/
|
|
3878
4237
|
Reason: SuppressionListReason | string | undefined;
|
|
3879
4238
|
/**
|
|
4239
|
+
* @public
|
|
3880
4240
|
* <p>The date and time when the suppressed destination was last updated, shown in Unix time
|
|
3881
4241
|
* format.</p>
|
|
3882
4242
|
*/
|
|
3883
4243
|
LastUpdateTime: Date | undefined;
|
|
3884
4244
|
/**
|
|
4245
|
+
* @public
|
|
3885
4246
|
* <p>An optional value that can contain additional information about the reasons that the
|
|
3886
4247
|
* address was added to the suppression list for your account.</p>
|
|
3887
4248
|
*/
|
|
@@ -3893,6 +4254,7 @@ export interface SuppressedDestination {
|
|
|
3893
4254
|
*/
|
|
3894
4255
|
export interface GetSuppressedDestinationResponse {
|
|
3895
4256
|
/**
|
|
4257
|
+
* @public
|
|
3896
4258
|
* <p>An object containing information about the suppressed email address.</p>
|
|
3897
4259
|
*/
|
|
3898
4260
|
SuppressedDestination: SuppressedDestination | undefined;
|
|
@@ -3903,15 +4265,18 @@ export interface GetSuppressedDestinationResponse {
|
|
|
3903
4265
|
*/
|
|
3904
4266
|
export interface IdentityInfo {
|
|
3905
4267
|
/**
|
|
4268
|
+
* @public
|
|
3906
4269
|
* <p>The email identity type. Note: the <code>MANAGED_DOMAIN</code> type is not supported
|
|
3907
4270
|
* for email identity types.</p>
|
|
3908
4271
|
*/
|
|
3909
4272
|
IdentityType?: IdentityType | string;
|
|
3910
4273
|
/**
|
|
4274
|
+
* @public
|
|
3911
4275
|
* <p>The address or domain of the identity.</p>
|
|
3912
4276
|
*/
|
|
3913
4277
|
IdentityName?: string;
|
|
3914
4278
|
/**
|
|
4279
|
+
* @public
|
|
3915
4280
|
* <p>Indicates whether or not you can send email from the identity.</p>
|
|
3916
4281
|
* <p>An <i>identity</i> is an email address or domain that you send email
|
|
3917
4282
|
* from. Before you can send email from an identity, you have to demostrate that you own
|
|
@@ -3919,6 +4284,7 @@ export interface IdentityInfo {
|
|
|
3919
4284
|
*/
|
|
3920
4285
|
SendingEnabled?: boolean;
|
|
3921
4286
|
/**
|
|
4287
|
+
* @public
|
|
3922
4288
|
* <p>The verification status of the identity. The status can be one of the following:</p>
|
|
3923
4289
|
* <ul>
|
|
3924
4290
|
* <li>
|
|
@@ -3967,27 +4333,33 @@ export type ImportDestinationType = (typeof ImportDestinationType)[keyof typeof
|
|
|
3967
4333
|
*/
|
|
3968
4334
|
export interface ImportJobSummary {
|
|
3969
4335
|
/**
|
|
4336
|
+
* @public
|
|
3970
4337
|
* <p>A string that represents the import job ID.</p>
|
|
3971
4338
|
*/
|
|
3972
4339
|
JobId?: string;
|
|
3973
4340
|
/**
|
|
4341
|
+
* @public
|
|
3974
4342
|
* <p>An object that contains details about the resource destination the import job is going
|
|
3975
4343
|
* to target.</p>
|
|
3976
4344
|
*/
|
|
3977
4345
|
ImportDestination?: ImportDestination;
|
|
3978
4346
|
/**
|
|
4347
|
+
* @public
|
|
3979
4348
|
* <p>The status of the import job.</p>
|
|
3980
4349
|
*/
|
|
3981
4350
|
JobStatus?: JobStatus | string;
|
|
3982
4351
|
/**
|
|
4352
|
+
* @public
|
|
3983
4353
|
* <p>The date and time when the import job was created.</p>
|
|
3984
4354
|
*/
|
|
3985
4355
|
CreatedTimestamp?: Date;
|
|
3986
4356
|
/**
|
|
4357
|
+
* @public
|
|
3987
4358
|
* <p>The current number of records processed.</p>
|
|
3988
4359
|
*/
|
|
3989
4360
|
ProcessedRecordsCount?: number;
|
|
3990
4361
|
/**
|
|
4362
|
+
* @public
|
|
3991
4363
|
* <p>The number of records that failed processing because of invalid input or other
|
|
3992
4364
|
* reasons.</p>
|
|
3993
4365
|
*/
|
|
@@ -4012,11 +4384,13 @@ export declare class InvalidNextTokenException extends __BaseException {
|
|
|
4012
4384
|
*/
|
|
4013
4385
|
export interface ListConfigurationSetsRequest {
|
|
4014
4386
|
/**
|
|
4387
|
+
* @public
|
|
4015
4388
|
* <p>A token returned from a previous call to <code>ListConfigurationSets</code> to
|
|
4016
4389
|
* indicate the position in the list of configuration sets.</p>
|
|
4017
4390
|
*/
|
|
4018
4391
|
NextToken?: string;
|
|
4019
4392
|
/**
|
|
4393
|
+
* @public
|
|
4020
4394
|
* <p>The number of results to show in a single call to <code>ListConfigurationSets</code>.
|
|
4021
4395
|
* If the number of results is larger than the number you specified in this parameter, then
|
|
4022
4396
|
* the response includes a <code>NextToken</code> element, which you can use to obtain
|
|
@@ -4030,11 +4404,13 @@ export interface ListConfigurationSetsRequest {
|
|
|
4030
4404
|
*/
|
|
4031
4405
|
export interface ListConfigurationSetsResponse {
|
|
4032
4406
|
/**
|
|
4407
|
+
* @public
|
|
4033
4408
|
* <p>An array that contains all of the configuration sets in your Amazon SES account in the
|
|
4034
4409
|
* current Amazon Web Services Region.</p>
|
|
4035
4410
|
*/
|
|
4036
4411
|
ConfigurationSets?: string[];
|
|
4037
4412
|
/**
|
|
4413
|
+
* @public
|
|
4038
4414
|
* <p>A token that indicates that there are additional configuration sets to list. To view
|
|
4039
4415
|
* additional configuration sets, issue another request to
|
|
4040
4416
|
* <code>ListConfigurationSets</code>, and pass this token in the
|
|
@@ -4047,6 +4423,7 @@ export interface ListConfigurationSetsResponse {
|
|
|
4047
4423
|
*/
|
|
4048
4424
|
export interface ListContactListsRequest {
|
|
4049
4425
|
/**
|
|
4426
|
+
* @public
|
|
4050
4427
|
* <p>Maximum number of contact lists to return at once. Use this parameter to paginate
|
|
4051
4428
|
* results. If additional contact lists exist beyond the specified limit, the
|
|
4052
4429
|
* <code>NextToken</code> element is sent in the response. Use the
|
|
@@ -4055,6 +4432,7 @@ export interface ListContactListsRequest {
|
|
|
4055
4432
|
*/
|
|
4056
4433
|
PageSize?: number;
|
|
4057
4434
|
/**
|
|
4435
|
+
* @public
|
|
4058
4436
|
* <p>A string token indicating that there might be additional contact lists available to be
|
|
4059
4437
|
* listed. Use the token provided in the Response to use in the subsequent call to
|
|
4060
4438
|
* ListContactLists with the same parameters to retrieve the next page of contact
|
|
@@ -4067,10 +4445,12 @@ export interface ListContactListsRequest {
|
|
|
4067
4445
|
*/
|
|
4068
4446
|
export interface ListContactListsResponse {
|
|
4069
4447
|
/**
|
|
4448
|
+
* @public
|
|
4070
4449
|
* <p>The available contact lists.</p>
|
|
4071
4450
|
*/
|
|
4072
4451
|
ContactLists?: ContactList[];
|
|
4073
4452
|
/**
|
|
4453
|
+
* @public
|
|
4074
4454
|
* <p>A string token indicating that there might be additional contact lists available to be
|
|
4075
4455
|
* listed. Copy this token to a subsequent call to <code>ListContactLists</code> with the
|
|
4076
4456
|
* same parameters to retrieve the next page of contact lists.</p>
|
|
@@ -4083,10 +4463,12 @@ export interface ListContactListsResponse {
|
|
|
4083
4463
|
*/
|
|
4084
4464
|
export interface TopicFilter {
|
|
4085
4465
|
/**
|
|
4466
|
+
* @public
|
|
4086
4467
|
* <p>The name of a topic on which you wish to apply the filter.</p>
|
|
4087
4468
|
*/
|
|
4088
4469
|
TopicName?: string;
|
|
4089
4470
|
/**
|
|
4471
|
+
* @public
|
|
4090
4472
|
* <p>Notes that the default subscription status should be applied to a contact because the
|
|
4091
4473
|
* contact has not noted their preference for subscribing to a topic.</p>
|
|
4092
4474
|
*/
|
|
@@ -4098,11 +4480,13 @@ export interface TopicFilter {
|
|
|
4098
4480
|
*/
|
|
4099
4481
|
export interface ListContactsFilter {
|
|
4100
4482
|
/**
|
|
4483
|
+
* @public
|
|
4101
4484
|
* <p>The status by which you are filtering: <code>OPT_IN</code> or
|
|
4102
4485
|
* <code>OPT_OUT</code>.</p>
|
|
4103
4486
|
*/
|
|
4104
4487
|
FilteredStatus?: SubscriptionStatus | string;
|
|
4105
4488
|
/**
|
|
4489
|
+
* @public
|
|
4106
4490
|
* <p>Used for filtering by a specific topic preference.</p>
|
|
4107
4491
|
*/
|
|
4108
4492
|
TopicFilter?: TopicFilter;
|
|
@@ -4112,14 +4496,17 @@ export interface ListContactsFilter {
|
|
|
4112
4496
|
*/
|
|
4113
4497
|
export interface ListContactsRequest {
|
|
4114
4498
|
/**
|
|
4499
|
+
* @public
|
|
4115
4500
|
* <p>The name of the contact list.</p>
|
|
4116
4501
|
*/
|
|
4117
4502
|
ContactListName: string | undefined;
|
|
4118
4503
|
/**
|
|
4504
|
+
* @public
|
|
4119
4505
|
* <p>A filter that can be applied to a list of contacts.</p>
|
|
4120
4506
|
*/
|
|
4121
4507
|
Filter?: ListContactsFilter;
|
|
4122
4508
|
/**
|
|
4509
|
+
* @public
|
|
4123
4510
|
* <p>The number of contacts that may be returned at once, which is dependent on if there
|
|
4124
4511
|
* are more or less contacts than the value of the PageSize. Use this parameter to
|
|
4125
4512
|
* paginate results. If additional contacts exist beyond the specified limit, the
|
|
@@ -4129,6 +4516,7 @@ export interface ListContactsRequest {
|
|
|
4129
4516
|
*/
|
|
4130
4517
|
PageSize?: number;
|
|
4131
4518
|
/**
|
|
4519
|
+
* @public
|
|
4132
4520
|
* <p>A string token indicating that there might be additional contacts available to be
|
|
4133
4521
|
* listed. Use the token provided in the Response to use in the subsequent call to
|
|
4134
4522
|
* ListContacts with the same parameters to retrieve the next page of contacts.</p>
|
|
@@ -4140,10 +4528,12 @@ export interface ListContactsRequest {
|
|
|
4140
4528
|
*/
|
|
4141
4529
|
export interface ListContactsResponse {
|
|
4142
4530
|
/**
|
|
4531
|
+
* @public
|
|
4143
4532
|
* <p>The contacts present in a specific contact list.</p>
|
|
4144
4533
|
*/
|
|
4145
4534
|
Contacts?: Contact[];
|
|
4146
4535
|
/**
|
|
4536
|
+
* @public
|
|
4147
4537
|
* <p>A string token indicating that there might be additional contacts available to be
|
|
4148
4538
|
* listed. Copy this token to a subsequent call to <code>ListContacts</code> with the same
|
|
4149
4539
|
* parameters to retrieve the next page of contacts.</p>
|
|
@@ -4157,12 +4547,14 @@ export interface ListContactsResponse {
|
|
|
4157
4547
|
*/
|
|
4158
4548
|
export interface ListCustomVerificationEmailTemplatesRequest {
|
|
4159
4549
|
/**
|
|
4550
|
+
* @public
|
|
4160
4551
|
* <p>A token returned from a previous call to
|
|
4161
4552
|
* <code>ListCustomVerificationEmailTemplates</code> to indicate the position in the
|
|
4162
4553
|
* list of custom verification email templates.</p>
|
|
4163
4554
|
*/
|
|
4164
4555
|
NextToken?: string;
|
|
4165
4556
|
/**
|
|
4557
|
+
* @public
|
|
4166
4558
|
* <p>The number of results to show in a single call to
|
|
4167
4559
|
* <code>ListCustomVerificationEmailTemplates</code>. If the number of results is
|
|
4168
4560
|
* larger than the number you specified in this parameter, then the response includes a
|
|
@@ -4178,10 +4570,12 @@ export interface ListCustomVerificationEmailTemplatesRequest {
|
|
|
4178
4570
|
*/
|
|
4179
4571
|
export interface ListCustomVerificationEmailTemplatesResponse {
|
|
4180
4572
|
/**
|
|
4573
|
+
* @public
|
|
4181
4574
|
* <p>A list of the custom verification email templates that exist in your account.</p>
|
|
4182
4575
|
*/
|
|
4183
4576
|
CustomVerificationEmailTemplates?: CustomVerificationEmailTemplateMetadata[];
|
|
4184
4577
|
/**
|
|
4578
|
+
* @public
|
|
4185
4579
|
* <p>A token indicating that there are additional custom verification email templates
|
|
4186
4580
|
* available to be listed. Pass this token to a subsequent call to
|
|
4187
4581
|
* <code>ListCustomVerificationEmailTemplates</code> to retrieve the next 50 custom
|
|
@@ -4195,11 +4589,13 @@ export interface ListCustomVerificationEmailTemplatesResponse {
|
|
|
4195
4589
|
*/
|
|
4196
4590
|
export interface ListDedicatedIpPoolsRequest {
|
|
4197
4591
|
/**
|
|
4592
|
+
* @public
|
|
4198
4593
|
* <p>A token returned from a previous call to <code>ListDedicatedIpPools</code> to indicate
|
|
4199
4594
|
* the position in the list of dedicated IP pools.</p>
|
|
4200
4595
|
*/
|
|
4201
4596
|
NextToken?: string;
|
|
4202
4597
|
/**
|
|
4598
|
+
* @public
|
|
4203
4599
|
* <p>The number of results to show in a single call to <code>ListDedicatedIpPools</code>.
|
|
4204
4600
|
* If the number of results is larger than the number you specified in this parameter, then
|
|
4205
4601
|
* the response includes a <code>NextToken</code> element, which you can use to obtain
|
|
@@ -4213,11 +4609,13 @@ export interface ListDedicatedIpPoolsRequest {
|
|
|
4213
4609
|
*/
|
|
4214
4610
|
export interface ListDedicatedIpPoolsResponse {
|
|
4215
4611
|
/**
|
|
4612
|
+
* @public
|
|
4216
4613
|
* <p>A list of all of the dedicated IP pools that are associated with your Amazon Web Services account in
|
|
4217
4614
|
* the current Region.</p>
|
|
4218
4615
|
*/
|
|
4219
4616
|
DedicatedIpPools?: string[];
|
|
4220
4617
|
/**
|
|
4618
|
+
* @public
|
|
4221
4619
|
* <p>A token that indicates that there are additional IP pools to list. To view additional
|
|
4222
4620
|
* IP pools, issue another request to <code>ListDedicatedIpPools</code>, passing this token
|
|
4223
4621
|
* in the <code>NextToken</code> parameter.</p>
|
|
@@ -4230,11 +4628,13 @@ export interface ListDedicatedIpPoolsResponse {
|
|
|
4230
4628
|
*/
|
|
4231
4629
|
export interface ListDeliverabilityTestReportsRequest {
|
|
4232
4630
|
/**
|
|
4631
|
+
* @public
|
|
4233
4632
|
* <p>A token returned from a previous call to <code>ListDeliverabilityTestReports</code> to
|
|
4234
4633
|
* indicate the position in the list of predictive inbox placement tests.</p>
|
|
4235
4634
|
*/
|
|
4236
4635
|
NextToken?: string;
|
|
4237
4636
|
/**
|
|
4637
|
+
* @public
|
|
4238
4638
|
* <p>The number of results to show in a single call to
|
|
4239
4639
|
* <code>ListDeliverabilityTestReports</code>. If the number of results is larger than
|
|
4240
4640
|
* the number you specified in this parameter, then the response includes a
|
|
@@ -4251,10 +4651,12 @@ export interface ListDeliverabilityTestReportsRequest {
|
|
|
4251
4651
|
*/
|
|
4252
4652
|
export interface ListDeliverabilityTestReportsResponse {
|
|
4253
4653
|
/**
|
|
4654
|
+
* @public
|
|
4254
4655
|
* <p>An object that contains a lists of predictive inbox placement tests that you've performed.</p>
|
|
4255
4656
|
*/
|
|
4256
4657
|
DeliverabilityTestReports: DeliverabilityTestReport[] | undefined;
|
|
4257
4658
|
/**
|
|
4659
|
+
* @public
|
|
4258
4660
|
* <p>A token that indicates that there are additional predictive inbox placement tests to list. To view additional
|
|
4259
4661
|
* predictive inbox placement tests, issue another request to <code>ListDeliverabilityTestReports</code>, and pass
|
|
4260
4662
|
* this token in the <code>NextToken</code> parameter.</p>
|
|
@@ -4269,27 +4671,32 @@ export interface ListDeliverabilityTestReportsResponse {
|
|
|
4269
4671
|
*/
|
|
4270
4672
|
export interface ListDomainDeliverabilityCampaignsRequest {
|
|
4271
4673
|
/**
|
|
4674
|
+
* @public
|
|
4272
4675
|
* <p>The first day that you want to obtain deliverability data
|
|
4273
4676
|
* for.</p>
|
|
4274
4677
|
*/
|
|
4275
4678
|
StartDate: Date | undefined;
|
|
4276
4679
|
/**
|
|
4680
|
+
* @public
|
|
4277
4681
|
* <p>The last day that you want to obtain deliverability data for.
|
|
4278
4682
|
* This value has to be less than or equal to 30 days after the value of the
|
|
4279
4683
|
* <code>StartDate</code> parameter.</p>
|
|
4280
4684
|
*/
|
|
4281
4685
|
EndDate: Date | undefined;
|
|
4282
4686
|
/**
|
|
4687
|
+
* @public
|
|
4283
4688
|
* <p>The domain to obtain deliverability data for.</p>
|
|
4284
4689
|
*/
|
|
4285
4690
|
SubscribedDomain: string | undefined;
|
|
4286
4691
|
/**
|
|
4692
|
+
* @public
|
|
4287
4693
|
* <p>A token that’s returned from a previous call to the
|
|
4288
4694
|
* <code>ListDomainDeliverabilityCampaigns</code> operation. This token indicates the
|
|
4289
4695
|
* position of a campaign in the list of campaigns.</p>
|
|
4290
4696
|
*/
|
|
4291
4697
|
NextToken?: string;
|
|
4292
4698
|
/**
|
|
4699
|
+
* @public
|
|
4293
4700
|
* <p>The maximum number of results to include in response to a single call to the
|
|
4294
4701
|
* <code>ListDomainDeliverabilityCampaigns</code> operation. If the number of results
|
|
4295
4702
|
* is larger than the number that you specify in this parameter, the response includes a
|
|
@@ -4306,11 +4713,13 @@ export interface ListDomainDeliverabilityCampaignsRequest {
|
|
|
4306
4713
|
*/
|
|
4307
4714
|
export interface ListDomainDeliverabilityCampaignsResponse {
|
|
4308
4715
|
/**
|
|
4716
|
+
* @public
|
|
4309
4717
|
* <p>An array of responses, one for each campaign that used the domain to send email during
|
|
4310
4718
|
* the specified time range.</p>
|
|
4311
4719
|
*/
|
|
4312
4720
|
DomainDeliverabilityCampaigns: DomainDeliverabilityCampaign[] | undefined;
|
|
4313
4721
|
/**
|
|
4722
|
+
* @public
|
|
4314
4723
|
* <p>A token that’s returned from a previous call to the
|
|
4315
4724
|
* <code>ListDomainDeliverabilityCampaigns</code> operation. This token indicates the
|
|
4316
4725
|
* position of the campaign in the list of campaigns.</p>
|
|
@@ -4325,11 +4734,13 @@ export interface ListDomainDeliverabilityCampaignsResponse {
|
|
|
4325
4734
|
*/
|
|
4326
4735
|
export interface ListEmailIdentitiesRequest {
|
|
4327
4736
|
/**
|
|
4737
|
+
* @public
|
|
4328
4738
|
* <p>A token returned from a previous call to <code>ListEmailIdentities</code> to indicate
|
|
4329
4739
|
* the position in the list of identities.</p>
|
|
4330
4740
|
*/
|
|
4331
4741
|
NextToken?: string;
|
|
4332
4742
|
/**
|
|
4743
|
+
* @public
|
|
4333
4744
|
* <p>The number of results to show in a single call to <code>ListEmailIdentities</code>. If
|
|
4334
4745
|
* the number of results is larger than the number you specified in this parameter, then
|
|
4335
4746
|
* the response includes a <code>NextToken</code> element, which you can use to obtain
|
|
@@ -4345,11 +4756,13 @@ export interface ListEmailIdentitiesRequest {
|
|
|
4345
4756
|
*/
|
|
4346
4757
|
export interface ListEmailIdentitiesResponse {
|
|
4347
4758
|
/**
|
|
4759
|
+
* @public
|
|
4348
4760
|
* <p>An array that includes all of the email identities associated with your Amazon Web Services
|
|
4349
4761
|
* account.</p>
|
|
4350
4762
|
*/
|
|
4351
4763
|
EmailIdentities?: IdentityInfo[];
|
|
4352
4764
|
/**
|
|
4765
|
+
* @public
|
|
4353
4766
|
* <p>A token that indicates that there are additional configuration sets to list. To view
|
|
4354
4767
|
* additional configuration sets, issue another request to
|
|
4355
4768
|
* <code>ListEmailIdentities</code>, and pass this token in the <code>NextToken</code>
|
|
@@ -4365,11 +4778,13 @@ export interface ListEmailIdentitiesResponse {
|
|
|
4365
4778
|
*/
|
|
4366
4779
|
export interface ListEmailTemplatesRequest {
|
|
4367
4780
|
/**
|
|
4781
|
+
* @public
|
|
4368
4782
|
* <p>A token returned from a previous call to <code>ListEmailTemplates</code> to indicate
|
|
4369
4783
|
* the position in the list of email templates.</p>
|
|
4370
4784
|
*/
|
|
4371
4785
|
NextToken?: string;
|
|
4372
4786
|
/**
|
|
4787
|
+
* @public
|
|
4373
4788
|
* <p>The number of results to show in a single call to <code>ListEmailTemplates</code>. If the number of
|
|
4374
4789
|
* results is larger than the number you specified in this parameter, then the response
|
|
4375
4790
|
* includes a <code>NextToken</code> element, which you can use to obtain additional results.</p>
|
|
@@ -4383,11 +4798,13 @@ export interface ListEmailTemplatesRequest {
|
|
|
4383
4798
|
*/
|
|
4384
4799
|
export interface ListEmailTemplatesResponse {
|
|
4385
4800
|
/**
|
|
4801
|
+
* @public
|
|
4386
4802
|
* <p>An array the contains the name and creation time stamp for each template in your Amazon SES
|
|
4387
4803
|
* account.</p>
|
|
4388
4804
|
*/
|
|
4389
4805
|
TemplatesMetadata?: EmailTemplateMetadata[];
|
|
4390
4806
|
/**
|
|
4807
|
+
* @public
|
|
4391
4808
|
* <p>A token indicating that there are additional email templates available to be listed.
|
|
4392
4809
|
* Pass this token to a subsequent <code>ListEmailTemplates</code> call to retrieve the
|
|
4393
4810
|
* next 10 email templates.</p>
|
|
@@ -4401,17 +4818,20 @@ export interface ListEmailTemplatesResponse {
|
|
|
4401
4818
|
*/
|
|
4402
4819
|
export interface ListImportJobsRequest {
|
|
4403
4820
|
/**
|
|
4821
|
+
* @public
|
|
4404
4822
|
* <p>The destination of the import job, which can be used to list import jobs that have a
|
|
4405
4823
|
* certain <code>ImportDestinationType</code>.</p>
|
|
4406
4824
|
*/
|
|
4407
4825
|
ImportDestinationType?: ImportDestinationType | string;
|
|
4408
4826
|
/**
|
|
4827
|
+
* @public
|
|
4409
4828
|
* <p>A string token indicating that there might be additional import jobs available to be
|
|
4410
4829
|
* listed. Copy this token to a subsequent call to <code>ListImportJobs</code> with the
|
|
4411
4830
|
* same parameters to retrieve the next page of import jobs.</p>
|
|
4412
4831
|
*/
|
|
4413
4832
|
NextToken?: string;
|
|
4414
4833
|
/**
|
|
4834
|
+
* @public
|
|
4415
4835
|
* <p>Maximum number of import jobs to return at once. Use this parameter to paginate
|
|
4416
4836
|
* results. If additional import jobs exist beyond the specified limit, the
|
|
4417
4837
|
* <code>NextToken</code> element is sent in the response. Use the
|
|
@@ -4427,10 +4847,12 @@ export interface ListImportJobsRequest {
|
|
|
4427
4847
|
*/
|
|
4428
4848
|
export interface ListImportJobsResponse {
|
|
4429
4849
|
/**
|
|
4850
|
+
* @public
|
|
4430
4851
|
* <p>A list of the import job summaries.</p>
|
|
4431
4852
|
*/
|
|
4432
4853
|
ImportJobs?: ImportJobSummary[];
|
|
4433
4854
|
/**
|
|
4855
|
+
* @public
|
|
4434
4856
|
* <p>A string token indicating that there might be additional import jobs available to be
|
|
4435
4857
|
* listed. Copy this token to a subsequent call to <code>ListImportJobs</code> with the
|
|
4436
4858
|
* same parameters to retrieve the next page of import jobs.</p>
|
|
@@ -4444,10 +4866,12 @@ export interface ListImportJobsResponse {
|
|
|
4444
4866
|
*/
|
|
4445
4867
|
export interface ListManagementOptions {
|
|
4446
4868
|
/**
|
|
4869
|
+
* @public
|
|
4447
4870
|
* <p>The name of the contact list.</p>
|
|
4448
4871
|
*/
|
|
4449
4872
|
ContactListName: string | undefined;
|
|
4450
4873
|
/**
|
|
4874
|
+
* @public
|
|
4451
4875
|
* <p>The name of the topic.</p>
|
|
4452
4876
|
*/
|
|
4453
4877
|
TopicName?: string;
|
|
@@ -4472,6 +4896,7 @@ export type ListRecommendationsFilterKey = (typeof ListRecommendationsFilterKey)
|
|
|
4472
4896
|
*/
|
|
4473
4897
|
export interface ListRecommendationsRequest {
|
|
4474
4898
|
/**
|
|
4899
|
+
* @public
|
|
4475
4900
|
* <p>Filters applied when retrieving recommendations. Can eiter be an individual filter, or
|
|
4476
4901
|
* combinations of <code>STATUS</code> and <code>IMPACT</code> or
|
|
4477
4902
|
* <code>STATUS</code> and <code>TYPE</code>
|
|
@@ -4479,11 +4904,13 @@ export interface ListRecommendationsRequest {
|
|
|
4479
4904
|
*/
|
|
4480
4905
|
Filter?: Record<string, string>;
|
|
4481
4906
|
/**
|
|
4907
|
+
* @public
|
|
4482
4908
|
* <p>A token returned from a previous call to <code>ListRecommendations</code> to
|
|
4483
4909
|
* indicate the position in the list of recommendations.</p>
|
|
4484
4910
|
*/
|
|
4485
4911
|
NextToken?: string;
|
|
4486
4912
|
/**
|
|
4913
|
+
* @public
|
|
4487
4914
|
* <p>The number of results to show in a single call to
|
|
4488
4915
|
* <code>ListRecommendations</code>. If the number of results is larger than
|
|
4489
4916
|
* the number you specified in this parameter, then the response includes a
|
|
@@ -4537,34 +4964,41 @@ export type RecommendationType = (typeof RecommendationType)[keyof typeof Recomm
|
|
|
4537
4964
|
*/
|
|
4538
4965
|
export interface Recommendation {
|
|
4539
4966
|
/**
|
|
4967
|
+
* @public
|
|
4540
4968
|
* <p>The resource affected by the recommendation,
|
|
4541
4969
|
* with values like <code>arn:aws:ses:us-east-1:123456789012:identity/example.com</code>.</p>
|
|
4542
4970
|
*/
|
|
4543
4971
|
ResourceArn?: string;
|
|
4544
4972
|
/**
|
|
4973
|
+
* @public
|
|
4545
4974
|
* <p>The recommendation type, with values like <code>DKIM</code>,
|
|
4546
4975
|
* <code>SPF</code>, <code>DMARC</code> or <code>BIMI</code>.</p>
|
|
4547
4976
|
*/
|
|
4548
4977
|
Type?: RecommendationType | string;
|
|
4549
4978
|
/**
|
|
4979
|
+
* @public
|
|
4550
4980
|
* <p>The recommendation description / disambiguator - e.g. <code>DKIM1</code> and <code>DKIM2</code>
|
|
4551
4981
|
* are different recommendations about your DKIM setup.</p>
|
|
4552
4982
|
*/
|
|
4553
4983
|
Description?: string;
|
|
4554
4984
|
/**
|
|
4985
|
+
* @public
|
|
4555
4986
|
* <p>The recommendation status, with values like
|
|
4556
4987
|
* <code>OPEN</code> or <code>FIXED</code>.</p>
|
|
4557
4988
|
*/
|
|
4558
4989
|
Status?: RecommendationStatus | string;
|
|
4559
4990
|
/**
|
|
4991
|
+
* @public
|
|
4560
4992
|
* <p>The first time this issue was encountered and the recommendation was generated.</p>
|
|
4561
4993
|
*/
|
|
4562
4994
|
CreatedTimestamp?: Date;
|
|
4563
4995
|
/**
|
|
4996
|
+
* @public
|
|
4564
4997
|
* <p>The last time the recommendation was updated.</p>
|
|
4565
4998
|
*/
|
|
4566
4999
|
LastUpdatedTimestamp?: Date;
|
|
4567
5000
|
/**
|
|
5001
|
+
* @public
|
|
4568
5002
|
* <p>The recommendation impact, with values like
|
|
4569
5003
|
* <code>HIGH</code> or <code>LOW</code>.</p>
|
|
4570
5004
|
*/
|
|
@@ -4576,10 +5010,12 @@ export interface Recommendation {
|
|
|
4576
5010
|
*/
|
|
4577
5011
|
export interface ListRecommendationsResponse {
|
|
4578
5012
|
/**
|
|
5013
|
+
* @public
|
|
4579
5014
|
* <p>The recommendations applicable to your account.</p>
|
|
4580
5015
|
*/
|
|
4581
5016
|
Recommendations?: Recommendation[];
|
|
4582
5017
|
/**
|
|
5018
|
+
* @public
|
|
4583
5019
|
* <p>A string token indicating that there might be additional recommendations available to be
|
|
4584
5020
|
* listed. Use the token provided in the <code>ListRecommendationsResponse</code> to use in the
|
|
4585
5021
|
* subsequent call to <code>ListRecommendations</code> with the same parameters to retrieve the
|
|
@@ -4594,25 +5030,30 @@ export interface ListRecommendationsResponse {
|
|
|
4594
5030
|
*/
|
|
4595
5031
|
export interface ListSuppressedDestinationsRequest {
|
|
4596
5032
|
/**
|
|
5033
|
+
* @public
|
|
4597
5034
|
* <p>The factors that caused the email address to be added to .</p>
|
|
4598
5035
|
*/
|
|
4599
5036
|
Reasons?: (SuppressionListReason | string)[];
|
|
4600
5037
|
/**
|
|
5038
|
+
* @public
|
|
4601
5039
|
* <p>Used to filter the list of suppressed email destinations so that it only includes
|
|
4602
5040
|
* addresses that were added to the list after a specific date.</p>
|
|
4603
5041
|
*/
|
|
4604
5042
|
StartDate?: Date;
|
|
4605
5043
|
/**
|
|
5044
|
+
* @public
|
|
4606
5045
|
* <p>Used to filter the list of suppressed email destinations so that it only includes
|
|
4607
5046
|
* addresses that were added to the list before a specific date.</p>
|
|
4608
5047
|
*/
|
|
4609
5048
|
EndDate?: Date;
|
|
4610
5049
|
/**
|
|
5050
|
+
* @public
|
|
4611
5051
|
* <p>A token returned from a previous call to <code>ListSuppressedDestinations</code> to
|
|
4612
5052
|
* indicate the position in the list of suppressed email addresses.</p>
|
|
4613
5053
|
*/
|
|
4614
5054
|
NextToken?: string;
|
|
4615
5055
|
/**
|
|
5056
|
+
* @public
|
|
4616
5057
|
* <p>The number of results to show in a single call to
|
|
4617
5058
|
* <code>ListSuppressedDestinations</code>. If the number of results is larger than the
|
|
4618
5059
|
* number you specified in this parameter, then the response includes a
|
|
@@ -4627,14 +5068,17 @@ export interface ListSuppressedDestinationsRequest {
|
|
|
4627
5068
|
*/
|
|
4628
5069
|
export interface SuppressedDestinationSummary {
|
|
4629
5070
|
/**
|
|
5071
|
+
* @public
|
|
4630
5072
|
* <p>The email address that's on the suppression list for your account.</p>
|
|
4631
5073
|
*/
|
|
4632
5074
|
EmailAddress: string | undefined;
|
|
4633
5075
|
/**
|
|
5076
|
+
* @public
|
|
4634
5077
|
* <p>The reason that the address was added to the suppression list for your account.</p>
|
|
4635
5078
|
*/
|
|
4636
5079
|
Reason: SuppressionListReason | string | undefined;
|
|
4637
5080
|
/**
|
|
5081
|
+
* @public
|
|
4638
5082
|
* <p>The date and time when the suppressed destination was last updated, shown in Unix time
|
|
4639
5083
|
* format.</p>
|
|
4640
5084
|
*/
|
|
@@ -4646,11 +5090,13 @@ export interface SuppressedDestinationSummary {
|
|
|
4646
5090
|
*/
|
|
4647
5091
|
export interface ListSuppressedDestinationsResponse {
|
|
4648
5092
|
/**
|
|
5093
|
+
* @public
|
|
4649
5094
|
* <p>A list of summaries, each containing a summary for a suppressed email
|
|
4650
5095
|
* destination.</p>
|
|
4651
5096
|
*/
|
|
4652
5097
|
SuppressedDestinationSummaries?: SuppressedDestinationSummary[];
|
|
4653
5098
|
/**
|
|
5099
|
+
* @public
|
|
4654
5100
|
* <p>A token that indicates that there are additional email addresses on the suppression
|
|
4655
5101
|
* list for your account. To view additional suppressed addresses, issue another request to
|
|
4656
5102
|
* <code>ListSuppressedDestinations</code>, and pass this token in the
|
|
@@ -4663,6 +5109,7 @@ export interface ListSuppressedDestinationsResponse {
|
|
|
4663
5109
|
*/
|
|
4664
5110
|
export interface ListTagsForResourceRequest {
|
|
4665
5111
|
/**
|
|
5112
|
+
* @public
|
|
4666
5113
|
* <p>The Amazon Resource Name (ARN) of the resource that you want to retrieve tag
|
|
4667
5114
|
* information for.</p>
|
|
4668
5115
|
*/
|
|
@@ -4673,6 +5120,7 @@ export interface ListTagsForResourceRequest {
|
|
|
4673
5120
|
*/
|
|
4674
5121
|
export interface ListTagsForResourceResponse {
|
|
4675
5122
|
/**
|
|
5123
|
+
* @public
|
|
4676
5124
|
* <p>An array that lists all the tags that are associated with the resource. Each tag
|
|
4677
5125
|
* consists of a required tag key (<code>Key</code>) and an associated tag value
|
|
4678
5126
|
* (<code>Value</code>)</p>
|
|
@@ -4685,6 +5133,7 @@ export interface ListTagsForResourceResponse {
|
|
|
4685
5133
|
*/
|
|
4686
5134
|
export interface PutAccountDedicatedIpWarmupAttributesRequest {
|
|
4687
5135
|
/**
|
|
5136
|
+
* @public
|
|
4688
5137
|
* <p>Enables or disables the automatic warm-up feature for dedicated IP addresses that are
|
|
4689
5138
|
* associated with your Amazon SES account in the current Amazon Web Services Region. Set to <code>true</code>
|
|
4690
5139
|
* to enable the automatic warm-up feature, or set to <code>false</code> to disable
|
|
@@ -4705,28 +5154,34 @@ export interface PutAccountDedicatedIpWarmupAttributesResponse {
|
|
|
4705
5154
|
*/
|
|
4706
5155
|
export interface PutAccountDetailsRequest {
|
|
4707
5156
|
/**
|
|
5157
|
+
* @public
|
|
4708
5158
|
* <p>The type of email your account will send.</p>
|
|
4709
5159
|
*/
|
|
4710
5160
|
MailType: MailType | string | undefined;
|
|
4711
5161
|
/**
|
|
5162
|
+
* @public
|
|
4712
5163
|
* <p>The URL of your website. This information helps us better understand the type of
|
|
4713
5164
|
* content that you plan to send.</p>
|
|
4714
5165
|
*/
|
|
4715
5166
|
WebsiteURL: string | undefined;
|
|
4716
5167
|
/**
|
|
5168
|
+
* @public
|
|
4717
5169
|
* <p>The language you would prefer to be contacted with.</p>
|
|
4718
5170
|
*/
|
|
4719
5171
|
ContactLanguage?: ContactLanguage | string;
|
|
4720
5172
|
/**
|
|
5173
|
+
* @public
|
|
4721
5174
|
* <p>A description of the types of email that you plan to send.</p>
|
|
4722
5175
|
*/
|
|
4723
5176
|
UseCaseDescription: string | undefined;
|
|
4724
5177
|
/**
|
|
5178
|
+
* @public
|
|
4725
5179
|
* <p>Additional email addresses that you would like to be notified regarding Amazon SES
|
|
4726
5180
|
* matters.</p>
|
|
4727
5181
|
*/
|
|
4728
5182
|
AdditionalContactEmailAddresses?: string[];
|
|
4729
5183
|
/**
|
|
5184
|
+
* @public
|
|
4730
5185
|
* <p>Indicates whether or not your account should have production access in the current
|
|
4731
5186
|
* Amazon Web Services Region.</p>
|
|
4732
5187
|
* <p>If the value is <code>false</code>, then your account is in the
|
|
@@ -4753,6 +5208,7 @@ export interface PutAccountDetailsResponse {
|
|
|
4753
5208
|
*/
|
|
4754
5209
|
export interface PutAccountSendingAttributesRequest {
|
|
4755
5210
|
/**
|
|
5211
|
+
* @public
|
|
4756
5212
|
* <p>Enables or disables your account's ability to send email. Set to <code>true</code> to
|
|
4757
5213
|
* enable email sending, or set to <code>false</code> to disable email sending.</p>
|
|
4758
5214
|
* <note>
|
|
@@ -4775,6 +5231,7 @@ export interface PutAccountSendingAttributesResponse {
|
|
|
4775
5231
|
*/
|
|
4776
5232
|
export interface PutAccountSuppressionAttributesRequest {
|
|
4777
5233
|
/**
|
|
5234
|
+
* @public
|
|
4778
5235
|
* <p>A list that contains the reasons that email addresses will be automatically added to
|
|
4779
5236
|
* the suppression list for your account. This list can contain any or all of the
|
|
4780
5237
|
* following:</p>
|
|
@@ -4808,6 +5265,7 @@ export interface PutAccountSuppressionAttributesResponse {
|
|
|
4808
5265
|
*/
|
|
4809
5266
|
export interface PutAccountVdmAttributesRequest {
|
|
4810
5267
|
/**
|
|
5268
|
+
* @public
|
|
4811
5269
|
* <p>The VDM attributes that you wish to apply to your Amazon SES account.</p>
|
|
4812
5270
|
*/
|
|
4813
5271
|
VdmAttributes: VdmAttributes | undefined;
|
|
@@ -4823,10 +5281,12 @@ export interface PutAccountVdmAttributesResponse {
|
|
|
4823
5281
|
*/
|
|
4824
5282
|
export interface PutConfigurationSetDeliveryOptionsRequest {
|
|
4825
5283
|
/**
|
|
5284
|
+
* @public
|
|
4826
5285
|
* <p>The name of the configuration set to associate with a dedicated IP pool.</p>
|
|
4827
5286
|
*/
|
|
4828
5287
|
ConfigurationSetName: string | undefined;
|
|
4829
5288
|
/**
|
|
5289
|
+
* @public
|
|
4830
5290
|
* <p>Specifies whether messages that use the configuration set are required to use
|
|
4831
5291
|
* Transport Layer Security (TLS). If the value is <code>Require</code>, messages are only
|
|
4832
5292
|
* delivered if a TLS connection can be established. If the value is <code>Optional</code>,
|
|
@@ -4834,6 +5294,7 @@ export interface PutConfigurationSetDeliveryOptionsRequest {
|
|
|
4834
5294
|
*/
|
|
4835
5295
|
TlsPolicy?: TlsPolicy | string;
|
|
4836
5296
|
/**
|
|
5297
|
+
* @public
|
|
4837
5298
|
* <p>The name of the dedicated IP pool to associate with the configuration set.</p>
|
|
4838
5299
|
*/
|
|
4839
5300
|
SendingPoolName?: string;
|
|
@@ -4852,10 +5313,12 @@ export interface PutConfigurationSetDeliveryOptionsResponse {
|
|
|
4852
5313
|
*/
|
|
4853
5314
|
export interface PutConfigurationSetReputationOptionsRequest {
|
|
4854
5315
|
/**
|
|
5316
|
+
* @public
|
|
4855
5317
|
* <p>The name of the configuration set.</p>
|
|
4856
5318
|
*/
|
|
4857
5319
|
ConfigurationSetName: string | undefined;
|
|
4858
5320
|
/**
|
|
5321
|
+
* @public
|
|
4859
5322
|
* <p>If <code>true</code>, tracking of reputation metrics is enabled for the configuration
|
|
4860
5323
|
* set. If <code>false</code>, tracking of reputation metrics is disabled for the
|
|
4861
5324
|
* configuration set.</p>
|
|
@@ -4876,10 +5339,12 @@ export interface PutConfigurationSetReputationOptionsResponse {
|
|
|
4876
5339
|
*/
|
|
4877
5340
|
export interface PutConfigurationSetSendingOptionsRequest {
|
|
4878
5341
|
/**
|
|
5342
|
+
* @public
|
|
4879
5343
|
* <p>The name of the configuration set to enable or disable email sending for.</p>
|
|
4880
5344
|
*/
|
|
4881
5345
|
ConfigurationSetName: string | undefined;
|
|
4882
5346
|
/**
|
|
5347
|
+
* @public
|
|
4883
5348
|
* <p>If <code>true</code>, email sending is enabled for the configuration set. If
|
|
4884
5349
|
* <code>false</code>, email sending is disabled for the configuration set.</p>
|
|
4885
5350
|
*/
|
|
@@ -4899,11 +5364,13 @@ export interface PutConfigurationSetSendingOptionsResponse {
|
|
|
4899
5364
|
*/
|
|
4900
5365
|
export interface PutConfigurationSetSuppressionOptionsRequest {
|
|
4901
5366
|
/**
|
|
5367
|
+
* @public
|
|
4902
5368
|
* <p>The name of the configuration set to change the suppression list preferences
|
|
4903
5369
|
* for.</p>
|
|
4904
5370
|
*/
|
|
4905
5371
|
ConfigurationSetName: string | undefined;
|
|
4906
5372
|
/**
|
|
5373
|
+
* @public
|
|
4907
5374
|
* <p>A list that contains the reasons that email addresses are automatically added to the
|
|
4908
5375
|
* suppression list for your account. This list can contain any or all of the
|
|
4909
5376
|
* following:</p>
|
|
@@ -4938,10 +5405,12 @@ export interface PutConfigurationSetSuppressionOptionsResponse {
|
|
|
4938
5405
|
*/
|
|
4939
5406
|
export interface PutConfigurationSetTrackingOptionsRequest {
|
|
4940
5407
|
/**
|
|
5408
|
+
* @public
|
|
4941
5409
|
* <p>The name of the configuration set.</p>
|
|
4942
5410
|
*/
|
|
4943
5411
|
ConfigurationSetName: string | undefined;
|
|
4944
5412
|
/**
|
|
5413
|
+
* @public
|
|
4945
5414
|
* <p>The domain to use to track open and click events.</p>
|
|
4946
5415
|
*/
|
|
4947
5416
|
CustomRedirectDomain?: string;
|
|
@@ -4959,10 +5428,12 @@ export interface PutConfigurationSetTrackingOptionsResponse {
|
|
|
4959
5428
|
*/
|
|
4960
5429
|
export interface PutConfigurationSetVdmOptionsRequest {
|
|
4961
5430
|
/**
|
|
5431
|
+
* @public
|
|
4962
5432
|
* <p>The name of the configuration set.</p>
|
|
4963
5433
|
*/
|
|
4964
5434
|
ConfigurationSetName: string | undefined;
|
|
4965
5435
|
/**
|
|
5436
|
+
* @public
|
|
4966
5437
|
* <p>The VDM options to apply to the configuration set.</p>
|
|
4967
5438
|
*/
|
|
4968
5439
|
VdmOptions?: VdmOptions;
|
|
@@ -4980,11 +5451,13 @@ export interface PutConfigurationSetVdmOptionsResponse {
|
|
|
4980
5451
|
*/
|
|
4981
5452
|
export interface PutDedicatedIpInPoolRequest {
|
|
4982
5453
|
/**
|
|
5454
|
+
* @public
|
|
4983
5455
|
* <p>The IP address that you want to move to the dedicated IP pool. The value you specify
|
|
4984
5456
|
* has to be a dedicated IP address that's associated with your Amazon Web Services account.</p>
|
|
4985
5457
|
*/
|
|
4986
5458
|
Ip: string | undefined;
|
|
4987
5459
|
/**
|
|
5460
|
+
* @public
|
|
4988
5461
|
* <p>The name of the IP pool that you want to add the dedicated IP address to. You have to
|
|
4989
5462
|
* specify an IP pool that already exists.</p>
|
|
4990
5463
|
*/
|
|
@@ -5003,10 +5476,12 @@ export interface PutDedicatedIpInPoolResponse {
|
|
|
5003
5476
|
*/
|
|
5004
5477
|
export interface PutDedicatedIpPoolScalingAttributesRequest {
|
|
5005
5478
|
/**
|
|
5479
|
+
* @public
|
|
5006
5480
|
* <p>The name of the dedicated IP pool.</p>
|
|
5007
5481
|
*/
|
|
5008
5482
|
PoolName: string | undefined;
|
|
5009
5483
|
/**
|
|
5484
|
+
* @public
|
|
5010
5485
|
* <p>The scaling mode to apply to the dedicated IP pool.</p>
|
|
5011
5486
|
* <note>
|
|
5012
5487
|
* <p>Changing the scaling mode from <code>MANAGED</code> to <code>STANDARD</code> is not supported.</p>
|
|
@@ -5028,10 +5503,12 @@ export interface PutDedicatedIpPoolScalingAttributesResponse {
|
|
|
5028
5503
|
*/
|
|
5029
5504
|
export interface PutDedicatedIpWarmupAttributesRequest {
|
|
5030
5505
|
/**
|
|
5506
|
+
* @public
|
|
5031
5507
|
* <p>The dedicated IP address that you want to update the warm-up attributes for.</p>
|
|
5032
5508
|
*/
|
|
5033
5509
|
Ip: string | undefined;
|
|
5034
5510
|
/**
|
|
5511
|
+
* @public
|
|
5035
5512
|
* <p>The warm-up percentage that you want to associate with the dedicated IP
|
|
5036
5513
|
* address.</p>
|
|
5037
5514
|
*/
|
|
@@ -5055,11 +5532,13 @@ export interface PutDedicatedIpWarmupAttributesResponse {
|
|
|
5055
5532
|
*/
|
|
5056
5533
|
export interface PutDeliverabilityDashboardOptionRequest {
|
|
5057
5534
|
/**
|
|
5535
|
+
* @public
|
|
5058
5536
|
* <p>Specifies whether to enable the Deliverability dashboard. To enable the dashboard, set this
|
|
5059
5537
|
* value to <code>true</code>.</p>
|
|
5060
5538
|
*/
|
|
5061
5539
|
DashboardEnabled: boolean | undefined;
|
|
5062
5540
|
/**
|
|
5541
|
+
* @public
|
|
5063
5542
|
* <p>An array of objects, one for each verified domain that you use to send email and
|
|
5064
5543
|
* enabled the Deliverability dashboard for.</p>
|
|
5065
5544
|
*/
|
|
@@ -5077,10 +5556,12 @@ export interface PutDeliverabilityDashboardOptionResponse {
|
|
|
5077
5556
|
*/
|
|
5078
5557
|
export interface PutEmailIdentityConfigurationSetAttributesRequest {
|
|
5079
5558
|
/**
|
|
5559
|
+
* @public
|
|
5080
5560
|
* <p>The email address or domain to associate with a configuration set.</p>
|
|
5081
5561
|
*/
|
|
5082
5562
|
EmailIdentity: string | undefined;
|
|
5083
5563
|
/**
|
|
5564
|
+
* @public
|
|
5084
5565
|
* <p>The configuration set to associate with an email identity.</p>
|
|
5085
5566
|
*/
|
|
5086
5567
|
ConfigurationSetName?: string;
|
|
@@ -5099,10 +5580,12 @@ export interface PutEmailIdentityConfigurationSetAttributesResponse {
|
|
|
5099
5580
|
*/
|
|
5100
5581
|
export interface PutEmailIdentityDkimAttributesRequest {
|
|
5101
5582
|
/**
|
|
5583
|
+
* @public
|
|
5102
5584
|
* <p>The email identity.</p>
|
|
5103
5585
|
*/
|
|
5104
5586
|
EmailIdentity: string | undefined;
|
|
5105
5587
|
/**
|
|
5588
|
+
* @public
|
|
5106
5589
|
* <p>Sets the DKIM signing configuration for the identity.</p>
|
|
5107
5590
|
* <p>When you set this value <code>true</code>, then the messages that are sent from the
|
|
5108
5591
|
* identity are signed using DKIM. If you set this value to <code>false</code>, your
|
|
@@ -5123,10 +5606,12 @@ export interface PutEmailIdentityDkimAttributesResponse {
|
|
|
5123
5606
|
*/
|
|
5124
5607
|
export interface PutEmailIdentityDkimSigningAttributesRequest {
|
|
5125
5608
|
/**
|
|
5609
|
+
* @public
|
|
5126
5610
|
* <p>The email identity.</p>
|
|
5127
5611
|
*/
|
|
5128
5612
|
EmailIdentity: string | undefined;
|
|
5129
5613
|
/**
|
|
5614
|
+
* @public
|
|
5130
5615
|
* <p>The method to use to configure DKIM for the identity. There are the following possible
|
|
5131
5616
|
* values:</p>
|
|
5132
5617
|
* <ul>
|
|
@@ -5144,6 +5629,7 @@ export interface PutEmailIdentityDkimSigningAttributesRequest {
|
|
|
5144
5629
|
*/
|
|
5145
5630
|
SigningAttributesOrigin: DkimSigningAttributesOrigin | string | undefined;
|
|
5146
5631
|
/**
|
|
5632
|
+
* @public
|
|
5147
5633
|
* <p>An object that contains information about the private key and selector that you want
|
|
5148
5634
|
* to use to configure DKIM for the identity for Bring Your Own DKIM (BYODKIM) for the
|
|
5149
5635
|
* identity, or, configures the key length to be used for <a href="https://docs.aws.amazon.com/ses/latest/DeveloperGuide/easy-dkim.html">Easy DKIM</a>.</p>
|
|
@@ -5157,6 +5643,7 @@ export interface PutEmailIdentityDkimSigningAttributesRequest {
|
|
|
5157
5643
|
*/
|
|
5158
5644
|
export interface PutEmailIdentityDkimSigningAttributesResponse {
|
|
5159
5645
|
/**
|
|
5646
|
+
* @public
|
|
5160
5647
|
* <p>The DKIM authentication status of the identity. Amazon SES determines the authentication
|
|
5161
5648
|
* status by searching for specific records in the DNS configuration for your domain. If
|
|
5162
5649
|
* you used <a href="https://docs.aws.amazon.com/ses/latest/DeveloperGuide/easy-dkim.html">Easy
|
|
@@ -5199,6 +5686,7 @@ export interface PutEmailIdentityDkimSigningAttributesResponse {
|
|
|
5199
5686
|
*/
|
|
5200
5687
|
DkimStatus?: DkimStatus | string;
|
|
5201
5688
|
/**
|
|
5689
|
+
* @public
|
|
5202
5690
|
* <p>If you used <a href="https://docs.aws.amazon.com/ses/latest/DeveloperGuide/easy-dkim.html">Easy DKIM</a> to configure DKIM authentication for the domain, then this object
|
|
5203
5691
|
* contains a set of unique strings that you use to create a set of CNAME records that you
|
|
5204
5692
|
* add to the DNS configuration for your domain. When Amazon SES detects these records in the
|
|
@@ -5218,10 +5706,12 @@ export interface PutEmailIdentityDkimSigningAttributesResponse {
|
|
|
5218
5706
|
*/
|
|
5219
5707
|
export interface PutEmailIdentityFeedbackAttributesRequest {
|
|
5220
5708
|
/**
|
|
5709
|
+
* @public
|
|
5221
5710
|
* <p>The email identity.</p>
|
|
5222
5711
|
*/
|
|
5223
5712
|
EmailIdentity: string | undefined;
|
|
5224
5713
|
/**
|
|
5714
|
+
* @public
|
|
5225
5715
|
* <p>Sets the feedback forwarding configuration for the identity.</p>
|
|
5226
5716
|
* <p>If the value is <code>true</code>, you receive email notifications when bounce or
|
|
5227
5717
|
* complaint events occur. These notifications are sent to the address that you specified
|
|
@@ -5246,10 +5736,12 @@ export interface PutEmailIdentityFeedbackAttributesResponse {
|
|
|
5246
5736
|
*/
|
|
5247
5737
|
export interface PutEmailIdentityMailFromAttributesRequest {
|
|
5248
5738
|
/**
|
|
5739
|
+
* @public
|
|
5249
5740
|
* <p>The verified email identity.</p>
|
|
5250
5741
|
*/
|
|
5251
5742
|
EmailIdentity: string | undefined;
|
|
5252
5743
|
/**
|
|
5744
|
+
* @public
|
|
5253
5745
|
* <p> The custom MAIL FROM domain that you want the verified identity to use. The MAIL FROM
|
|
5254
5746
|
* domain must meet the following criteria:</p>
|
|
5255
5747
|
* <ul>
|
|
@@ -5267,6 +5759,7 @@ export interface PutEmailIdentityMailFromAttributesRequest {
|
|
|
5267
5759
|
*/
|
|
5268
5760
|
MailFromDomain?: string;
|
|
5269
5761
|
/**
|
|
5762
|
+
* @public
|
|
5270
5763
|
* <p>The action to take if the required MX record isn't found when you send an email. When
|
|
5271
5764
|
* you set this value to <code>UseDefaultValue</code>, the mail is sent using
|
|
5272
5765
|
* <i>amazonses.com</i> as the MAIL FROM domain. When you set this value
|
|
@@ -5292,11 +5785,13 @@ export interface PutEmailIdentityMailFromAttributesResponse {
|
|
|
5292
5785
|
*/
|
|
5293
5786
|
export interface PutSuppressedDestinationRequest {
|
|
5294
5787
|
/**
|
|
5788
|
+
* @public
|
|
5295
5789
|
* <p>The email address that should be added to the suppression list for your
|
|
5296
5790
|
* account.</p>
|
|
5297
5791
|
*/
|
|
5298
5792
|
EmailAddress: string | undefined;
|
|
5299
5793
|
/**
|
|
5794
|
+
* @public
|
|
5300
5795
|
* <p>The factors that should cause the email address to be added to the suppression list
|
|
5301
5796
|
* for your account.</p>
|
|
5302
5797
|
*/
|
|
@@ -5317,11 +5812,13 @@ export interface PutSuppressedDestinationResponse {
|
|
|
5317
5812
|
*/
|
|
5318
5813
|
export interface SendBulkEmailRequest {
|
|
5319
5814
|
/**
|
|
5815
|
+
* @public
|
|
5320
5816
|
* <p>The email address to use as the "From" address for the email. The
|
|
5321
5817
|
* address that you specify has to be verified.</p>
|
|
5322
5818
|
*/
|
|
5323
5819
|
FromEmailAddress?: string;
|
|
5324
5820
|
/**
|
|
5821
|
+
* @public
|
|
5325
5822
|
* <p>This parameter is used only for sending authorization. It is the ARN of the identity
|
|
5326
5823
|
* that is associated with the sending authorization policy that permits you to use the
|
|
5327
5824
|
* email address specified in the <code>FromEmailAddress</code> parameter.</p>
|
|
@@ -5336,15 +5833,18 @@ export interface SendBulkEmailRequest {
|
|
|
5336
5833
|
*/
|
|
5337
5834
|
FromEmailAddressIdentityArn?: string;
|
|
5338
5835
|
/**
|
|
5836
|
+
* @public
|
|
5339
5837
|
* <p>The "Reply-to" email addresses for the message. When the recipient replies to the
|
|
5340
5838
|
* message, each Reply-to address receives the reply.</p>
|
|
5341
5839
|
*/
|
|
5342
5840
|
ReplyToAddresses?: string[];
|
|
5343
5841
|
/**
|
|
5842
|
+
* @public
|
|
5344
5843
|
* <p>The address that you want bounce and complaint notifications to be sent to.</p>
|
|
5345
5844
|
*/
|
|
5346
5845
|
FeedbackForwardingEmailAddress?: string;
|
|
5347
5846
|
/**
|
|
5847
|
+
* @public
|
|
5348
5848
|
* <p>This parameter is used only for sending authorization. It is the ARN of the identity
|
|
5349
5849
|
* that is associated with the sending authorization policy that permits you to use the
|
|
5350
5850
|
* email address specified in the <code>FeedbackForwardingEmailAddress</code>
|
|
@@ -5360,21 +5860,25 @@ export interface SendBulkEmailRequest {
|
|
|
5360
5860
|
*/
|
|
5361
5861
|
FeedbackForwardingEmailAddressIdentityArn?: string;
|
|
5362
5862
|
/**
|
|
5863
|
+
* @public
|
|
5363
5864
|
* <p>A list of tags, in the form of name/value pairs, to apply to an email that you send
|
|
5364
5865
|
* using the <code>SendEmail</code> operation. Tags correspond to characteristics of the
|
|
5365
5866
|
* email that you define, so that you can publish email sending events.</p>
|
|
5366
5867
|
*/
|
|
5367
5868
|
DefaultEmailTags?: MessageTag[];
|
|
5368
5869
|
/**
|
|
5870
|
+
* @public
|
|
5369
5871
|
* <p>An object that contains the body of the message. You can specify a template
|
|
5370
5872
|
* message.</p>
|
|
5371
5873
|
*/
|
|
5372
5874
|
DefaultContent: BulkEmailContent | undefined;
|
|
5373
5875
|
/**
|
|
5876
|
+
* @public
|
|
5374
5877
|
* <p>The list of bulk email entry objects.</p>
|
|
5375
5878
|
*/
|
|
5376
5879
|
BulkEmailEntries: BulkEmailEntry[] | undefined;
|
|
5377
5880
|
/**
|
|
5881
|
+
* @public
|
|
5378
5882
|
* <p>The name of the configuration set to use when sending the email.</p>
|
|
5379
5883
|
*/
|
|
5380
5884
|
ConfigurationSetName?: string;
|
|
@@ -5385,6 +5889,7 @@ export interface SendBulkEmailRequest {
|
|
|
5385
5889
|
*/
|
|
5386
5890
|
export interface SendBulkEmailResponse {
|
|
5387
5891
|
/**
|
|
5892
|
+
* @public
|
|
5388
5893
|
* <p>One object per intended recipient. Check each response object and retry any messages
|
|
5389
5894
|
* with a failure status.</p>
|
|
5390
5895
|
*/
|
|
@@ -5397,15 +5902,18 @@ export interface SendBulkEmailResponse {
|
|
|
5397
5902
|
*/
|
|
5398
5903
|
export interface SendCustomVerificationEmailRequest {
|
|
5399
5904
|
/**
|
|
5905
|
+
* @public
|
|
5400
5906
|
* <p>The email address to verify.</p>
|
|
5401
5907
|
*/
|
|
5402
5908
|
EmailAddress: string | undefined;
|
|
5403
5909
|
/**
|
|
5910
|
+
* @public
|
|
5404
5911
|
* <p>The name of the custom verification email template to use when sending the
|
|
5405
5912
|
* verification email.</p>
|
|
5406
5913
|
*/
|
|
5407
5914
|
TemplateName: string | undefined;
|
|
5408
5915
|
/**
|
|
5916
|
+
* @public
|
|
5409
5917
|
* <p>Name of a configuration set to use when sending the verification email.</p>
|
|
5410
5918
|
*/
|
|
5411
5919
|
ConfigurationSetName?: string;
|
|
@@ -5416,6 +5924,7 @@ export interface SendCustomVerificationEmailRequest {
|
|
|
5416
5924
|
*/
|
|
5417
5925
|
export interface SendCustomVerificationEmailResponse {
|
|
5418
5926
|
/**
|
|
5927
|
+
* @public
|
|
5419
5928
|
* <p>The unique message identifier returned from the
|
|
5420
5929
|
* <code>SendCustomVerificationEmail</code> operation.</p>
|
|
5421
5930
|
*/
|
|
@@ -5429,12 +5938,14 @@ export interface SendCustomVerificationEmailResponse {
|
|
|
5429
5938
|
*/
|
|
5430
5939
|
export interface SendEmailRequest {
|
|
5431
5940
|
/**
|
|
5941
|
+
* @public
|
|
5432
5942
|
* <p>The email address to use as the "From" address for the email. The
|
|
5433
5943
|
* address that you specify has to be verified.
|
|
5434
5944
|
* </p>
|
|
5435
5945
|
*/
|
|
5436
5946
|
FromEmailAddress?: string;
|
|
5437
5947
|
/**
|
|
5948
|
+
* @public
|
|
5438
5949
|
* <p>This parameter is used only for sending authorization. It is the ARN of the identity
|
|
5439
5950
|
* that is associated with the sending authorization policy that permits you to use the
|
|
5440
5951
|
* email address specified in the <code>FromEmailAddress</code> parameter.</p>
|
|
@@ -5452,19 +5963,23 @@ export interface SendEmailRequest {
|
|
|
5452
5963
|
*/
|
|
5453
5964
|
FromEmailAddressIdentityArn?: string;
|
|
5454
5965
|
/**
|
|
5966
|
+
* @public
|
|
5455
5967
|
* <p>An object that contains the recipients of the email message.</p>
|
|
5456
5968
|
*/
|
|
5457
5969
|
Destination?: Destination;
|
|
5458
5970
|
/**
|
|
5971
|
+
* @public
|
|
5459
5972
|
* <p>The "Reply-to" email addresses for the message. When the recipient replies to the
|
|
5460
5973
|
* message, each Reply-to address receives the reply.</p>
|
|
5461
5974
|
*/
|
|
5462
5975
|
ReplyToAddresses?: string[];
|
|
5463
5976
|
/**
|
|
5977
|
+
* @public
|
|
5464
5978
|
* <p>The address that you want bounce and complaint notifications to be sent to.</p>
|
|
5465
5979
|
*/
|
|
5466
5980
|
FeedbackForwardingEmailAddress?: string;
|
|
5467
5981
|
/**
|
|
5982
|
+
* @public
|
|
5468
5983
|
* <p>This parameter is used only for sending authorization. It is the ARN of the identity
|
|
5469
5984
|
* that is associated with the sending authorization policy that permits you to use the
|
|
5470
5985
|
* email address specified in the <code>FeedbackForwardingEmailAddress</code>
|
|
@@ -5480,21 +5995,25 @@ export interface SendEmailRequest {
|
|
|
5480
5995
|
*/
|
|
5481
5996
|
FeedbackForwardingEmailAddressIdentityArn?: string;
|
|
5482
5997
|
/**
|
|
5998
|
+
* @public
|
|
5483
5999
|
* <p>An object that contains the body of the message. You can send either a Simple message
|
|
5484
6000
|
* Raw message or a template Message.</p>
|
|
5485
6001
|
*/
|
|
5486
6002
|
Content: EmailContent | undefined;
|
|
5487
6003
|
/**
|
|
6004
|
+
* @public
|
|
5488
6005
|
* <p>A list of tags, in the form of name/value pairs, to apply to an email that you send
|
|
5489
6006
|
* using the <code>SendEmail</code> operation. Tags correspond to characteristics of the
|
|
5490
6007
|
* email that you define, so that you can publish email sending events. </p>
|
|
5491
6008
|
*/
|
|
5492
6009
|
EmailTags?: MessageTag[];
|
|
5493
6010
|
/**
|
|
6011
|
+
* @public
|
|
5494
6012
|
* <p>The name of the configuration set to use when sending the email.</p>
|
|
5495
6013
|
*/
|
|
5496
6014
|
ConfigurationSetName?: string;
|
|
5497
6015
|
/**
|
|
6016
|
+
* @public
|
|
5498
6017
|
* <p>An object used to specify a list or topic to which an email belongs, which will be
|
|
5499
6018
|
* used when a contact chooses to unsubscribe.</p>
|
|
5500
6019
|
*/
|
|
@@ -5506,6 +6025,7 @@ export interface SendEmailRequest {
|
|
|
5506
6025
|
*/
|
|
5507
6026
|
export interface SendEmailResponse {
|
|
5508
6027
|
/**
|
|
6028
|
+
* @public
|
|
5509
6029
|
* <p>A unique identifier for the message that is generated when the message is
|
|
5510
6030
|
* accepted.</p>
|
|
5511
6031
|
* <note>
|
|
@@ -5522,11 +6042,13 @@ export interface SendEmailResponse {
|
|
|
5522
6042
|
*/
|
|
5523
6043
|
export interface TagResourceRequest {
|
|
5524
6044
|
/**
|
|
6045
|
+
* @public
|
|
5525
6046
|
* <p>The Amazon Resource Name (ARN) of the resource that you want to add one or more tags
|
|
5526
6047
|
* to.</p>
|
|
5527
6048
|
*/
|
|
5528
6049
|
ResourceArn: string | undefined;
|
|
5529
6050
|
/**
|
|
6051
|
+
* @public
|
|
5530
6052
|
* <p>A list of the tags that you want to add to the resource. A tag consists of a required
|
|
5531
6053
|
* tag key (<code>Key</code>) and an associated tag value (<code>Value</code>). The maximum
|
|
5532
6054
|
* length of a tag key is 128 characters. The maximum length of a tag value is 256
|
|
@@ -5546,10 +6068,12 @@ export interface TagResourceResponse {
|
|
|
5546
6068
|
*/
|
|
5547
6069
|
export interface TestRenderEmailTemplateRequest {
|
|
5548
6070
|
/**
|
|
6071
|
+
* @public
|
|
5549
6072
|
* <p>The name of the template.</p>
|
|
5550
6073
|
*/
|
|
5551
6074
|
TemplateName: string | undefined;
|
|
5552
6075
|
/**
|
|
6076
|
+
* @public
|
|
5553
6077
|
* <p>A list of replacement values to apply to the template. This parameter is a JSON
|
|
5554
6078
|
* object, typically consisting of key-value pairs in which the keys correspond to
|
|
5555
6079
|
* replacement tags in the email template.</p>
|
|
@@ -5562,6 +6086,7 @@ export interface TestRenderEmailTemplateRequest {
|
|
|
5562
6086
|
*/
|
|
5563
6087
|
export interface TestRenderEmailTemplateResponse {
|
|
5564
6088
|
/**
|
|
6089
|
+
* @public
|
|
5565
6090
|
* <p>The complete MIME message rendered by applying the data in the
|
|
5566
6091
|
* <code>TemplateData</code> parameter to the template specified in the TemplateName
|
|
5567
6092
|
* parameter.</p>
|
|
@@ -5573,11 +6098,13 @@ export interface TestRenderEmailTemplateResponse {
|
|
|
5573
6098
|
*/
|
|
5574
6099
|
export interface UntagResourceRequest {
|
|
5575
6100
|
/**
|
|
6101
|
+
* @public
|
|
5576
6102
|
* <p>The Amazon Resource Name (ARN) of the resource that you want to remove one or more
|
|
5577
6103
|
* tags from.</p>
|
|
5578
6104
|
*/
|
|
5579
6105
|
ResourceArn: string | undefined;
|
|
5580
6106
|
/**
|
|
6107
|
+
* @public
|
|
5581
6108
|
* <p>The tags (tag keys) that you want to remove from the resource. When you specify a tag
|
|
5582
6109
|
* key, the action removes both that key and its associated tag value.</p>
|
|
5583
6110
|
* <p>To remove more than one tag from the resource, append the <code>TagKeys</code>
|
|
@@ -5600,15 +6127,18 @@ export interface UntagResourceResponse {
|
|
|
5600
6127
|
*/
|
|
5601
6128
|
export interface UpdateConfigurationSetEventDestinationRequest {
|
|
5602
6129
|
/**
|
|
6130
|
+
* @public
|
|
5603
6131
|
* <p>The name of the configuration set that contains the event destination to
|
|
5604
6132
|
* modify.</p>
|
|
5605
6133
|
*/
|
|
5606
6134
|
ConfigurationSetName: string | undefined;
|
|
5607
6135
|
/**
|
|
6136
|
+
* @public
|
|
5608
6137
|
* <p>The name of the event destination.</p>
|
|
5609
6138
|
*/
|
|
5610
6139
|
EventDestinationName: string | undefined;
|
|
5611
6140
|
/**
|
|
6141
|
+
* @public
|
|
5612
6142
|
* <p>An object that defines the event destination.</p>
|
|
5613
6143
|
*/
|
|
5614
6144
|
EventDestination: EventDestinationDefinition | undefined;
|
|
@@ -5625,23 +6155,28 @@ export interface UpdateConfigurationSetEventDestinationResponse {
|
|
|
5625
6155
|
*/
|
|
5626
6156
|
export interface UpdateContactRequest {
|
|
5627
6157
|
/**
|
|
6158
|
+
* @public
|
|
5628
6159
|
* <p>The name of the contact list.</p>
|
|
5629
6160
|
*/
|
|
5630
6161
|
ContactListName: string | undefined;
|
|
5631
6162
|
/**
|
|
6163
|
+
* @public
|
|
5632
6164
|
* <p>The contact's email address.</p>
|
|
5633
6165
|
*/
|
|
5634
6166
|
EmailAddress: string | undefined;
|
|
5635
6167
|
/**
|
|
6168
|
+
* @public
|
|
5636
6169
|
* <p>The contact's preference for being opted-in to or opted-out of a topic.</p>
|
|
5637
6170
|
*/
|
|
5638
6171
|
TopicPreferences?: TopicPreference[];
|
|
5639
6172
|
/**
|
|
6173
|
+
* @public
|
|
5640
6174
|
* <p>A boolean value status noting if the contact is unsubscribed from all contact list
|
|
5641
6175
|
* topics.</p>
|
|
5642
6176
|
*/
|
|
5643
6177
|
UnsubscribeAll?: boolean;
|
|
5644
6178
|
/**
|
|
6179
|
+
* @public
|
|
5645
6180
|
* <p>The attribute data attached to a contact.</p>
|
|
5646
6181
|
*/
|
|
5647
6182
|
AttributesData?: string;
|
|
@@ -5656,15 +6191,18 @@ export interface UpdateContactResponse {
|
|
|
5656
6191
|
*/
|
|
5657
6192
|
export interface UpdateContactListRequest {
|
|
5658
6193
|
/**
|
|
6194
|
+
* @public
|
|
5659
6195
|
* <p>The name of the contact list.</p>
|
|
5660
6196
|
*/
|
|
5661
6197
|
ContactListName: string | undefined;
|
|
5662
6198
|
/**
|
|
6199
|
+
* @public
|
|
5663
6200
|
* <p>An interest group, theme, or label within a list. A contact list can have multiple
|
|
5664
6201
|
* topics.</p>
|
|
5665
6202
|
*/
|
|
5666
6203
|
Topics?: Topic[];
|
|
5667
6204
|
/**
|
|
6205
|
+
* @public
|
|
5668
6206
|
* <p>A description of what the contact list is about.</p>
|
|
5669
6207
|
*/
|
|
5670
6208
|
Description?: string;
|
|
@@ -5680,18 +6218,22 @@ export interface UpdateContactListResponse {
|
|
|
5680
6218
|
*/
|
|
5681
6219
|
export interface UpdateCustomVerificationEmailTemplateRequest {
|
|
5682
6220
|
/**
|
|
6221
|
+
* @public
|
|
5683
6222
|
* <p>The name of the custom verification email template that you want to update.</p>
|
|
5684
6223
|
*/
|
|
5685
6224
|
TemplateName: string | undefined;
|
|
5686
6225
|
/**
|
|
6226
|
+
* @public
|
|
5687
6227
|
* <p>The email address that the custom verification email is sent from.</p>
|
|
5688
6228
|
*/
|
|
5689
6229
|
FromEmailAddress: string | undefined;
|
|
5690
6230
|
/**
|
|
6231
|
+
* @public
|
|
5691
6232
|
* <p>The subject line of the custom verification email.</p>
|
|
5692
6233
|
*/
|
|
5693
6234
|
TemplateSubject: string | undefined;
|
|
5694
6235
|
/**
|
|
6236
|
+
* @public
|
|
5695
6237
|
* <p>The content of the custom verification email. The total size of the email must be less
|
|
5696
6238
|
* than 10 MB. The message body may contain HTML, with some limitations. For more
|
|
5697
6239
|
* information, see <a href="https://docs.aws.amazon.com/ses/latest/dg/creating-identities.html#send-email-verify-address-custom-faq">Custom verification email frequently asked questions</a> in the <i>Amazon SES
|
|
@@ -5699,11 +6241,13 @@ export interface UpdateCustomVerificationEmailTemplateRequest {
|
|
|
5699
6241
|
*/
|
|
5700
6242
|
TemplateContent: string | undefined;
|
|
5701
6243
|
/**
|
|
6244
|
+
* @public
|
|
5702
6245
|
* <p>The URL that the recipient of the verification email is sent to if his or her address
|
|
5703
6246
|
* is successfully verified.</p>
|
|
5704
6247
|
*/
|
|
5705
6248
|
SuccessRedirectionURL: string | undefined;
|
|
5706
6249
|
/**
|
|
6250
|
+
* @public
|
|
5707
6251
|
* <p>The URL that the recipient of the verification email is sent to if his or her address
|
|
5708
6252
|
* is not successfully verified.</p>
|
|
5709
6253
|
*/
|
|
@@ -5724,16 +6268,19 @@ export interface UpdateCustomVerificationEmailTemplateResponse {
|
|
|
5724
6268
|
*/
|
|
5725
6269
|
export interface UpdateEmailIdentityPolicyRequest {
|
|
5726
6270
|
/**
|
|
6271
|
+
* @public
|
|
5727
6272
|
* <p>The email identity.</p>
|
|
5728
6273
|
*/
|
|
5729
6274
|
EmailIdentity: string | undefined;
|
|
5730
6275
|
/**
|
|
6276
|
+
* @public
|
|
5731
6277
|
* <p>The name of the policy.</p>
|
|
5732
6278
|
* <p>The policy name cannot exceed 64 characters and can only include alphanumeric
|
|
5733
6279
|
* characters, dashes, and underscores.</p>
|
|
5734
6280
|
*/
|
|
5735
6281
|
PolicyName: string | undefined;
|
|
5736
6282
|
/**
|
|
6283
|
+
* @public
|
|
5737
6284
|
* <p>The text of the policy in JSON format. The policy cannot exceed 4 KB.</p>
|
|
5738
6285
|
* <p> For information about the syntax of sending authorization policies, see the <a href="https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization-policies.html">Amazon SES Developer
|
|
5739
6286
|
* Guide</a>.</p>
|
|
@@ -5754,10 +6301,12 @@ export interface UpdateEmailIdentityPolicyResponse {
|
|
|
5754
6301
|
*/
|
|
5755
6302
|
export interface UpdateEmailTemplateRequest {
|
|
5756
6303
|
/**
|
|
6304
|
+
* @public
|
|
5757
6305
|
* <p>The name of the template.</p>
|
|
5758
6306
|
*/
|
|
5759
6307
|
TemplateName: string | undefined;
|
|
5760
6308
|
/**
|
|
6309
|
+
* @public
|
|
5761
6310
|
* <p>The content of the email template, composed of a subject line, an HTML part, and a
|
|
5762
6311
|
* text-only part.</p>
|
|
5763
6312
|
*/
|