@aws-sdk/client-pinpoint-email 3.379.1 → 3.385.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.
@@ -67,6 +67,7 @@ export type TlsPolicy = (typeof TlsPolicy)[keyof typeof TlsPolicy];
67
67
  */
68
68
  export interface DeliveryOptions {
69
69
  /**
70
+ * @public
70
71
  * <p>Specifies whether messages that use the configuration set are required to use
71
72
  * Transport Layer Security (TLS). If the value is <code>Require</code>, messages are only
72
73
  * delivered if a TLS connection can be established. If the value is <code>Optional</code>,
@@ -74,6 +75,7 @@ export interface DeliveryOptions {
74
75
  */
75
76
  TlsPolicy?: TlsPolicy | string;
76
77
  /**
78
+ * @public
77
79
  * <p>The name of the dedicated IP pool that you want to associate with the configuration
78
80
  * set.</p>
79
81
  */
@@ -86,12 +88,14 @@ export interface DeliveryOptions {
86
88
  */
87
89
  export interface ReputationOptions {
88
90
  /**
91
+ * @public
89
92
  * <p>If <code>true</code>, tracking of reputation metrics is enabled for the configuration
90
93
  * set. If <code>false</code>, tracking of reputation metrics is disabled for the
91
94
  * configuration set.</p>
92
95
  */
93
96
  ReputationMetricsEnabled?: boolean;
94
97
  /**
98
+ * @public
95
99
  * <p>The date and time (in Unix time) when the reputation metrics were last given a fresh
96
100
  * start. When your account is given a fresh start, your reputation metrics are calculated
97
101
  * starting from the date of the fresh start.</p>
@@ -105,6 +109,7 @@ export interface ReputationOptions {
105
109
  */
106
110
  export interface SendingOptions {
107
111
  /**
112
+ * @public
108
113
  * <p>If <code>true</code>, email sending is enabled for the configuration set. If
109
114
  * <code>false</code>, email sending is disabled for the configuration set.</p>
110
115
  */
@@ -148,11 +153,13 @@ export interface SendingOptions {
148
153
  */
149
154
  export interface Tag {
150
155
  /**
156
+ * @public
151
157
  * <p>One part of a key-value pair that defines a tag. The maximum length of a tag key is
152
158
  * 128 characters. The minimum length is 1 character.</p>
153
159
  */
154
160
  Key: string | undefined;
155
161
  /**
162
+ * @public
156
163
  * <p>The optional part of a key-value pair that defines a tag. The maximum length of a tag
157
164
  * value is 256 characters. The minimum length is 0 characters. If you don’t want a
158
165
  * resource to have a specific tag value, don’t specify a value for this parameter. Amazon Pinpoint
@@ -172,6 +179,7 @@ export interface Tag {
172
179
  */
173
180
  export interface TrackingOptions {
174
181
  /**
182
+ * @public
175
183
  * <p>The domain that you want to use for tracking open and click events.</p>
176
184
  */
177
185
  CustomRedirectDomain: string | undefined;
@@ -182,30 +190,36 @@ export interface TrackingOptions {
182
190
  */
183
191
  export interface CreateConfigurationSetRequest {
184
192
  /**
193
+ * @public
185
194
  * <p>The name of the configuration set.</p>
186
195
  */
187
196
  ConfigurationSetName: string | undefined;
188
197
  /**
198
+ * @public
189
199
  * <p>An object that defines the open and click tracking options for emails that you send
190
200
  * using the configuration set.</p>
191
201
  */
192
202
  TrackingOptions?: TrackingOptions;
193
203
  /**
204
+ * @public
194
205
  * <p>An object that defines the dedicated IP pool that is used to send emails that you send
195
206
  * using the configuration set.</p>
196
207
  */
197
208
  DeliveryOptions?: DeliveryOptions;
198
209
  /**
210
+ * @public
199
211
  * <p>An object that defines whether or not Amazon Pinpoint collects reputation metrics for the emails
200
212
  * that you send that use the configuration set.</p>
201
213
  */
202
214
  ReputationOptions?: ReputationOptions;
203
215
  /**
216
+ * @public
204
217
  * <p>An object that defines whether or not Amazon Pinpoint can send email that you send using the
205
218
  * configuration set.</p>
206
219
  */
207
220
  SendingOptions?: SendingOptions;
208
221
  /**
222
+ * @public
209
223
  * <p>An array of objects that define the tags (keys and values) that you want to associate
210
224
  * with the configuration set.</p>
211
225
  */
@@ -274,6 +288,7 @@ export type DimensionValueSource = (typeof DimensionValueSource)[keyof typeof Di
274
288
  */
275
289
  export interface CloudWatchDimensionConfiguration {
276
290
  /**
291
+ * @public
277
292
  * <p>The name of an Amazon CloudWatch dimension associated with an email sending metric. The name has to
278
293
  * meet the following criteria:</p>
279
294
  * <ul>
@@ -288,6 +303,7 @@ export interface CloudWatchDimensionConfiguration {
288
303
  */
289
304
  DimensionName: string | undefined;
290
305
  /**
306
+ * @public
291
307
  * <p>The location where Amazon Pinpoint finds the value of a dimension to publish to Amazon CloudWatch. If you
292
308
  * want Amazon Pinpoint to use the message tags that you specify using an X-SES-MESSAGE-TAGS header
293
309
  * or a parameter to the SendEmail/SendRawEmail API, choose <code>messageTag</code>. If you
@@ -296,6 +312,7 @@ export interface CloudWatchDimensionConfiguration {
296
312
  */
297
313
  DimensionValueSource: DimensionValueSource | string | undefined;
298
314
  /**
315
+ * @public
299
316
  * <p>The default value of the dimension that is published to Amazon CloudWatch if you don't provide the
300
317
  * value of the dimension when you send an email. This value has to meet the following
301
318
  * criteria:</p>
@@ -318,6 +335,7 @@ export interface CloudWatchDimensionConfiguration {
318
335
  */
319
336
  export interface CloudWatchDestination {
320
337
  /**
338
+ * @public
321
339
  * <p>An array of objects that define the dimensions to use when you send email events to
322
340
  * Amazon CloudWatch.</p>
323
341
  */
@@ -330,11 +348,13 @@ export interface CloudWatchDestination {
330
348
  */
331
349
  export interface KinesisFirehoseDestination {
332
350
  /**
351
+ * @public
333
352
  * <p>The Amazon Resource Name (ARN) of the IAM role that Amazon Pinpoint uses when sending email
334
353
  * events to the Amazon Kinesis Data Firehose stream.</p>
335
354
  */
336
355
  IamRoleArn: string | undefined;
337
356
  /**
357
+ * @public
338
358
  * <p>The Amazon Resource Name (ARN) of the Amazon Kinesis Data Firehose stream that Amazon Pinpoint sends email events
339
359
  * to.</p>
340
360
  */
@@ -366,6 +386,7 @@ export type EventType = (typeof EventType)[keyof typeof EventType];
366
386
  */
367
387
  export interface PinpointDestination {
368
388
  /**
389
+ * @public
369
390
  * <p>The Amazon Resource Name (ARN) of the Amazon Pinpoint project that you want to send email
370
391
  * events to.</p>
371
392
  */
@@ -378,6 +399,7 @@ export interface PinpointDestination {
378
399
  */
379
400
  export interface SnsDestination {
380
401
  /**
402
+ * @public
381
403
  * <p>The Amazon Resource Name (ARN) of the Amazon SNS topic that you want to publish email
382
404
  * events to. For more information about Amazon SNS topics, see the <a href="https://docs.aws.amazon.com/sns/latest/dg/CreateTopic.html">Amazon SNS Developer
383
405
  * Guide</a>.</p>
@@ -393,6 +415,7 @@ export interface SnsDestination {
393
415
  */
394
416
  export interface EventDestinationDefinition {
395
417
  /**
418
+ * @public
396
419
  * <p>If <code>true</code>, the event destination is enabled. When the event destination is
397
420
  * enabled, the specified event types are sent to the destinations in this
398
421
  * <code>EventDestinationDefinition</code>.</p>
@@ -401,26 +424,31 @@ export interface EventDestinationDefinition {
401
424
  */
402
425
  Enabled?: boolean;
403
426
  /**
427
+ * @public
404
428
  * <p>An array that specifies which events Amazon Pinpoint should send to the destinations in this
405
429
  * <code>EventDestinationDefinition</code>.</p>
406
430
  */
407
431
  MatchingEventTypes?: (EventType | string)[];
408
432
  /**
433
+ * @public
409
434
  * <p>An object that defines an Amazon Kinesis Data Firehose destination for email events. You can use Amazon Kinesis Data Firehose to
410
435
  * stream data to other services, such as Amazon S3 and Amazon Redshift.</p>
411
436
  */
412
437
  KinesisFirehoseDestination?: KinesisFirehoseDestination;
413
438
  /**
439
+ * @public
414
440
  * <p>An object that defines an Amazon CloudWatch destination for email events. You can use Amazon CloudWatch to
415
441
  * monitor and gain insights on your email sending metrics.</p>
416
442
  */
417
443
  CloudWatchDestination?: CloudWatchDestination;
418
444
  /**
445
+ * @public
419
446
  * <p>An object that defines an Amazon SNS destination for email events. You can use Amazon SNS to
420
447
  * send notification when certain email events occur.</p>
421
448
  */
422
449
  SnsDestination?: SnsDestination;
423
450
  /**
451
+ * @public
424
452
  * <p>An object that defines a Amazon Pinpoint destination for email events. You can use Amazon Pinpoint events
425
453
  * to create attributes in Amazon Pinpoint projects. You can use these attributes to create segments
426
454
  * for your campaigns.</p>
@@ -433,14 +461,17 @@ export interface EventDestinationDefinition {
433
461
  */
434
462
  export interface CreateConfigurationSetEventDestinationRequest {
435
463
  /**
464
+ * @public
436
465
  * <p>The name of the configuration set that you want to add an event destination to.</p>
437
466
  */
438
467
  ConfigurationSetName: string | undefined;
439
468
  /**
469
+ * @public
440
470
  * <p>A name that identifies the event destination within the configuration set.</p>
441
471
  */
442
472
  EventDestinationName: string | undefined;
443
473
  /**
474
+ * @public
444
475
  * <p>An object that defines the event destination.</p>
445
476
  */
446
477
  EventDestination: EventDestinationDefinition | undefined;
@@ -458,10 +489,12 @@ export interface CreateConfigurationSetEventDestinationResponse {
458
489
  */
459
490
  export interface CreateDedicatedIpPoolRequest {
460
491
  /**
492
+ * @public
461
493
  * <p>The name of the dedicated IP pool.</p>
462
494
  */
463
495
  PoolName: string | undefined;
464
496
  /**
497
+ * @public
465
498
  * <p>An object that defines the tags (keys and values) that you want to associate with the
466
499
  * pool.</p>
467
500
  */
@@ -480,6 +513,7 @@ export interface CreateDedicatedIpPoolResponse {
480
513
  */
481
514
  export interface RawMessage {
482
515
  /**
516
+ * @public
483
517
  * <p>The raw email message. The message has to meet the following criteria:</p>
484
518
  * <ul>
485
519
  * <li>
@@ -519,10 +553,12 @@ export interface RawMessage {
519
553
  */
520
554
  export interface Content {
521
555
  /**
556
+ * @public
522
557
  * <p>The content of the message itself.</p>
523
558
  */
524
559
  Data: string | undefined;
525
560
  /**
561
+ * @public
526
562
  * <p>The character set for the content. Because of the constraints of the SMTP protocol,
527
563
  * Amazon Pinpoint uses 7-bit ASCII by default. If the text includes characters outside of the ASCII
528
564
  * range, you have to specify a character set. For example, you could specify
@@ -536,12 +572,14 @@ export interface Content {
536
572
  */
537
573
  export interface Body {
538
574
  /**
575
+ * @public
539
576
  * <p>An object that represents the version of the message that is displayed in email
540
577
  * clients that don't support HTML, or clients where the recipient has disabled HTML
541
578
  * rendering.</p>
542
579
  */
543
580
  Text?: Content;
544
581
  /**
582
+ * @public
545
583
  * <p>An object that represents the version of the message that is displayed in email
546
584
  * clients that support HTML. HTML messages can include formatted text, hyperlinks, images,
547
585
  * and more. </p>
@@ -555,12 +593,14 @@ export interface Body {
555
593
  */
556
594
  export interface Message {
557
595
  /**
596
+ * @public
558
597
  * <p>The subject line of the email. The subject line can only contain 7-bit ASCII
559
598
  * characters. However, you can specify non-ASCII characters in the subject line by using
560
599
  * encoded-word syntax, as described in <a href="https://tools.ietf.org/html/rfc2047">RFC 2047</a>.</p>
561
600
  */
562
601
  Subject: Content | undefined;
563
602
  /**
603
+ * @public
564
604
  * <p>The body of the message. You can specify an HTML version of the message, a text-only
565
605
  * version of the message, or both.</p>
566
606
  */
@@ -571,10 +611,12 @@ export interface Message {
571
611
  */
572
612
  export interface Template {
573
613
  /**
614
+ * @public
574
615
  * <p>The Amazon Resource Name (ARN) of the template.</p>
575
616
  */
576
617
  TemplateArn?: string;
577
618
  /**
619
+ * @public
578
620
  * <p>An object that defines the values to use for message variables in the template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the value to use for that variable.</p>
579
621
  */
580
622
  TemplateData?: string;
@@ -589,10 +631,12 @@ export interface Template {
589
631
  */
590
632
  export interface EmailContent {
591
633
  /**
634
+ * @public
592
635
  * <p>The simple email message. The message consists of a subject and a message body.</p>
593
636
  */
594
637
  Simple?: Message;
595
638
  /**
639
+ * @public
596
640
  * <p>The raw email message. The message has to meet the following criteria:</p>
597
641
  * <ul>
598
642
  * <li>
@@ -625,6 +669,7 @@ export interface EmailContent {
625
669
  */
626
670
  Raw?: RawMessage;
627
671
  /**
672
+ * @public
628
673
  * <p>The template to use for the email message.</p>
629
674
  */
630
675
  Template?: Template;
@@ -641,19 +686,23 @@ export interface EmailContent {
641
686
  */
642
687
  export interface CreateDeliverabilityTestReportRequest {
643
688
  /**
689
+ * @public
644
690
  * <p>A unique name that helps you to identify the predictive inbox placement test when you retrieve the
645
691
  * results.</p>
646
692
  */
647
693
  ReportName?: string;
648
694
  /**
695
+ * @public
649
696
  * <p>The email address that the predictive inbox placement test email was sent from.</p>
650
697
  */
651
698
  FromEmailAddress: string | undefined;
652
699
  /**
700
+ * @public
653
701
  * <p>The HTML body of the message that you sent when you performed the predictive inbox placement test.</p>
654
702
  */
655
703
  Content: EmailContent | undefined;
656
704
  /**
705
+ * @public
657
706
  * <p>An array of objects that define the tags (keys and values) that you want to associate
658
707
  * with the predictive inbox placement test.</p>
659
708
  */
@@ -677,10 +726,12 @@ export type DeliverabilityTestStatus = (typeof DeliverabilityTestStatus)[keyof t
677
726
  */
678
727
  export interface CreateDeliverabilityTestReportResponse {
679
728
  /**
729
+ * @public
680
730
  * <p>A unique string that identifies the predictive inbox placement test.</p>
681
731
  */
682
732
  ReportId: string | undefined;
683
733
  /**
734
+ * @public
684
735
  * <p>The status of the predictive inbox placement test. If the status is <code>IN_PROGRESS</code>, then the predictive inbox placement test
685
736
  * is currently running. Predictive inbox placement tests are usually complete within 24 hours of creating the
686
737
  * test. If the status is <code>COMPLETE</code>, then the test is finished, and you can use
@@ -732,10 +783,12 @@ export declare class SendingPausedException extends __BaseException {
732
783
  */
733
784
  export interface CreateEmailIdentityRequest {
734
785
  /**
786
+ * @public
735
787
  * <p>The email address or domain that you want to verify.</p>
736
788
  */
737
789
  EmailIdentity: string | undefined;
738
790
  /**
791
+ * @public
739
792
  * <p>An array of objects that define the tags (keys and values) that you want to associate
740
793
  * with the email identity.</p>
741
794
  */
@@ -763,12 +816,14 @@ export type DkimStatus = (typeof DkimStatus)[keyof typeof DkimStatus];
763
816
  */
764
817
  export interface DkimAttributes {
765
818
  /**
819
+ * @public
766
820
  * <p>If the value is <code>true</code>, then the messages that Amazon Pinpoint sends from the
767
821
  * identity are DKIM-signed. If the value is <code>false</code>, then the messages that
768
822
  * Amazon Pinpoint sends from the identity aren't DKIM-signed.</p>
769
823
  */
770
824
  SigningEnabled?: boolean;
771
825
  /**
826
+ * @public
772
827
  * <p>Describes whether or not Amazon Pinpoint has successfully located the DKIM records in the DNS
773
828
  * records for the domain. The status can be one of the following:</p>
774
829
  * <ul>
@@ -803,6 +858,7 @@ export interface DkimAttributes {
803
858
  */
804
859
  Status?: DkimStatus | string;
805
860
  /**
861
+ * @public
806
862
  * <p>A set of unique strings that you use to create a set of CNAME records that you add to
807
863
  * the DNS configuration for your domain. When Amazon Pinpoint detects these records in the DNS
808
864
  * configuration for your domain, the DKIM authentication process is complete. Amazon Pinpoint
@@ -833,16 +889,19 @@ export type IdentityType = (typeof IdentityType)[keyof typeof IdentityType];
833
889
  */
834
890
  export interface CreateEmailIdentityResponse {
835
891
  /**
892
+ * @public
836
893
  * <p>The email identity type.</p>
837
894
  */
838
895
  IdentityType?: IdentityType | string;
839
896
  /**
897
+ * @public
840
898
  * <p>Specifies whether or not the identity is verified. In Amazon Pinpoint, you can only send email
841
899
  * from verified email addresses or domains. For more information about verifying
842
900
  * identities, see the <a href="https://docs.aws.amazon.com/pinpoint/latest/userguide/channels-email-manage-verify.html">Amazon Pinpoint User Guide</a>.</p>
843
901
  */
844
902
  VerifiedForSendingStatus?: boolean;
845
903
  /**
904
+ * @public
846
905
  * <p>An object that contains information about the DKIM attributes for the identity. This
847
906
  * object includes the tokens that you use to create the CNAME records that are required to
848
907
  * complete the DKIM verification process.</p>
@@ -855,6 +914,7 @@ export interface CreateEmailIdentityResponse {
855
914
  */
856
915
  export interface DeleteConfigurationSetRequest {
857
916
  /**
917
+ * @public
858
918
  * <p>The name of the configuration set that you want to delete.</p>
859
919
  */
860
920
  ConfigurationSetName: string | undefined;
@@ -872,11 +932,13 @@ export interface DeleteConfigurationSetResponse {
872
932
  */
873
933
  export interface DeleteConfigurationSetEventDestinationRequest {
874
934
  /**
935
+ * @public
875
936
  * <p>The name of the configuration set that contains the event destination that you want to
876
937
  * delete.</p>
877
938
  */
878
939
  ConfigurationSetName: string | undefined;
879
940
  /**
941
+ * @public
880
942
  * <p>The name of the event destination that you want to delete.</p>
881
943
  */
882
944
  EventDestinationName: string | undefined;
@@ -894,6 +956,7 @@ export interface DeleteConfigurationSetEventDestinationResponse {
894
956
  */
895
957
  export interface DeleteDedicatedIpPoolRequest {
896
958
  /**
959
+ * @public
897
960
  * <p>The name of the dedicated IP pool that you want to delete.</p>
898
961
  */
899
962
  PoolName: string | undefined;
@@ -913,6 +976,7 @@ export interface DeleteDedicatedIpPoolResponse {
913
976
  */
914
977
  export interface DeleteEmailIdentityRequest {
915
978
  /**
979
+ * @public
916
980
  * <p>The identity (that is, the email address or domain) that you want to delete from your
917
981
  * Amazon Pinpoint account.</p>
918
982
  */
@@ -939,18 +1003,21 @@ export interface GetAccountRequest {
939
1003
  */
940
1004
  export interface SendQuota {
941
1005
  /**
1006
+ * @public
942
1007
  * <p>The maximum number of emails that you can send in the current AWS Region over a
943
1008
  * 24-hour period. This value is also called your <i>sending
944
1009
  * quota</i>.</p>
945
1010
  */
946
1011
  Max24HourSend?: number;
947
1012
  /**
1013
+ * @public
948
1014
  * <p>The maximum number of emails that you can send per second in the current AWS Region.
949
1015
  * This value is also called your <i>maximum sending rate</i> or your
950
1016
  * <i>maximum TPS (transactions per second) rate</i>.</p>
951
1017
  */
952
1018
  MaxSendRate?: number;
953
1019
  /**
1020
+ * @public
954
1021
  * <p>The number of emails sent from your Amazon Pinpoint account in the current AWS Region over the
955
1022
  * past 24 hours.</p>
956
1023
  */
@@ -963,21 +1030,25 @@ export interface SendQuota {
963
1030
  */
964
1031
  export interface GetAccountResponse {
965
1032
  /**
1033
+ * @public
966
1034
  * <p>An object that contains information about the per-day and per-second sending limits
967
1035
  * for your Amazon Pinpoint account in the current AWS Region.</p>
968
1036
  */
969
1037
  SendQuota?: SendQuota;
970
1038
  /**
1039
+ * @public
971
1040
  * <p>Indicates whether or not email sending is enabled for your Amazon Pinpoint account in the
972
1041
  * current AWS Region.</p>
973
1042
  */
974
1043
  SendingEnabled?: boolean;
975
1044
  /**
1045
+ * @public
976
1046
  * <p>Indicates whether or not the automatic warm-up feature is enabled for dedicated IP
977
1047
  * addresses that are associated with your account.</p>
978
1048
  */
979
1049
  DedicatedIpAutoWarmupEnabled?: boolean;
980
1050
  /**
1051
+ * @public
981
1052
  * <p>The reputation status of your Amazon Pinpoint account. The status can be one of the
982
1053
  * following:</p>
983
1054
  * <ul>
@@ -1003,6 +1074,7 @@ export interface GetAccountResponse {
1003
1074
  */
1004
1075
  EnforcementStatus?: string;
1005
1076
  /**
1077
+ * @public
1006
1078
  * <p>Indicates whether or not your account has production access in the current AWS
1007
1079
  * Region.</p>
1008
1080
  * <p>If the value is <code>false</code>, then your account is in the
@@ -1023,6 +1095,7 @@ export interface GetAccountResponse {
1023
1095
  */
1024
1096
  export interface GetBlacklistReportsRequest {
1025
1097
  /**
1098
+ * @public
1026
1099
  * <p>A list of IP addresses that you want to retrieve blacklist information about. You can
1027
1100
  * only specify the dedicated IP addresses that you use to send email using Amazon Pinpoint or
1028
1101
  * Amazon SES.</p>
@@ -1036,14 +1109,17 @@ export interface GetBlacklistReportsRequest {
1036
1109
  */
1037
1110
  export interface BlacklistEntry {
1038
1111
  /**
1112
+ * @public
1039
1113
  * <p>The name of the blacklist that the IP address appears on.</p>
1040
1114
  */
1041
1115
  RblName?: string;
1042
1116
  /**
1117
+ * @public
1043
1118
  * <p>The time when the blacklisting event occurred, shown in Unix time format.</p>
1044
1119
  */
1045
1120
  ListingTime?: Date;
1046
1121
  /**
1122
+ * @public
1047
1123
  * <p>Additional information about the blacklisting event, as provided by the blacklist
1048
1124
  * maintainer.</p>
1049
1125
  */
@@ -1055,6 +1131,7 @@ export interface BlacklistEntry {
1055
1131
  */
1056
1132
  export interface GetBlacklistReportsResponse {
1057
1133
  /**
1134
+ * @public
1058
1135
  * <p>An object that contains information about a blacklist that one of your dedicated IP
1059
1136
  * addresses appears on.</p>
1060
1137
  */
@@ -1066,6 +1143,7 @@ export interface GetBlacklistReportsResponse {
1066
1143
  */
1067
1144
  export interface GetConfigurationSetRequest {
1068
1145
  /**
1146
+ * @public
1069
1147
  * <p>The name of the configuration set that you want to obtain more information
1070
1148
  * about.</p>
1071
1149
  */
@@ -1077,30 +1155,36 @@ export interface GetConfigurationSetRequest {
1077
1155
  */
1078
1156
  export interface GetConfigurationSetResponse {
1079
1157
  /**
1158
+ * @public
1080
1159
  * <p>The name of the configuration set.</p>
1081
1160
  */
1082
1161
  ConfigurationSetName?: string;
1083
1162
  /**
1163
+ * @public
1084
1164
  * <p>An object that defines the open and click tracking options for emails that you send
1085
1165
  * using the configuration set.</p>
1086
1166
  */
1087
1167
  TrackingOptions?: TrackingOptions;
1088
1168
  /**
1169
+ * @public
1089
1170
  * <p>An object that defines the dedicated IP pool that is used to send emails that you send
1090
1171
  * using the configuration set.</p>
1091
1172
  */
1092
1173
  DeliveryOptions?: DeliveryOptions;
1093
1174
  /**
1175
+ * @public
1094
1176
  * <p>An object that defines whether or not Amazon Pinpoint collects reputation metrics for the emails
1095
1177
  * that you send that use the configuration set.</p>
1096
1178
  */
1097
1179
  ReputationOptions?: ReputationOptions;
1098
1180
  /**
1181
+ * @public
1099
1182
  * <p>An object that defines whether or not Amazon Pinpoint can send email that you send using the
1100
1183
  * configuration set.</p>
1101
1184
  */
1102
1185
  SendingOptions?: SendingOptions;
1103
1186
  /**
1187
+ * @public
1104
1188
  * <p>An array of objects that define the tags (keys and values) that are associated with
1105
1189
  * the configuration set.</p>
1106
1190
  */
@@ -1113,6 +1197,7 @@ export interface GetConfigurationSetResponse {
1113
1197
  */
1114
1198
  export interface GetConfigurationSetEventDestinationsRequest {
1115
1199
  /**
1200
+ * @public
1116
1201
  * <p>The name of the configuration set that contains the event destination.</p>
1117
1202
  */
1118
1203
  ConfigurationSetName: string | undefined;
@@ -1127,10 +1212,12 @@ export interface GetConfigurationSetEventDestinationsRequest {
1127
1212
  */
1128
1213
  export interface EventDestination {
1129
1214
  /**
1215
+ * @public
1130
1216
  * <p>A name that identifies the event destination.</p>
1131
1217
  */
1132
1218
  Name: string | undefined;
1133
1219
  /**
1220
+ * @public
1134
1221
  * <p>If <code>true</code>, the event destination is enabled. When the event destination is
1135
1222
  * enabled, the specified event types are sent to the destinations in this
1136
1223
  * <code>EventDestinationDefinition</code>.</p>
@@ -1139,25 +1226,30 @@ export interface EventDestination {
1139
1226
  */
1140
1227
  Enabled?: boolean;
1141
1228
  /**
1229
+ * @public
1142
1230
  * <p>The types of events that Amazon Pinpoint sends to the specified event destinations.</p>
1143
1231
  */
1144
1232
  MatchingEventTypes: (EventType | string)[] | undefined;
1145
1233
  /**
1234
+ * @public
1146
1235
  * <p>An object that defines an Amazon Kinesis Data Firehose destination for email events. You can use Amazon Kinesis Data Firehose to
1147
1236
  * stream data to other services, such as Amazon S3 and Amazon Redshift.</p>
1148
1237
  */
1149
1238
  KinesisFirehoseDestination?: KinesisFirehoseDestination;
1150
1239
  /**
1240
+ * @public
1151
1241
  * <p>An object that defines an Amazon CloudWatch destination for email events. You can use Amazon CloudWatch to
1152
1242
  * monitor and gain insights on your email sending metrics.</p>
1153
1243
  */
1154
1244
  CloudWatchDestination?: CloudWatchDestination;
1155
1245
  /**
1246
+ * @public
1156
1247
  * <p>An object that defines an Amazon SNS destination for email events. You can use Amazon SNS to
1157
1248
  * send notification when certain email events occur.</p>
1158
1249
  */
1159
1250
  SnsDestination?: SnsDestination;
1160
1251
  /**
1252
+ * @public
1161
1253
  * <p>An object that defines a Amazon Pinpoint destination for email events. You can use Amazon Pinpoint events
1162
1254
  * to create attributes in Amazon Pinpoint projects. You can use these attributes to create segments
1163
1255
  * for your campaigns.</p>
@@ -1170,6 +1262,7 @@ export interface EventDestination {
1170
1262
  */
1171
1263
  export interface GetConfigurationSetEventDestinationsResponse {
1172
1264
  /**
1265
+ * @public
1173
1266
  * <p>An array that includes all of the events destinations that have been configured for
1174
1267
  * the configuration set.</p>
1175
1268
  */
@@ -1181,6 +1274,7 @@ export interface GetConfigurationSetEventDestinationsResponse {
1181
1274
  */
1182
1275
  export interface GetDedicatedIpRequest {
1183
1276
  /**
1277
+ * @public
1184
1278
  * <p>The IP address that you want to obtain more information about. The value you specify
1185
1279
  * has to be a dedicated IP address that's assocaited with your Amazon Pinpoint account.</p>
1186
1280
  */
@@ -1206,10 +1300,12 @@ export type WarmupStatus = (typeof WarmupStatus)[keyof typeof WarmupStatus];
1206
1300
  */
1207
1301
  export interface DedicatedIp {
1208
1302
  /**
1303
+ * @public
1209
1304
  * <p>An IP address that is reserved for use by your Amazon Pinpoint account.</p>
1210
1305
  */
1211
1306
  Ip: string | undefined;
1212
1307
  /**
1308
+ * @public
1213
1309
  * <p>The warm-up status of a dedicated IP address. The status can have one of the following
1214
1310
  * values:</p>
1215
1311
  * <ul>
@@ -1227,11 +1323,13 @@ export interface DedicatedIp {
1227
1323
  */
1228
1324
  WarmupStatus: WarmupStatus | string | undefined;
1229
1325
  /**
1326
+ * @public
1230
1327
  * <p>Indicates how complete the dedicated IP warm-up process is. When this value equals 1,
1231
1328
  * the address has completed the warm-up process and is ready for use.</p>
1232
1329
  */
1233
1330
  WarmupPercentage: number | undefined;
1234
1331
  /**
1332
+ * @public
1235
1333
  * <p>The name of the dedicated IP pool that the IP address is associated with.</p>
1236
1334
  */
1237
1335
  PoolName?: string;
@@ -1242,6 +1340,7 @@ export interface DedicatedIp {
1242
1340
  */
1243
1341
  export interface GetDedicatedIpResponse {
1244
1342
  /**
1343
+ * @public
1245
1344
  * <p>An object that contains information about a dedicated IP address.</p>
1246
1345
  */
1247
1346
  DedicatedIp?: DedicatedIp;
@@ -1252,15 +1351,18 @@ export interface GetDedicatedIpResponse {
1252
1351
  */
1253
1352
  export interface GetDedicatedIpsRequest {
1254
1353
  /**
1354
+ * @public
1255
1355
  * <p>The name of the IP pool that the dedicated IP address is associated with.</p>
1256
1356
  */
1257
1357
  PoolName?: string;
1258
1358
  /**
1359
+ * @public
1259
1360
  * <p>A token returned from a previous call to <code>GetDedicatedIps</code> to indicate the
1260
1361
  * position of the dedicated IP pool in the list of IP pools.</p>
1261
1362
  */
1262
1363
  NextToken?: string;
1263
1364
  /**
1365
+ * @public
1264
1366
  * <p>The number of results to show in a single call to <code>GetDedicatedIpsRequest</code>.
1265
1367
  * If the number of results is larger than the number you specified in this parameter, then
1266
1368
  * the response includes a <code>NextToken</code> element, which you can use to obtain
@@ -1275,11 +1377,13 @@ export interface GetDedicatedIpsRequest {
1275
1377
  */
1276
1378
  export interface GetDedicatedIpsResponse {
1277
1379
  /**
1380
+ * @public
1278
1381
  * <p>A list of dedicated IP addresses that are reserved for use by your Amazon Pinpoint
1279
1382
  * account.</p>
1280
1383
  */
1281
1384
  DedicatedIps?: DedicatedIp[];
1282
1385
  /**
1386
+ * @public
1283
1387
  * <p>A token that indicates that there are additional dedicated IP addresses to list. To
1284
1388
  * view additional addresses, issue another request to <code>GetDedicatedIps</code>,
1285
1389
  * passing this token in the <code>NextToken</code> parameter.</p>
@@ -1320,10 +1424,12 @@ export type DeliverabilityDashboardAccountStatus = (typeof DeliverabilityDashboa
1320
1424
  */
1321
1425
  export interface InboxPlacementTrackingOption {
1322
1426
  /**
1427
+ * @public
1323
1428
  * <p>Specifies whether inbox placement data is being tracked for the domain.</p>
1324
1429
  */
1325
1430
  Global?: boolean;
1326
1431
  /**
1432
+ * @public
1327
1433
  * <p>An array of strings, one for each major email provider that the inbox placement data
1328
1434
  * applies to.</p>
1329
1435
  */
@@ -1338,16 +1444,19 @@ export interface InboxPlacementTrackingOption {
1338
1444
  */
1339
1445
  export interface DomainDeliverabilityTrackingOption {
1340
1446
  /**
1447
+ * @public
1341
1448
  * <p>A verified domain that’s associated with your AWS account and currently has an
1342
1449
  * active Deliverability dashboard subscription.</p>
1343
1450
  */
1344
1451
  Domain?: string;
1345
1452
  /**
1453
+ * @public
1346
1454
  * <p>The date, in Unix time format, when you enabled the Deliverability dashboard for the
1347
1455
  * domain.</p>
1348
1456
  */
1349
1457
  SubscriptionStartDate?: Date;
1350
1458
  /**
1459
+ * @public
1351
1460
  * <p>An object that contains information about the inbox placement data settings for the
1352
1461
  * domain.</p>
1353
1462
  */
@@ -1359,11 +1468,13 @@ export interface DomainDeliverabilityTrackingOption {
1359
1468
  */
1360
1469
  export interface GetDeliverabilityDashboardOptionsResponse {
1361
1470
  /**
1471
+ * @public
1362
1472
  * <p>Specifies whether the Deliverability dashboard is enabled for your Amazon Pinpoint account. If this value
1363
1473
  * is <code>true</code>, the dashboard is enabled.</p>
1364
1474
  */
1365
1475
  DashboardEnabled: boolean | undefined;
1366
1476
  /**
1477
+ * @public
1367
1478
  * <p>The date, in Unix time format, when your current subscription to the Deliverability dashboard
1368
1479
  * is scheduled to expire, if your subscription is scheduled to expire at the end of the
1369
1480
  * current calendar month. This value is null if you have an active subscription that isn’t
@@ -1371,18 +1482,21 @@ export interface GetDeliverabilityDashboardOptionsResponse {
1371
1482
  */
1372
1483
  SubscriptionExpiryDate?: Date;
1373
1484
  /**
1485
+ * @public
1374
1486
  * <p>The current status of your Deliverability dashboard subscription. If this value is
1375
1487
  * <code>PENDING_EXPIRATION</code>, your subscription is scheduled to expire at the end
1376
1488
  * of the current calendar month.</p>
1377
1489
  */
1378
1490
  AccountStatus?: DeliverabilityDashboardAccountStatus | string;
1379
1491
  /**
1492
+ * @public
1380
1493
  * <p>An array of objects, one for each verified domain that you use to send email and
1381
1494
  * currently has an active Deliverability dashboard subscription that isn’t scheduled to expire at
1382
1495
  * the end of the current calendar month.</p>
1383
1496
  */
1384
1497
  ActiveSubscribedDomains?: DomainDeliverabilityTrackingOption[];
1385
1498
  /**
1499
+ * @public
1386
1500
  * <p>An array of objects, one for each verified domain that you use to send email and
1387
1501
  * currently has an active Deliverability dashboard subscription that's scheduled to expire at the
1388
1502
  * end of the current calendar month.</p>
@@ -1395,6 +1509,7 @@ export interface GetDeliverabilityDashboardOptionsResponse {
1395
1509
  */
1396
1510
  export interface GetDeliverabilityTestReportRequest {
1397
1511
  /**
1512
+ * @public
1398
1513
  * <p>A unique string that identifies the predictive inbox placement test.</p>
1399
1514
  */
1400
1515
  ReportId: string | undefined;
@@ -1405,26 +1520,32 @@ export interface GetDeliverabilityTestReportRequest {
1405
1520
  */
1406
1521
  export interface DeliverabilityTestReport {
1407
1522
  /**
1523
+ * @public
1408
1524
  * <p>A unique string that identifies the predictive inbox placement test.</p>
1409
1525
  */
1410
1526
  ReportId?: string;
1411
1527
  /**
1528
+ * @public
1412
1529
  * <p>A name that helps you identify a predictive inbox placement test report.</p>
1413
1530
  */
1414
1531
  ReportName?: string;
1415
1532
  /**
1533
+ * @public
1416
1534
  * <p>The subject line for an email that you submitted in a predictive inbox placement test.</p>
1417
1535
  */
1418
1536
  Subject?: string;
1419
1537
  /**
1538
+ * @public
1420
1539
  * <p>The sender address that you specified for the predictive inbox placement test.</p>
1421
1540
  */
1422
1541
  FromEmailAddress?: string;
1423
1542
  /**
1543
+ * @public
1424
1544
  * <p>The date and time when the predictive inbox placement test was created, in Unix time format.</p>
1425
1545
  */
1426
1546
  CreateDate?: Date;
1427
1547
  /**
1548
+ * @public
1428
1549
  * <p>The status of the predictive inbox placement test. If the status is <code>IN_PROGRESS</code>, then the predictive inbox placement test
1429
1550
  * is currently running. Predictive inbox placement tests are usually complete within 24 hours of creating the
1430
1551
  * test. If the status is <code>COMPLETE</code>, then the test is finished, and you can use
@@ -1438,25 +1559,30 @@ export interface DeliverabilityTestReport {
1438
1559
  */
1439
1560
  export interface PlacementStatistics {
1440
1561
  /**
1562
+ * @public
1441
1563
  * <p>The percentage of emails that arrived in recipients' inboxes during the predictive inbox placement test.</p>
1442
1564
  */
1443
1565
  InboxPercentage?: number;
1444
1566
  /**
1567
+ * @public
1445
1568
  * <p>The percentage of emails that arrived in recipients' spam or junk mail folders during
1446
1569
  * the predictive inbox placement test.</p>
1447
1570
  */
1448
1571
  SpamPercentage?: number;
1449
1572
  /**
1573
+ * @public
1450
1574
  * <p>The percentage of emails that didn't arrive in recipients' inboxes at all during the
1451
1575
  * predictive inbox placement test.</p>
1452
1576
  */
1453
1577
  MissingPercentage?: number;
1454
1578
  /**
1579
+ * @public
1455
1580
  * <p>The percentage of emails that were authenticated by using Sender Policy Framework
1456
1581
  * (SPF) during the predictive inbox placement test.</p>
1457
1582
  */
1458
1583
  SpfPercentage?: number;
1459
1584
  /**
1585
+ * @public
1460
1586
  * <p>The percentage of emails that were authenticated by using DomainKeys Identified Mail
1461
1587
  * (DKIM) during the predictive inbox placement test.</p>
1462
1588
  */
@@ -1469,10 +1595,12 @@ export interface PlacementStatistics {
1469
1595
  */
1470
1596
  export interface IspPlacement {
1471
1597
  /**
1598
+ * @public
1472
1599
  * <p>The name of the email provider that the inbox placement data applies to.</p>
1473
1600
  */
1474
1601
  IspName?: string;
1475
1602
  /**
1603
+ * @public
1476
1604
  * <p>An object that contains inbox placement metrics for a specific email provider.</p>
1477
1605
  */
1478
1606
  PlacementStatistics?: PlacementStatistics;
@@ -1483,26 +1611,31 @@ export interface IspPlacement {
1483
1611
  */
1484
1612
  export interface GetDeliverabilityTestReportResponse {
1485
1613
  /**
1614
+ * @public
1486
1615
  * <p>An object that contains the results of the predictive inbox placement test.</p>
1487
1616
  */
1488
1617
  DeliverabilityTestReport: DeliverabilityTestReport | undefined;
1489
1618
  /**
1619
+ * @public
1490
1620
  * <p>An object that specifies how many test messages that were sent during the predictive inbox placement test were
1491
1621
  * delivered to recipients' inboxes, how many were sent to recipients' spam folders, and
1492
1622
  * how many weren't delivered.</p>
1493
1623
  */
1494
1624
  OverallPlacement: PlacementStatistics | undefined;
1495
1625
  /**
1626
+ * @public
1496
1627
  * <p>An object that describes how the test email was handled by several email providers,
1497
1628
  * including Gmail, Hotmail, Yahoo, AOL, and others.</p>
1498
1629
  */
1499
1630
  IspPlacements: IspPlacement[] | undefined;
1500
1631
  /**
1632
+ * @public
1501
1633
  * <p>An object that contains the message that you sent when you performed this
1502
1634
  * predictive inbox placement test.</p>
1503
1635
  */
1504
1636
  Message?: string;
1505
1637
  /**
1638
+ * @public
1506
1639
  * <p>An array of objects that define the tags (keys and values) that are associated with
1507
1640
  * the predictive inbox placement test.</p>
1508
1641
  */
@@ -1517,6 +1650,7 @@ export interface GetDeliverabilityTestReportResponse {
1517
1650
  */
1518
1651
  export interface GetDomainDeliverabilityCampaignRequest {
1519
1652
  /**
1653
+ * @public
1520
1654
  * <p>The unique identifier for the campaign. Amazon Pinpoint automatically generates and assigns this
1521
1655
  * identifier to a campaign. This value is not the same as the campaign identifier that
1522
1656
  * Amazon Pinpoint assigns to campaigns that you create and manage by using the Amazon Pinpoint API or the
@@ -1533,6 +1667,7 @@ export interface GetDomainDeliverabilityCampaignRequest {
1533
1667
  */
1534
1668
  export interface DomainDeliverabilityCampaign {
1535
1669
  /**
1670
+ * @public
1536
1671
  * <p>The unique identifier for the campaign. Amazon Pinpoint automatically generates and assigns this
1537
1672
  * identifier to a campaign. This value is not the same as the campaign identifier that
1538
1673
  * Amazon Pinpoint assigns to campaigns that you create and manage by using the Amazon Pinpoint API or the
@@ -1540,66 +1675,79 @@ export interface DomainDeliverabilityCampaign {
1540
1675
  */
1541
1676
  CampaignId?: string;
1542
1677
  /**
1678
+ * @public
1543
1679
  * <p>The URL of an image that contains a snapshot of the email message that was
1544
1680
  * sent.</p>
1545
1681
  */
1546
1682
  ImageUrl?: string;
1547
1683
  /**
1684
+ * @public
1548
1685
  * <p>The subject line, or title, of the email message.</p>
1549
1686
  */
1550
1687
  Subject?: string;
1551
1688
  /**
1689
+ * @public
1552
1690
  * <p>The verified email address that the email message was sent from.</p>
1553
1691
  */
1554
1692
  FromAddress?: string;
1555
1693
  /**
1694
+ * @public
1556
1695
  * <p>The IP addresses that were used to send the email message.</p>
1557
1696
  */
1558
1697
  SendingIps?: string[];
1559
1698
  /**
1699
+ * @public
1560
1700
  * <p>The first time, in Unix time format, when the email message was delivered to any
1561
1701
  * recipient's inbox. This value can help you determine how long it took for a campaign to
1562
1702
  * deliver an email message.</p>
1563
1703
  */
1564
1704
  FirstSeenDateTime?: Date;
1565
1705
  /**
1706
+ * @public
1566
1707
  * <p>The last time, in Unix time format, when the email message was delivered to any
1567
1708
  * recipient's inbox. This value can help you determine how long it took for a campaign to
1568
1709
  * deliver an email message.</p>
1569
1710
  */
1570
1711
  LastSeenDateTime?: Date;
1571
1712
  /**
1713
+ * @public
1572
1714
  * <p>The number of email messages that were delivered to recipients’ inboxes.</p>
1573
1715
  */
1574
1716
  InboxCount?: number;
1575
1717
  /**
1718
+ * @public
1576
1719
  * <p>The number of email messages that were delivered to recipients' spam or junk mail
1577
1720
  * folders.</p>
1578
1721
  */
1579
1722
  SpamCount?: number;
1580
1723
  /**
1724
+ * @public
1581
1725
  * <p>The percentage of email messages that were opened by recipients. Due to technical
1582
1726
  * limitations, this value only includes recipients who opened the message by using an
1583
1727
  * email client that supports images.</p>
1584
1728
  */
1585
1729
  ReadRate?: number;
1586
1730
  /**
1731
+ * @public
1587
1732
  * <p>The percentage of email messages that were deleted by recipients, without being opened
1588
1733
  * first. Due to technical limitations, this value only includes recipients who opened the
1589
1734
  * message by using an email client that supports images.</p>
1590
1735
  */
1591
1736
  DeleteRate?: number;
1592
1737
  /**
1738
+ * @public
1593
1739
  * <p>The percentage of email messages that were opened and then deleted by recipients. Due
1594
1740
  * to technical limitations, this value only includes recipients who opened the message by
1595
1741
  * using an email client that supports images.</p>
1596
1742
  */
1597
1743
  ReadDeleteRate?: number;
1598
1744
  /**
1745
+ * @public
1599
1746
  * <p>The projected number of recipients that the email message was sent to.</p>
1600
1747
  */
1601
1748
  ProjectedVolume?: number;
1602
1749
  /**
1750
+ * @public
1603
1751
  * <p>The major email providers who handled the email message.</p>
1604
1752
  */
1605
1753
  Esps?: string[];
@@ -1613,6 +1761,7 @@ export interface DomainDeliverabilityCampaign {
1613
1761
  */
1614
1762
  export interface GetDomainDeliverabilityCampaignResponse {
1615
1763
  /**
1764
+ * @public
1616
1765
  * <p>An object that contains the deliverability data for the campaign.</p>
1617
1766
  */
1618
1767
  DomainDeliverabilityCampaign: DomainDeliverabilityCampaign | undefined;
@@ -1623,15 +1772,18 @@ export interface GetDomainDeliverabilityCampaignResponse {
1623
1772
  */
1624
1773
  export interface GetDomainStatisticsReportRequest {
1625
1774
  /**
1775
+ * @public
1626
1776
  * <p>The domain that you want to obtain deliverability metrics for.</p>
1627
1777
  */
1628
1778
  Domain: string | undefined;
1629
1779
  /**
1780
+ * @public
1630
1781
  * <p>The first day (in Unix time) that you want to obtain domain deliverability metrics
1631
1782
  * for.</p>
1632
1783
  */
1633
1784
  StartDate: Date | undefined;
1634
1785
  /**
1786
+ * @public
1635
1787
  * <p>The last day (in Unix time) that you want to obtain domain deliverability metrics for.
1636
1788
  * The <code>EndDate</code> that you specify has to be less than or equal to 30 days after
1637
1789
  * the <code>StartDate</code>.</p>
@@ -1645,25 +1797,30 @@ export interface GetDomainStatisticsReportRequest {
1645
1797
  */
1646
1798
  export interface DomainIspPlacement {
1647
1799
  /**
1800
+ * @public
1648
1801
  * <p>The name of the email provider that the inbox placement data applies to.</p>
1649
1802
  */
1650
1803
  IspName?: string;
1651
1804
  /**
1805
+ * @public
1652
1806
  * <p>The total number of messages that were sent from the selected domain to the specified
1653
1807
  * email provider that arrived in recipients' inboxes.</p>
1654
1808
  */
1655
1809
  InboxRawCount?: number;
1656
1810
  /**
1811
+ * @public
1657
1812
  * <p>The total number of messages that were sent from the selected domain to the specified
1658
1813
  * email provider that arrived in recipients' spam or junk mail folders.</p>
1659
1814
  */
1660
1815
  SpamRawCount?: number;
1661
1816
  /**
1817
+ * @public
1662
1818
  * <p>The percentage of messages that were sent from the selected domain to the specified
1663
1819
  * email provider that arrived in recipients' inboxes.</p>
1664
1820
  */
1665
1821
  InboxPercentage?: number;
1666
1822
  /**
1823
+ * @public
1667
1824
  * <p>The percentage of messages that were sent from the selected domain to the specified
1668
1825
  * email provider that arrived in recipients' spam or junk mail folders.</p>
1669
1826
  */
@@ -1676,20 +1833,24 @@ export interface DomainIspPlacement {
1676
1833
  */
1677
1834
  export interface VolumeStatistics {
1678
1835
  /**
1836
+ * @public
1679
1837
  * <p>The total number of emails that arrived in recipients' inboxes.</p>
1680
1838
  */
1681
1839
  InboxRawCount?: number;
1682
1840
  /**
1841
+ * @public
1683
1842
  * <p>The total number of emails that arrived in recipients' spam or junk mail
1684
1843
  * folders.</p>
1685
1844
  */
1686
1845
  SpamRawCount?: number;
1687
1846
  /**
1847
+ * @public
1688
1848
  * <p>An estimate of the percentage of emails sent from the current domain that will arrive
1689
1849
  * in recipients' inboxes.</p>
1690
1850
  */
1691
1851
  ProjectedInbox?: number;
1692
1852
  /**
1853
+ * @public
1693
1854
  * <p>An estimate of the percentage of emails sent from the current domain that will arrive
1694
1855
  * in recipients' spam or junk mail folders.</p>
1695
1856
  */
@@ -1702,15 +1863,18 @@ export interface VolumeStatistics {
1702
1863
  */
1703
1864
  export interface DailyVolume {
1704
1865
  /**
1866
+ * @public
1705
1867
  * <p>The date that the DailyVolume metrics apply to, in Unix time.</p>
1706
1868
  */
1707
1869
  StartDate?: Date;
1708
1870
  /**
1871
+ * @public
1709
1872
  * <p>An object that contains inbox placement metrics for a specific day in the analysis
1710
1873
  * period.</p>
1711
1874
  */
1712
1875
  VolumeStatistics?: VolumeStatistics;
1713
1876
  /**
1877
+ * @public
1714
1878
  * <p>An object that contains inbox placement metrics for a specified day in the analysis
1715
1879
  * period, broken out by the recipient's email provider.</p>
1716
1880
  */
@@ -1723,16 +1887,19 @@ export interface DailyVolume {
1723
1887
  */
1724
1888
  export interface OverallVolume {
1725
1889
  /**
1890
+ * @public
1726
1891
  * <p>An object that contains information about the numbers of messages that arrived in
1727
1892
  * recipients' inboxes and junk mail folders.</p>
1728
1893
  */
1729
1894
  VolumeStatistics?: VolumeStatistics;
1730
1895
  /**
1896
+ * @public
1731
1897
  * <p>The percentage of emails that were sent from the domain that were read by their
1732
1898
  * recipients.</p>
1733
1899
  */
1734
1900
  ReadRatePercent?: number;
1735
1901
  /**
1902
+ * @public
1736
1903
  * <p>An object that contains inbox and junk mail placement metrics for individual email
1737
1904
  * providers.</p>
1738
1905
  */
@@ -1745,12 +1912,14 @@ export interface OverallVolume {
1745
1912
  */
1746
1913
  export interface GetDomainStatisticsReportResponse {
1747
1914
  /**
1915
+ * @public
1748
1916
  * <p>An object that contains deliverability metrics for the domain that you specified. The
1749
1917
  * data in this object is a summary of all of the data that was collected from the
1750
1918
  * <code>StartDate</code> to the <code>EndDate</code>.</p>
1751
1919
  */
1752
1920
  OverallVolume: OverallVolume | undefined;
1753
1921
  /**
1922
+ * @public
1754
1923
  * <p>An object that contains deliverability metrics for the domain that you specified. This
1755
1924
  * object contains data for each day, starting on the <code>StartDate</code> and ending on
1756
1925
  * the <code>EndDate</code>.</p>
@@ -1763,6 +1932,7 @@ export interface GetDomainStatisticsReportResponse {
1763
1932
  */
1764
1933
  export interface GetEmailIdentityRequest {
1765
1934
  /**
1935
+ * @public
1766
1936
  * <p>The email identity that you want to retrieve details for.</p>
1767
1937
  */
1768
1938
  EmailIdentity: string | undefined;
@@ -1799,10 +1969,12 @@ export type MailFromDomainStatus = (typeof MailFromDomainStatus)[keyof typeof Ma
1799
1969
  */
1800
1970
  export interface MailFromAttributes {
1801
1971
  /**
1972
+ * @public
1802
1973
  * <p>The name of a domain that an email identity uses as a custom MAIL FROM domain.</p>
1803
1974
  */
1804
1975
  MailFromDomain: string | undefined;
1805
1976
  /**
1977
+ * @public
1806
1978
  * <p>The status of the MAIL FROM domain. This status can have the following values:</p>
1807
1979
  * <ul>
1808
1980
  * <li>
@@ -1829,6 +2001,7 @@ export interface MailFromAttributes {
1829
2001
  */
1830
2002
  MailFromDomainStatus: MailFromDomainStatus | string | undefined;
1831
2003
  /**
2004
+ * @public
1832
2005
  * <p>The action that Amazon Pinpoint to takes if it can't read the required MX record for a custom
1833
2006
  * MAIL FROM domain. When you set this value to <code>UseDefaultValue</code>, Amazon Pinpoint uses
1834
2007
  * <i>amazonses.com</i> as the MAIL FROM domain. When you set this value
@@ -1846,10 +2019,12 @@ export interface MailFromAttributes {
1846
2019
  */
1847
2020
  export interface GetEmailIdentityResponse {
1848
2021
  /**
2022
+ * @public
1849
2023
  * <p>The email identity type.</p>
1850
2024
  */
1851
2025
  IdentityType?: IdentityType | string;
1852
2026
  /**
2027
+ * @public
1853
2028
  * <p>The feedback forwarding configuration for the identity.</p>
1854
2029
  * <p>If the value is <code>true</code>, Amazon Pinpoint sends you email notifications when bounce or
1855
2030
  * complaint events occur. Amazon Pinpoint sends this notification to the address that you specified
@@ -1862,23 +2037,27 @@ export interface GetEmailIdentityResponse {
1862
2037
  */
1863
2038
  FeedbackForwardingStatus?: boolean;
1864
2039
  /**
2040
+ * @public
1865
2041
  * <p>Specifies whether or not the identity is verified. In Amazon Pinpoint, you can only send email
1866
2042
  * from verified email addresses or domains. For more information about verifying
1867
2043
  * identities, see the <a href="https://docs.aws.amazon.com/pinpoint/latest/userguide/channels-email-manage-verify.html">Amazon Pinpoint User Guide</a>.</p>
1868
2044
  */
1869
2045
  VerifiedForSendingStatus?: boolean;
1870
2046
  /**
2047
+ * @public
1871
2048
  * <p>An object that contains information about the DKIM attributes for the identity. This
1872
2049
  * object includes the tokens that you use to create the CNAME records that are required to
1873
2050
  * complete the DKIM verification process.</p>
1874
2051
  */
1875
2052
  DkimAttributes?: DkimAttributes;
1876
2053
  /**
2054
+ * @public
1877
2055
  * <p>An object that contains information about the Mail-From attributes for the email
1878
2056
  * identity.</p>
1879
2057
  */
1880
2058
  MailFromAttributes?: MailFromAttributes;
1881
2059
  /**
2060
+ * @public
1882
2061
  * <p>An array of objects that define the tags (keys and values) that are associated with
1883
2062
  * the email identity.</p>
1884
2063
  */
@@ -1891,11 +2070,13 @@ export interface GetEmailIdentityResponse {
1891
2070
  */
1892
2071
  export interface ListConfigurationSetsRequest {
1893
2072
  /**
2073
+ * @public
1894
2074
  * <p>A token returned from a previous call to <code>ListConfigurationSets</code> to
1895
2075
  * indicate the position in the list of configuration sets.</p>
1896
2076
  */
1897
2077
  NextToken?: string;
1898
2078
  /**
2079
+ * @public
1899
2080
  * <p>The number of results to show in a single call to <code>ListConfigurationSets</code>.
1900
2081
  * If the number of results is larger than the number you specified in this parameter, then
1901
2082
  * the response includes a <code>NextToken</code> element, which you can use to obtain
@@ -1909,11 +2090,13 @@ export interface ListConfigurationSetsRequest {
1909
2090
  */
1910
2091
  export interface ListConfigurationSetsResponse {
1911
2092
  /**
2093
+ * @public
1912
2094
  * <p>An array that contains all of the configuration sets in your Amazon Pinpoint account in the
1913
2095
  * current AWS Region.</p>
1914
2096
  */
1915
2097
  ConfigurationSets?: string[];
1916
2098
  /**
2099
+ * @public
1917
2100
  * <p>A token that indicates that there are additional configuration sets to list. To view
1918
2101
  * additional configuration sets, issue another request to
1919
2102
  * <code>ListConfigurationSets</code>, and pass this token in the
@@ -1927,11 +2110,13 @@ export interface ListConfigurationSetsResponse {
1927
2110
  */
1928
2111
  export interface ListDedicatedIpPoolsRequest {
1929
2112
  /**
2113
+ * @public
1930
2114
  * <p>A token returned from a previous call to <code>ListDedicatedIpPools</code> to indicate
1931
2115
  * the position in the list of dedicated IP pools.</p>
1932
2116
  */
1933
2117
  NextToken?: string;
1934
2118
  /**
2119
+ * @public
1935
2120
  * <p>The number of results to show in a single call to <code>ListDedicatedIpPools</code>.
1936
2121
  * If the number of results is larger than the number you specified in this parameter, then
1937
2122
  * the response includes a <code>NextToken</code> element, which you can use to obtain
@@ -1945,11 +2130,13 @@ export interface ListDedicatedIpPoolsRequest {
1945
2130
  */
1946
2131
  export interface ListDedicatedIpPoolsResponse {
1947
2132
  /**
2133
+ * @public
1948
2134
  * <p>A list of all of the dedicated IP pools that are associated with your Amazon Pinpoint
1949
2135
  * account.</p>
1950
2136
  */
1951
2137
  DedicatedIpPools?: string[];
1952
2138
  /**
2139
+ * @public
1953
2140
  * <p>A token that indicates that there are additional IP pools to list. To view additional
1954
2141
  * IP pools, issue another request to <code>ListDedicatedIpPools</code>, passing this token
1955
2142
  * in the <code>NextToken</code> parameter.</p>
@@ -1962,11 +2149,13 @@ export interface ListDedicatedIpPoolsResponse {
1962
2149
  */
1963
2150
  export interface ListDeliverabilityTestReportsRequest {
1964
2151
  /**
2152
+ * @public
1965
2153
  * <p>A token returned from a previous call to <code>ListDeliverabilityTestReports</code> to
1966
2154
  * indicate the position in the list of predictive inbox placement tests.</p>
1967
2155
  */
1968
2156
  NextToken?: string;
1969
2157
  /**
2158
+ * @public
1970
2159
  * <p>The number of results to show in a single call to
1971
2160
  * <code>ListDeliverabilityTestReports</code>. If the number of results is larger than
1972
2161
  * the number you specified in this parameter, then the response includes a
@@ -1983,10 +2172,12 @@ export interface ListDeliverabilityTestReportsRequest {
1983
2172
  */
1984
2173
  export interface ListDeliverabilityTestReportsResponse {
1985
2174
  /**
2175
+ * @public
1986
2176
  * <p>An object that contains a lists of predictive inbox placement tests that you've performed.</p>
1987
2177
  */
1988
2178
  DeliverabilityTestReports: DeliverabilityTestReport[] | undefined;
1989
2179
  /**
2180
+ * @public
1990
2181
  * <p>A token that indicates that there are additional predictive inbox placement tests to list. To view additional
1991
2182
  * predictive inbox placement tests, issue another request to <code>ListDeliverabilityTestReports</code>, and pass
1992
2183
  * this token in the <code>NextToken</code> parameter.</p>
@@ -2002,27 +2193,32 @@ export interface ListDeliverabilityTestReportsResponse {
2002
2193
  */
2003
2194
  export interface ListDomainDeliverabilityCampaignsRequest {
2004
2195
  /**
2196
+ * @public
2005
2197
  * <p>The first day, in Unix time format, that you want to obtain deliverability data
2006
2198
  * for.</p>
2007
2199
  */
2008
2200
  StartDate: Date | undefined;
2009
2201
  /**
2202
+ * @public
2010
2203
  * <p>The last day, in Unix time format, that you want to obtain deliverability data for.
2011
2204
  * This value has to be less than or equal to 30 days after the value of the
2012
2205
  * <code>StartDate</code> parameter.</p>
2013
2206
  */
2014
2207
  EndDate: Date | undefined;
2015
2208
  /**
2209
+ * @public
2016
2210
  * <p>The domain to obtain deliverability data for.</p>
2017
2211
  */
2018
2212
  SubscribedDomain: string | undefined;
2019
2213
  /**
2214
+ * @public
2020
2215
  * <p>A token that’s returned from a previous call to the
2021
2216
  * <code>ListDomainDeliverabilityCampaigns</code> operation. This token indicates the
2022
2217
  * position of a campaign in the list of campaigns.</p>
2023
2218
  */
2024
2219
  NextToken?: string;
2025
2220
  /**
2221
+ * @public
2026
2222
  * <p>The maximum number of results to include in response to a single call to the
2027
2223
  * <code>ListDomainDeliverabilityCampaigns</code> operation. If the number of results
2028
2224
  * is larger than the number that you specify in this parameter, the response includes a
@@ -2040,11 +2236,13 @@ export interface ListDomainDeliverabilityCampaignsRequest {
2040
2236
  */
2041
2237
  export interface ListDomainDeliverabilityCampaignsResponse {
2042
2238
  /**
2239
+ * @public
2043
2240
  * <p>An array of responses, one for each campaign that used the domain to send email during
2044
2241
  * the specified time range.</p>
2045
2242
  */
2046
2243
  DomainDeliverabilityCampaigns: DomainDeliverabilityCampaign[] | undefined;
2047
2244
  /**
2245
+ * @public
2048
2246
  * <p>A token that’s returned from a previous call to the
2049
2247
  * <code>ListDomainDeliverabilityCampaigns</code> operation. This token indicates the
2050
2248
  * position of the campaign in the list of campaigns.</p>
@@ -2059,11 +2257,13 @@ export interface ListDomainDeliverabilityCampaignsResponse {
2059
2257
  */
2060
2258
  export interface ListEmailIdentitiesRequest {
2061
2259
  /**
2260
+ * @public
2062
2261
  * <p>A token returned from a previous call to <code>ListEmailIdentities</code> to indicate
2063
2262
  * the position in the list of identities.</p>
2064
2263
  */
2065
2264
  NextToken?: string;
2066
2265
  /**
2266
+ * @public
2067
2267
  * <p>The number of results to show in a single call to <code>ListEmailIdentities</code>. If
2068
2268
  * the number of results is larger than the number you specified in this parameter, then
2069
2269
  * the response includes a <code>NextToken</code> element, which you can use to obtain
@@ -2078,6 +2278,7 @@ export interface ListEmailIdentitiesRequest {
2078
2278
  */
2079
2279
  export interface IdentityInfo {
2080
2280
  /**
2281
+ * @public
2081
2282
  * <p>The email identity type. The identity type can be one of the following:</p>
2082
2283
  * <ul>
2083
2284
  * <li>
@@ -2097,10 +2298,12 @@ export interface IdentityInfo {
2097
2298
  */
2098
2299
  IdentityType?: IdentityType | string;
2099
2300
  /**
2301
+ * @public
2100
2302
  * <p>The address or domain of the identity.</p>
2101
2303
  */
2102
2304
  IdentityName?: string;
2103
2305
  /**
2306
+ * @public
2104
2307
  * <p>Indicates whether or not you can send email from the identity.</p>
2105
2308
  * <p>In Amazon Pinpoint, an identity is an email address or domain that you send email from. Before
2106
2309
  * you can send email from an identity, you have to demostrate that you own the identity,
@@ -2115,11 +2318,13 @@ export interface IdentityInfo {
2115
2318
  */
2116
2319
  export interface ListEmailIdentitiesResponse {
2117
2320
  /**
2321
+ * @public
2118
2322
  * <p>An array that includes all of the identities associated with your Amazon Pinpoint
2119
2323
  * account.</p>
2120
2324
  */
2121
2325
  EmailIdentities?: IdentityInfo[];
2122
2326
  /**
2327
+ * @public
2123
2328
  * <p>A token that indicates that there are additional configuration sets to list. To view
2124
2329
  * additional configuration sets, issue another request to
2125
2330
  * <code>ListEmailIdentities</code>, and pass this token in the <code>NextToken</code>
@@ -2132,6 +2337,7 @@ export interface ListEmailIdentitiesResponse {
2132
2337
  */
2133
2338
  export interface ListTagsForResourceRequest {
2134
2339
  /**
2340
+ * @public
2135
2341
  * <p>The Amazon Resource Name (ARN) of the resource that you want to retrieve tag
2136
2342
  * information for.</p>
2137
2343
  */
@@ -2142,6 +2348,7 @@ export interface ListTagsForResourceRequest {
2142
2348
  */
2143
2349
  export interface ListTagsForResourceResponse {
2144
2350
  /**
2351
+ * @public
2145
2352
  * <p>An array that lists all the tags that are associated with the resource. Each tag
2146
2353
  * consists of a required tag key (<code>Key</code>) and an associated tag value
2147
2354
  * (<code>Value</code>)</p>
@@ -2154,6 +2361,7 @@ export interface ListTagsForResourceResponse {
2154
2361
  */
2155
2362
  export interface PutAccountDedicatedIpWarmupAttributesRequest {
2156
2363
  /**
2364
+ * @public
2157
2365
  * <p>Enables or disables the automatic warm-up feature for dedicated IP addresses that are
2158
2366
  * associated with your Amazon Pinpoint account in the current AWS Region. Set to <code>true</code>
2159
2367
  * to enable the automatic warm-up feature, or set to <code>false</code> to disable
@@ -2174,6 +2382,7 @@ export interface PutAccountDedicatedIpWarmupAttributesResponse {
2174
2382
  */
2175
2383
  export interface PutAccountSendingAttributesRequest {
2176
2384
  /**
2385
+ * @public
2177
2386
  * <p>Enables or disables your account's ability to send email. Set to <code>true</code> to
2178
2387
  * enable email sending, or set to <code>false</code> to disable email sending.</p>
2179
2388
  * <note>
@@ -2196,11 +2405,13 @@ export interface PutAccountSendingAttributesResponse {
2196
2405
  */
2197
2406
  export interface PutConfigurationSetDeliveryOptionsRequest {
2198
2407
  /**
2408
+ * @public
2199
2409
  * <p>The name of the configuration set that you want to associate with a dedicated IP
2200
2410
  * pool.</p>
2201
2411
  */
2202
2412
  ConfigurationSetName: string | undefined;
2203
2413
  /**
2414
+ * @public
2204
2415
  * <p>Specifies whether messages that use the configuration set are required to use
2205
2416
  * Transport Layer Security (TLS). If the value is <code>Require</code>, messages are only
2206
2417
  * delivered if a TLS connection can be established. If the value is <code>Optional</code>,
@@ -2208,6 +2419,7 @@ export interface PutConfigurationSetDeliveryOptionsRequest {
2208
2419
  */
2209
2420
  TlsPolicy?: TlsPolicy | string;
2210
2421
  /**
2422
+ * @public
2211
2423
  * <p>The name of the dedicated IP pool that you want to associate with the configuration
2212
2424
  * set.</p>
2213
2425
  */
@@ -2227,11 +2439,13 @@ export interface PutConfigurationSetDeliveryOptionsResponse {
2227
2439
  */
2228
2440
  export interface PutConfigurationSetReputationOptionsRequest {
2229
2441
  /**
2442
+ * @public
2230
2443
  * <p>The name of the configuration set that you want to enable or disable reputation metric
2231
2444
  * tracking for.</p>
2232
2445
  */
2233
2446
  ConfigurationSetName: string | undefined;
2234
2447
  /**
2448
+ * @public
2235
2449
  * <p>If <code>true</code>, tracking of reputation metrics is enabled for the configuration
2236
2450
  * set. If <code>false</code>, tracking of reputation metrics is disabled for the
2237
2451
  * configuration set.</p>
@@ -2252,11 +2466,13 @@ export interface PutConfigurationSetReputationOptionsResponse {
2252
2466
  */
2253
2467
  export interface PutConfigurationSetSendingOptionsRequest {
2254
2468
  /**
2469
+ * @public
2255
2470
  * <p>The name of the configuration set that you want to enable or disable email sending
2256
2471
  * for.</p>
2257
2472
  */
2258
2473
  ConfigurationSetName: string | undefined;
2259
2474
  /**
2475
+ * @public
2260
2476
  * <p>If <code>true</code>, email sending is enabled for the configuration set. If
2261
2477
  * <code>false</code>, email sending is disabled for the configuration set.</p>
2262
2478
  */
@@ -2276,11 +2492,13 @@ export interface PutConfigurationSetSendingOptionsResponse {
2276
2492
  */
2277
2493
  export interface PutConfigurationSetTrackingOptionsRequest {
2278
2494
  /**
2495
+ * @public
2279
2496
  * <p>The name of the configuration set that you want to add a custom tracking domain
2280
2497
  * to.</p>
2281
2498
  */
2282
2499
  ConfigurationSetName: string | undefined;
2283
2500
  /**
2501
+ * @public
2284
2502
  * <p>The domain that you want to use to track open and click events.</p>
2285
2503
  */
2286
2504
  CustomRedirectDomain?: string;
@@ -2298,11 +2516,13 @@ export interface PutConfigurationSetTrackingOptionsResponse {
2298
2516
  */
2299
2517
  export interface PutDedicatedIpInPoolRequest {
2300
2518
  /**
2519
+ * @public
2301
2520
  * <p>The IP address that you want to move to the dedicated IP pool. The value you specify
2302
2521
  * has to be a dedicated IP address that's associated with your Amazon Pinpoint account.</p>
2303
2522
  */
2304
2523
  Ip: string | undefined;
2305
2524
  /**
2525
+ * @public
2306
2526
  * <p>The name of the IP pool that you want to add the dedicated IP address to. You have to
2307
2527
  * specify an IP pool that already exists.</p>
2308
2528
  */
@@ -2322,10 +2542,12 @@ export interface PutDedicatedIpInPoolResponse {
2322
2542
  */
2323
2543
  export interface PutDedicatedIpWarmupAttributesRequest {
2324
2544
  /**
2545
+ * @public
2325
2546
  * <p>The dedicated IP address that you want to update the warm-up attributes for.</p>
2326
2547
  */
2327
2548
  Ip: string | undefined;
2328
2549
  /**
2550
+ * @public
2329
2551
  * <p>The warm-up percentage that you want to associate with the dedicated IP
2330
2552
  * address.</p>
2331
2553
  */
@@ -2350,11 +2572,13 @@ export interface PutDedicatedIpWarmupAttributesResponse {
2350
2572
  */
2351
2573
  export interface PutDeliverabilityDashboardOptionRequest {
2352
2574
  /**
2575
+ * @public
2353
2576
  * <p>Specifies whether to enable the Deliverability dashboard for your Amazon Pinpoint account. To enable the
2354
2577
  * dashboard, set this value to <code>true</code>.</p>
2355
2578
  */
2356
2579
  DashboardEnabled: boolean | undefined;
2357
2580
  /**
2581
+ * @public
2358
2582
  * <p>An array of objects, one for each verified domain that you use to send email and
2359
2583
  * enabled the Deliverability dashboard for.</p>
2360
2584
  */
@@ -2374,10 +2598,12 @@ export interface PutDeliverabilityDashboardOptionResponse {
2374
2598
  */
2375
2599
  export interface PutEmailIdentityDkimAttributesRequest {
2376
2600
  /**
2601
+ * @public
2377
2602
  * <p>The email identity that you want to change the DKIM settings for.</p>
2378
2603
  */
2379
2604
  EmailIdentity: string | undefined;
2380
2605
  /**
2606
+ * @public
2381
2607
  * <p>Sets the DKIM signing configuration for the identity.</p>
2382
2608
  * <p>When you set this value <code>true</code>, then the messages that Amazon Pinpoint sends from the
2383
2609
  * identity are DKIM-signed. When you set this value to <code>false</code>, then the
@@ -2399,11 +2625,13 @@ export interface PutEmailIdentityDkimAttributesResponse {
2399
2625
  */
2400
2626
  export interface PutEmailIdentityFeedbackAttributesRequest {
2401
2627
  /**
2628
+ * @public
2402
2629
  * <p>The email identity that you want to configure bounce and complaint feedback forwarding
2403
2630
  * for.</p>
2404
2631
  */
2405
2632
  EmailIdentity: string | undefined;
2406
2633
  /**
2634
+ * @public
2407
2635
  * <p>Sets the feedback forwarding configuration for the identity.</p>
2408
2636
  * <p>If the value is <code>true</code>, Amazon Pinpoint sends you email notifications when bounce or
2409
2637
  * complaint events occur. Amazon Pinpoint sends this notification to the address that you specified
@@ -2429,11 +2657,13 @@ export interface PutEmailIdentityFeedbackAttributesResponse {
2429
2657
  */
2430
2658
  export interface PutEmailIdentityMailFromAttributesRequest {
2431
2659
  /**
2660
+ * @public
2432
2661
  * <p>The verified email identity that you want to set up the custom MAIL FROM domain
2433
2662
  * for.</p>
2434
2663
  */
2435
2664
  EmailIdentity: string | undefined;
2436
2665
  /**
2666
+ * @public
2437
2667
  * <p> The custom MAIL FROM domain that you want the verified identity to use. The MAIL FROM
2438
2668
  * domain must meet the following criteria:</p>
2439
2669
  * <ul>
@@ -2451,6 +2681,7 @@ export interface PutEmailIdentityMailFromAttributesRequest {
2451
2681
  */
2452
2682
  MailFromDomain?: string;
2453
2683
  /**
2684
+ * @public
2454
2685
  * <p>The action that you want Amazon Pinpoint to take if it can't read the required MX record when
2455
2686
  * you send an email. When you set this value to <code>UseDefaultValue</code>, Amazon Pinpoint uses
2456
2687
  * <i>amazonses.com</i> as the MAIL FROM domain. When you set this value
@@ -2475,16 +2706,19 @@ export interface PutEmailIdentityMailFromAttributesResponse {
2475
2706
  */
2476
2707
  export interface Destination {
2477
2708
  /**
2709
+ * @public
2478
2710
  * <p>An array that contains the email addresses of the "To" recipients for the
2479
2711
  * email.</p>
2480
2712
  */
2481
2713
  ToAddresses?: string[];
2482
2714
  /**
2715
+ * @public
2483
2716
  * <p>An array that contains the email addresses of the "CC" (carbon copy) recipients for
2484
2717
  * the email.</p>
2485
2718
  */
2486
2719
  CcAddresses?: string[];
2487
2720
  /**
2721
+ * @public
2488
2722
  * <p>An array that contains the email addresses of the "BCC" (blind carbon copy) recipients
2489
2723
  * for the email.</p>
2490
2724
  */
@@ -2498,6 +2732,7 @@ export interface Destination {
2498
2732
  */
2499
2733
  export interface MessageTag {
2500
2734
  /**
2735
+ * @public
2501
2736
  * <p>The name of the message tag. The message tag name has to meet the following
2502
2737
  * criteria:</p>
2503
2738
  * <ul>
@@ -2512,6 +2747,7 @@ export interface MessageTag {
2512
2747
  */
2513
2748
  Name: string | undefined;
2514
2749
  /**
2750
+ * @public
2515
2751
  * <p>The value of the message tag. The message tag value has to meet the following
2516
2752
  * criteria:</p>
2517
2753
  * <ul>
@@ -2532,36 +2768,43 @@ export interface MessageTag {
2532
2768
  */
2533
2769
  export interface SendEmailRequest {
2534
2770
  /**
2771
+ * @public
2535
2772
  * <p>The email address that you want to use as the "From" address for the email. The
2536
2773
  * address that you specify has to be verified.
2537
2774
  * </p>
2538
2775
  */
2539
2776
  FromEmailAddress?: string;
2540
2777
  /**
2778
+ * @public
2541
2779
  * <p>An object that contains the recipients of the email message.</p>
2542
2780
  */
2543
2781
  Destination: Destination | undefined;
2544
2782
  /**
2783
+ * @public
2545
2784
  * <p>The "Reply-to" email addresses for the message. When the recipient replies to the
2546
2785
  * message, each Reply-to address receives the reply.</p>
2547
2786
  */
2548
2787
  ReplyToAddresses?: string[];
2549
2788
  /**
2789
+ * @public
2550
2790
  * <p>The address that Amazon Pinpoint should send bounce and complaint notifications to.</p>
2551
2791
  */
2552
2792
  FeedbackForwardingEmailAddress?: string;
2553
2793
  /**
2794
+ * @public
2554
2795
  * <p>An object that contains the body of the message. You can send either a Simple message
2555
2796
  * or a Raw message.</p>
2556
2797
  */
2557
2798
  Content: EmailContent | undefined;
2558
2799
  /**
2800
+ * @public
2559
2801
  * <p>A list of tags, in the form of name/value pairs, to apply to an email that you send
2560
2802
  * using the <code>SendEmail</code> operation. Tags correspond to characteristics of the
2561
2803
  * email that you define, so that you can publish email sending events. </p>
2562
2804
  */
2563
2805
  EmailTags?: MessageTag[];
2564
2806
  /**
2807
+ * @public
2565
2808
  * <p>The name of the configuration set that you want to use when sending the email.</p>
2566
2809
  */
2567
2810
  ConfigurationSetName?: string;
@@ -2572,6 +2815,7 @@ export interface SendEmailRequest {
2572
2815
  */
2573
2816
  export interface SendEmailResponse {
2574
2817
  /**
2818
+ * @public
2575
2819
  * <p>A unique identifier for the message that is generated when Amazon Pinpoint accepts the
2576
2820
  * message.</p>
2577
2821
  * <note>
@@ -2588,11 +2832,13 @@ export interface SendEmailResponse {
2588
2832
  */
2589
2833
  export interface TagResourceRequest {
2590
2834
  /**
2835
+ * @public
2591
2836
  * <p>The Amazon Resource Name (ARN) of the resource that you want to add one or more tags
2592
2837
  * to.</p>
2593
2838
  */
2594
2839
  ResourceArn: string | undefined;
2595
2840
  /**
2841
+ * @public
2596
2842
  * <p>A list of the tags that you want to add to the resource. A tag consists of a required
2597
2843
  * tag key (<code>Key</code>) and an associated tag value (<code>Value</code>). The maximum
2598
2844
  * length of a tag key is 128 characters. The maximum length of a tag value is 256
@@ -2610,11 +2856,13 @@ export interface TagResourceResponse {
2610
2856
  */
2611
2857
  export interface UntagResourceRequest {
2612
2858
  /**
2859
+ * @public
2613
2860
  * <p>The Amazon Resource Name (ARN) of the resource that you want to remove one or more
2614
2861
  * tags from.</p>
2615
2862
  */
2616
2863
  ResourceArn: string | undefined;
2617
2864
  /**
2865
+ * @public
2618
2866
  * <p>The tags (tag keys) that you want to remove from the resource. When you specify a tag
2619
2867
  * key, the action removes both that key and its associated tag value.</p>
2620
2868
  * <p>To remove more than one tag from the resource, append the <code>TagKeys</code>
@@ -2637,15 +2885,18 @@ export interface UntagResourceResponse {
2637
2885
  */
2638
2886
  export interface UpdateConfigurationSetEventDestinationRequest {
2639
2887
  /**
2888
+ * @public
2640
2889
  * <p>The name of the configuration set that contains the event destination that you want to
2641
2890
  * modify.</p>
2642
2891
  */
2643
2892
  ConfigurationSetName: string | undefined;
2644
2893
  /**
2894
+ * @public
2645
2895
  * <p>The name of the event destination that you want to modify.</p>
2646
2896
  */
2647
2897
  EventDestinationName: string | undefined;
2648
2898
  /**
2899
+ * @public
2649
2900
  * <p>An object that defines the event destination.</p>
2650
2901
  */
2651
2902
  EventDestination: EventDestinationDefinition | undefined;