@aws-sdk/client-ses 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.
- package/dist-types/models/models_0.d.ts +350 -0
- package/package.json +5 -5
|
@@ -22,11 +22,13 @@ export declare class AccountSendingPausedException extends __BaseException {
|
|
|
22
22
|
*/
|
|
23
23
|
export interface AddHeaderAction {
|
|
24
24
|
/**
|
|
25
|
+
* @public
|
|
25
26
|
* <p>The name of the header to add. Must be between 1 and 50 characters, inclusive, and
|
|
26
27
|
* consist of alphanumeric (a-z, A-Z, 0-9) characters and dashes only.</p>
|
|
27
28
|
*/
|
|
28
29
|
HeaderName: string | undefined;
|
|
29
30
|
/**
|
|
31
|
+
* @public
|
|
30
32
|
* <p>Must be less than 2048 characters, and must not contain newline characters ("\r" or
|
|
31
33
|
* "\n").</p>
|
|
32
34
|
*/
|
|
@@ -40,6 +42,7 @@ export declare class AlreadyExistsException extends __BaseException {
|
|
|
40
42
|
readonly name: "AlreadyExistsException";
|
|
41
43
|
readonly $fault: "client";
|
|
42
44
|
/**
|
|
45
|
+
* @public
|
|
43
46
|
* <p>Indicates that a resource could not be created because the resource name already
|
|
44
47
|
* exists.</p>
|
|
45
48
|
*/
|
|
@@ -70,10 +73,12 @@ export type BehaviorOnMXFailure = (typeof BehaviorOnMXFailure)[keyof typeof Beha
|
|
|
70
73
|
*/
|
|
71
74
|
export interface Content {
|
|
72
75
|
/**
|
|
76
|
+
* @public
|
|
73
77
|
* <p>The textual data of the content.</p>
|
|
74
78
|
*/
|
|
75
79
|
Data: string | undefined;
|
|
76
80
|
/**
|
|
81
|
+
* @public
|
|
77
82
|
* <p>The character set of the content.</p>
|
|
78
83
|
*/
|
|
79
84
|
Charset?: string;
|
|
@@ -86,11 +91,13 @@ export interface Content {
|
|
|
86
91
|
*/
|
|
87
92
|
export interface Body {
|
|
88
93
|
/**
|
|
94
|
+
* @public
|
|
89
95
|
* <p>The content of the message, in text format. Use this for text-based email clients, or
|
|
90
96
|
* clients on high-latency networks (such as mobile devices).</p>
|
|
91
97
|
*/
|
|
92
98
|
Text?: Content;
|
|
93
99
|
/**
|
|
100
|
+
* @public
|
|
94
101
|
* <p>The content of the message, in HTML format. Use this for email clients that can
|
|
95
102
|
* process HTML. You can include clickable links, formatted text, and much more in an HTML
|
|
96
103
|
* message.</p>
|
|
@@ -108,6 +115,7 @@ export interface Body {
|
|
|
108
115
|
*/
|
|
109
116
|
export interface BounceAction {
|
|
110
117
|
/**
|
|
118
|
+
* @public
|
|
111
119
|
* <p>The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the bounce action is
|
|
112
120
|
* taken. An example of an Amazon SNS topic ARN is
|
|
113
121
|
* <code>arn:aws:sns:us-west-2:123456789012:MyTopic</code>. For more information about
|
|
@@ -115,18 +123,22 @@ export interface BounceAction {
|
|
|
115
123
|
*/
|
|
116
124
|
TopicArn?: string;
|
|
117
125
|
/**
|
|
126
|
+
* @public
|
|
118
127
|
* <p>The SMTP reply code, as defined by <a href="https://tools.ietf.org/html/rfc5321">RFC 5321</a>.</p>
|
|
119
128
|
*/
|
|
120
129
|
SmtpReplyCode: string | undefined;
|
|
121
130
|
/**
|
|
131
|
+
* @public
|
|
122
132
|
* <p>The SMTP enhanced status code, as defined by <a href="https://tools.ietf.org/html/rfc3463">RFC 3463</a>.</p>
|
|
123
133
|
*/
|
|
124
134
|
StatusCode?: string;
|
|
125
135
|
/**
|
|
136
|
+
* @public
|
|
126
137
|
* <p>Human-readable text to include in the bounce message.</p>
|
|
127
138
|
*/
|
|
128
139
|
Message: string | undefined;
|
|
129
140
|
/**
|
|
141
|
+
* @public
|
|
130
142
|
* <p>The email address of the sender of the bounced email. This is the address from which
|
|
131
143
|
* the bounce message will be sent.</p>
|
|
132
144
|
*/
|
|
@@ -172,11 +184,13 @@ export type DsnAction = (typeof DsnAction)[keyof typeof DsnAction];
|
|
|
172
184
|
*/
|
|
173
185
|
export interface ExtensionField {
|
|
174
186
|
/**
|
|
187
|
+
* @public
|
|
175
188
|
* <p>The name of the header to add. Must be between 1 and 50 characters, inclusive, and
|
|
176
189
|
* consist of alphanumeric (a-z, A-Z, 0-9) characters and dashes only.</p>
|
|
177
190
|
*/
|
|
178
191
|
Name: string | undefined;
|
|
179
192
|
/**
|
|
193
|
+
* @public
|
|
180
194
|
* <p>The value of the header to add. Must be less than 2048 characters, and must not
|
|
181
195
|
* contain newline characters ("\r" or "\n").</p>
|
|
182
196
|
*/
|
|
@@ -191,6 +205,7 @@ export interface ExtensionField {
|
|
|
191
205
|
*/
|
|
192
206
|
export interface RecipientDsnFields {
|
|
193
207
|
/**
|
|
208
|
+
* @public
|
|
194
209
|
* <p>The email address that the message was ultimately delivered to. This corresponds to
|
|
195
210
|
* the <code>Final-Recipient</code> in the DSN. If not specified,
|
|
196
211
|
* <code>FinalRecipient</code> will be set to the <code>Recipient</code> specified in
|
|
@@ -204,11 +219,13 @@ export interface RecipientDsnFields {
|
|
|
204
219
|
*/
|
|
205
220
|
FinalRecipient?: string;
|
|
206
221
|
/**
|
|
222
|
+
* @public
|
|
207
223
|
* <p>The action performed by the reporting mail transfer agent (MTA) as a result of its
|
|
208
224
|
* attempt to deliver the message to the recipient address. This is required by <a href="https://tools.ietf.org/html/rfc3464">RFC 3464</a>.</p>
|
|
209
225
|
*/
|
|
210
226
|
Action: DsnAction | string | undefined;
|
|
211
227
|
/**
|
|
228
|
+
* @public
|
|
212
229
|
* <p>The MTA to which the remote MTA attempted to deliver the message, formatted as
|
|
213
230
|
* specified in <a href="https://tools.ietf.org/html/rfc3464">RFC 3464</a>
|
|
214
231
|
* (<code>mta-name-type; mta-name</code>). This parameter typically applies only to
|
|
@@ -216,20 +233,24 @@ export interface RecipientDsnFields {
|
|
|
216
233
|
*/
|
|
217
234
|
RemoteMta?: string;
|
|
218
235
|
/**
|
|
236
|
+
* @public
|
|
219
237
|
* <p>The status code that indicates what went wrong. This is required by <a href="https://tools.ietf.org/html/rfc3464">RFC 3464</a>.</p>
|
|
220
238
|
*/
|
|
221
239
|
Status: string | undefined;
|
|
222
240
|
/**
|
|
241
|
+
* @public
|
|
223
242
|
* <p>An extended explanation of what went wrong; this is usually an SMTP response. See
|
|
224
243
|
* <a href="https://tools.ietf.org/html/rfc3463">RFC 3463</a> for the correct
|
|
225
244
|
* formatting of this parameter.</p>
|
|
226
245
|
*/
|
|
227
246
|
DiagnosticCode?: string;
|
|
228
247
|
/**
|
|
248
|
+
* @public
|
|
229
249
|
* <p>The time the final delivery attempt was made, in <a href="https://www.ietf.org/rfc/rfc0822.txt">RFC 822</a> date-time format.</p>
|
|
230
250
|
*/
|
|
231
251
|
LastAttemptDate?: Date;
|
|
232
252
|
/**
|
|
253
|
+
* @public
|
|
233
254
|
* <p>Additional X-headers to include in the DSN.</p>
|
|
234
255
|
*/
|
|
235
256
|
ExtensionFields?: ExtensionField[];
|
|
@@ -243,10 +264,12 @@ export interface RecipientDsnFields {
|
|
|
243
264
|
*/
|
|
244
265
|
export interface BouncedRecipientInfo {
|
|
245
266
|
/**
|
|
267
|
+
* @public
|
|
246
268
|
* <p>The email address of the recipient of the bounced email.</p>
|
|
247
269
|
*/
|
|
248
270
|
Recipient: string | undefined;
|
|
249
271
|
/**
|
|
272
|
+
* @public
|
|
250
273
|
* <p>This parameter is used only for sending authorization. It is the ARN of the identity
|
|
251
274
|
* that is associated with the sending authorization policy that permits you to receive
|
|
252
275
|
* email for the recipient of the bounced email. For more information about sending
|
|
@@ -255,11 +278,13 @@ export interface BouncedRecipientInfo {
|
|
|
255
278
|
*/
|
|
256
279
|
RecipientArn?: string;
|
|
257
280
|
/**
|
|
281
|
+
* @public
|
|
258
282
|
* <p>The reason for the bounce. You must provide either this parameter or
|
|
259
283
|
* <code>RecipientDsnFields</code>.</p>
|
|
260
284
|
*/
|
|
261
285
|
BounceType?: BounceType | string;
|
|
262
286
|
/**
|
|
287
|
+
* @public
|
|
263
288
|
* <p>Recipient-related DSN fields, most of which would normally be filled in automatically
|
|
264
289
|
* when provided with a <code>BounceType</code>. You must provide either this parameter or
|
|
265
290
|
* <code>BounceType</code>.</p>
|
|
@@ -281,14 +306,17 @@ export interface BouncedRecipientInfo {
|
|
|
281
306
|
*/
|
|
282
307
|
export interface Destination {
|
|
283
308
|
/**
|
|
309
|
+
* @public
|
|
284
310
|
* <p>The recipients to place on the To: line of the message.</p>
|
|
285
311
|
*/
|
|
286
312
|
ToAddresses?: string[];
|
|
287
313
|
/**
|
|
314
|
+
* @public
|
|
288
315
|
* <p>The recipients to place on the CC: line of the message.</p>
|
|
289
316
|
*/
|
|
290
317
|
CcAddresses?: string[];
|
|
291
318
|
/**
|
|
319
|
+
* @public
|
|
292
320
|
* <p>The recipients to place on the BCC: line of the message.</p>
|
|
293
321
|
*/
|
|
294
322
|
BccAddresses?: string[];
|
|
@@ -302,6 +330,7 @@ export interface Destination {
|
|
|
302
330
|
*/
|
|
303
331
|
export interface MessageTag {
|
|
304
332
|
/**
|
|
333
|
+
* @public
|
|
305
334
|
* <p>The name of the tag. The name must:</p>
|
|
306
335
|
* <ul>
|
|
307
336
|
* <li>
|
|
@@ -315,6 +344,7 @@ export interface MessageTag {
|
|
|
315
344
|
*/
|
|
316
345
|
Name: string | undefined;
|
|
317
346
|
/**
|
|
347
|
+
* @public
|
|
318
348
|
* <p>The value of the tag. The value must:</p>
|
|
319
349
|
* <ul>
|
|
320
350
|
* <li>
|
|
@@ -335,6 +365,7 @@ export interface MessageTag {
|
|
|
335
365
|
*/
|
|
336
366
|
export interface BulkEmailDestination {
|
|
337
367
|
/**
|
|
368
|
+
* @public
|
|
338
369
|
* <p>Represents the destination of the message, consisting of To:, CC:, and BCC:
|
|
339
370
|
* fields.</p>
|
|
340
371
|
* <note>
|
|
@@ -348,12 +379,14 @@ export interface BulkEmailDestination {
|
|
|
348
379
|
*/
|
|
349
380
|
Destination: Destination | undefined;
|
|
350
381
|
/**
|
|
382
|
+
* @public
|
|
351
383
|
* <p>A list of tags, in the form of name/value pairs, to apply to an email that you send
|
|
352
384
|
* using <code>SendBulkTemplatedEmail</code>. Tags correspond to characteristics of the
|
|
353
385
|
* email that you define, so that you can publish email sending events.</p>
|
|
354
386
|
*/
|
|
355
387
|
ReplacementTags?: MessageTag[];
|
|
356
388
|
/**
|
|
389
|
+
* @public
|
|
357
390
|
* <p>A list of replacement values to apply to the template. This parameter is a JSON
|
|
358
391
|
* object, typically consisting of key-value pairs in which the keys correspond to
|
|
359
392
|
* replacement tags in the email template.</p>
|
|
@@ -391,6 +424,7 @@ export type BulkEmailStatus = (typeof BulkEmailStatus)[keyof typeof BulkEmailSta
|
|
|
391
424
|
*/
|
|
392
425
|
export interface BulkEmailDestinationStatus {
|
|
393
426
|
/**
|
|
427
|
+
* @public
|
|
394
428
|
* <p>The status of a message sent using the <code>SendBulkTemplatedEmail</code>
|
|
395
429
|
* operation.</p>
|
|
396
430
|
* <p>Possible values for this parameter include:</p>
|
|
@@ -472,11 +506,13 @@ export interface BulkEmailDestinationStatus {
|
|
|
472
506
|
*/
|
|
473
507
|
Status?: BulkEmailStatus | string;
|
|
474
508
|
/**
|
|
509
|
+
* @public
|
|
475
510
|
* <p>A description of an error that prevented a message being sent using the
|
|
476
511
|
* <code>SendBulkTemplatedEmail</code> operation.</p>
|
|
477
512
|
*/
|
|
478
513
|
Error?: string;
|
|
479
514
|
/**
|
|
515
|
+
* @public
|
|
480
516
|
* <p>The unique message identifier returned from the <code>SendBulkTemplatedEmail</code>
|
|
481
517
|
* operation.</p>
|
|
482
518
|
*/
|
|
@@ -490,6 +526,7 @@ export declare class CannotDeleteException extends __BaseException {
|
|
|
490
526
|
readonly name: "CannotDeleteException";
|
|
491
527
|
readonly $fault: "client";
|
|
492
528
|
/**
|
|
529
|
+
* @public
|
|
493
530
|
* <p>Indicates that a resource could not be deleted because no resource with the specified
|
|
494
531
|
* name exists.</p>
|
|
495
532
|
*/
|
|
@@ -506,6 +543,7 @@ export declare class CannotDeleteException extends __BaseException {
|
|
|
506
543
|
*/
|
|
507
544
|
export interface CloneReceiptRuleSetRequest {
|
|
508
545
|
/**
|
|
546
|
+
* @public
|
|
509
547
|
* <p>The name of the rule set to create. The name must:</p>
|
|
510
548
|
* <ul>
|
|
511
549
|
* <li>
|
|
@@ -522,6 +560,7 @@ export interface CloneReceiptRuleSetRequest {
|
|
|
522
560
|
*/
|
|
523
561
|
RuleSetName: string | undefined;
|
|
524
562
|
/**
|
|
563
|
+
* @public
|
|
525
564
|
* <p>The name of the rule set to clone.</p>
|
|
526
565
|
*/
|
|
527
566
|
OriginalRuleSetName: string | undefined;
|
|
@@ -554,6 +593,7 @@ export declare class RuleSetDoesNotExistException extends __BaseException {
|
|
|
554
593
|
readonly name: "RuleSetDoesNotExistException";
|
|
555
594
|
readonly $fault: "client";
|
|
556
595
|
/**
|
|
596
|
+
* @public
|
|
557
597
|
* <p>Indicates that the named receipt rule set does not exist.</p>
|
|
558
598
|
*/
|
|
559
599
|
Name?: string;
|
|
@@ -583,6 +623,7 @@ export type DimensionValueSource = (typeof DimensionValueSource)[keyof typeof Di
|
|
|
583
623
|
*/
|
|
584
624
|
export interface CloudWatchDimensionConfiguration {
|
|
585
625
|
/**
|
|
626
|
+
* @public
|
|
586
627
|
* <p>The name of an Amazon CloudWatch dimension associated with an email sending metric. The name
|
|
587
628
|
* must:</p>
|
|
588
629
|
* <ul>
|
|
@@ -597,6 +638,7 @@ export interface CloudWatchDimensionConfiguration {
|
|
|
597
638
|
*/
|
|
598
639
|
DimensionName: string | undefined;
|
|
599
640
|
/**
|
|
641
|
+
* @public
|
|
600
642
|
* <p>The place where Amazon SES finds the value of a dimension to publish to Amazon CloudWatch. If you
|
|
601
643
|
* want Amazon SES to use the message tags that you specify using an
|
|
602
644
|
* <code>X-SES-MESSAGE-TAGS</code> header or a parameter to the
|
|
@@ -606,6 +648,7 @@ export interface CloudWatchDimensionConfiguration {
|
|
|
606
648
|
*/
|
|
607
649
|
DimensionValueSource: DimensionValueSource | string | undefined;
|
|
608
650
|
/**
|
|
651
|
+
* @public
|
|
609
652
|
* <p>The default value of the dimension that is published to Amazon CloudWatch if you do not provide
|
|
610
653
|
* the value of the dimension when you send an email. The default value must:</p>
|
|
611
654
|
* <ul>
|
|
@@ -631,6 +674,7 @@ export interface CloudWatchDimensionConfiguration {
|
|
|
631
674
|
*/
|
|
632
675
|
export interface CloudWatchDestination {
|
|
633
676
|
/**
|
|
677
|
+
* @public
|
|
634
678
|
* <p>A list of dimensions upon which to categorize your emails when you publish email
|
|
635
679
|
* sending events to Amazon CloudWatch.</p>
|
|
636
680
|
*/
|
|
@@ -644,6 +688,7 @@ export interface CloudWatchDestination {
|
|
|
644
688
|
*/
|
|
645
689
|
export interface ConfigurationSet {
|
|
646
690
|
/**
|
|
691
|
+
* @public
|
|
647
692
|
* <p>The name of the configuration set. The name must meet the following
|
|
648
693
|
* requirements:</p>
|
|
649
694
|
* <ul>
|
|
@@ -667,6 +712,7 @@ export declare class ConfigurationSetAlreadyExistsException extends __BaseExcept
|
|
|
667
712
|
readonly name: "ConfigurationSetAlreadyExistsException";
|
|
668
713
|
readonly $fault: "client";
|
|
669
714
|
/**
|
|
715
|
+
* @public
|
|
670
716
|
* <p>Indicates that the configuration set does not exist.</p>
|
|
671
717
|
*/
|
|
672
718
|
ConfigurationSetName?: string;
|
|
@@ -697,6 +743,7 @@ export declare class ConfigurationSetDoesNotExistException extends __BaseExcepti
|
|
|
697
743
|
readonly name: "ConfigurationSetDoesNotExistException";
|
|
698
744
|
readonly $fault: "client";
|
|
699
745
|
/**
|
|
746
|
+
* @public
|
|
700
747
|
* <p>Indicates that the configuration set does not exist.</p>
|
|
701
748
|
*/
|
|
702
749
|
ConfigurationSetName?: string;
|
|
@@ -714,6 +761,7 @@ export declare class ConfigurationSetSendingPausedException extends __BaseExcept
|
|
|
714
761
|
readonly name: "ConfigurationSetSendingPausedException";
|
|
715
762
|
readonly $fault: "client";
|
|
716
763
|
/**
|
|
764
|
+
* @public
|
|
717
765
|
* <p>The name of the configuration set for which email sending is disabled.</p>
|
|
718
766
|
*/
|
|
719
767
|
ConfigurationSetName?: string;
|
|
@@ -731,6 +779,7 @@ export declare class ConfigurationSetSendingPausedException extends __BaseExcept
|
|
|
731
779
|
*/
|
|
732
780
|
export interface CreateConfigurationSetRequest {
|
|
733
781
|
/**
|
|
782
|
+
* @public
|
|
734
783
|
* <p>A data structure that contains the name of the configuration set.</p>
|
|
735
784
|
*/
|
|
736
785
|
ConfigurationSet: ConfigurationSet | undefined;
|
|
@@ -765,11 +814,13 @@ export declare class InvalidConfigurationSetException extends __BaseException {
|
|
|
765
814
|
*/
|
|
766
815
|
export interface KinesisFirehoseDestination {
|
|
767
816
|
/**
|
|
817
|
+
* @public
|
|
768
818
|
* <p>The ARN of the IAM role under which Amazon SES publishes email sending events to the Amazon Kinesis Firehose
|
|
769
819
|
* stream.</p>
|
|
770
820
|
*/
|
|
771
821
|
IAMRoleARN: string | undefined;
|
|
772
822
|
/**
|
|
823
|
+
* @public
|
|
773
824
|
* <p>The ARN of the Amazon Kinesis Firehose stream that email sending events should be published to.</p>
|
|
774
825
|
*/
|
|
775
826
|
DeliveryStreamARN: string | undefined;
|
|
@@ -802,6 +853,7 @@ export type EventType = (typeof EventType)[keyof typeof EventType];
|
|
|
802
853
|
*/
|
|
803
854
|
export interface SNSDestination {
|
|
804
855
|
/**
|
|
856
|
+
* @public
|
|
805
857
|
* <p>The ARN of the Amazon SNS topic that email sending events will be published to. An example
|
|
806
858
|
* of an Amazon SNS topic ARN is <code>arn:aws:sns:us-west-2:123456789012:MyTopic</code>. For
|
|
807
859
|
* 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>
|
|
@@ -823,6 +875,7 @@ export interface SNSDestination {
|
|
|
823
875
|
*/
|
|
824
876
|
export interface EventDestination {
|
|
825
877
|
/**
|
|
878
|
+
* @public
|
|
826
879
|
* <p>The name of the event destination. The name must:</p>
|
|
827
880
|
* <ul>
|
|
828
881
|
* <li>
|
|
@@ -836,6 +889,7 @@ export interface EventDestination {
|
|
|
836
889
|
*/
|
|
837
890
|
Name: string | undefined;
|
|
838
891
|
/**
|
|
892
|
+
* @public
|
|
839
893
|
* <p>Sets whether Amazon SES publishes events to this destination when you send an email with
|
|
840
894
|
* the associated configuration set. Set to <code>true</code> to enable publishing to this
|
|
841
895
|
* destination; set to <code>false</code> to prevent publishing to this destination. The
|
|
@@ -843,20 +897,24 @@ export interface EventDestination {
|
|
|
843
897
|
*/
|
|
844
898
|
Enabled?: boolean;
|
|
845
899
|
/**
|
|
900
|
+
* @public
|
|
846
901
|
* <p>The type of email sending events to publish to the event destination.</p>
|
|
847
902
|
*/
|
|
848
903
|
MatchingEventTypes: (EventType | string)[] | undefined;
|
|
849
904
|
/**
|
|
905
|
+
* @public
|
|
850
906
|
* <p>An object that contains the delivery stream ARN and the IAM role ARN associated with
|
|
851
907
|
* an Amazon Kinesis Firehose event destination.</p>
|
|
852
908
|
*/
|
|
853
909
|
KinesisFirehoseDestination?: KinesisFirehoseDestination;
|
|
854
910
|
/**
|
|
911
|
+
* @public
|
|
855
912
|
* <p>An object that contains the names, default values, and sources of the dimensions
|
|
856
913
|
* associated with an Amazon CloudWatch event destination.</p>
|
|
857
914
|
*/
|
|
858
915
|
CloudWatchDestination?: CloudWatchDestination;
|
|
859
916
|
/**
|
|
917
|
+
* @public
|
|
860
918
|
* <p>An object that contains the topic ARN associated with an Amazon Simple Notification Service (Amazon SNS) event
|
|
861
919
|
* destination.</p>
|
|
862
920
|
*/
|
|
@@ -872,11 +930,13 @@ export interface EventDestination {
|
|
|
872
930
|
*/
|
|
873
931
|
export interface CreateConfigurationSetEventDestinationRequest {
|
|
874
932
|
/**
|
|
933
|
+
* @public
|
|
875
934
|
* <p>The name of the configuration set that the event destination should be associated
|
|
876
935
|
* with.</p>
|
|
877
936
|
*/
|
|
878
937
|
ConfigurationSetName: string | undefined;
|
|
879
938
|
/**
|
|
939
|
+
* @public
|
|
880
940
|
* <p>An object that describes the AWS service that email sending event information will
|
|
881
941
|
* be published to.</p>
|
|
882
942
|
*/
|
|
@@ -897,10 +957,12 @@ export declare class EventDestinationAlreadyExistsException extends __BaseExcept
|
|
|
897
957
|
readonly name: "EventDestinationAlreadyExistsException";
|
|
898
958
|
readonly $fault: "client";
|
|
899
959
|
/**
|
|
960
|
+
* @public
|
|
900
961
|
* <p>Indicates that the configuration set does not exist.</p>
|
|
901
962
|
*/
|
|
902
963
|
ConfigurationSetName?: string;
|
|
903
964
|
/**
|
|
965
|
+
* @public
|
|
904
966
|
* <p>Indicates that the event destination does not exist.</p>
|
|
905
967
|
*/
|
|
906
968
|
EventDestinationName?: string;
|
|
@@ -918,10 +980,12 @@ export declare class InvalidCloudWatchDestinationException extends __BaseExcepti
|
|
|
918
980
|
readonly name: "InvalidCloudWatchDestinationException";
|
|
919
981
|
readonly $fault: "client";
|
|
920
982
|
/**
|
|
983
|
+
* @public
|
|
921
984
|
* <p>Indicates that the configuration set does not exist.</p>
|
|
922
985
|
*/
|
|
923
986
|
ConfigurationSetName?: string;
|
|
924
987
|
/**
|
|
988
|
+
* @public
|
|
925
989
|
* <p>Indicates that the event destination does not exist.</p>
|
|
926
990
|
*/
|
|
927
991
|
EventDestinationName?: string;
|
|
@@ -939,10 +1003,12 @@ export declare class InvalidFirehoseDestinationException extends __BaseException
|
|
|
939
1003
|
readonly name: "InvalidFirehoseDestinationException";
|
|
940
1004
|
readonly $fault: "client";
|
|
941
1005
|
/**
|
|
1006
|
+
* @public
|
|
942
1007
|
* <p>Indicates that the configuration set does not exist.</p>
|
|
943
1008
|
*/
|
|
944
1009
|
ConfigurationSetName?: string;
|
|
945
1010
|
/**
|
|
1011
|
+
* @public
|
|
946
1012
|
* <p>Indicates that the event destination does not exist.</p>
|
|
947
1013
|
*/
|
|
948
1014
|
EventDestinationName?: string;
|
|
@@ -960,10 +1026,12 @@ export declare class InvalidSNSDestinationException extends __BaseException {
|
|
|
960
1026
|
readonly name: "InvalidSNSDestinationException";
|
|
961
1027
|
readonly $fault: "client";
|
|
962
1028
|
/**
|
|
1029
|
+
* @public
|
|
963
1030
|
* <p>Indicates that the configuration set does not exist.</p>
|
|
964
1031
|
*/
|
|
965
1032
|
ConfigurationSetName?: string;
|
|
966
1033
|
/**
|
|
1034
|
+
* @public
|
|
967
1035
|
* <p>Indicates that the event destination does not exist.</p>
|
|
968
1036
|
*/
|
|
969
1037
|
EventDestinationName?: string;
|
|
@@ -982,6 +1050,7 @@ export declare class InvalidSNSDestinationException extends __BaseException {
|
|
|
982
1050
|
*/
|
|
983
1051
|
export interface TrackingOptions {
|
|
984
1052
|
/**
|
|
1053
|
+
* @public
|
|
985
1054
|
* <p>The custom subdomain that will be used to redirect email recipients to the Amazon SES
|
|
986
1055
|
* event tracking domain.</p>
|
|
987
1056
|
*/
|
|
@@ -994,11 +1063,13 @@ export interface TrackingOptions {
|
|
|
994
1063
|
*/
|
|
995
1064
|
export interface CreateConfigurationSetTrackingOptionsRequest {
|
|
996
1065
|
/**
|
|
1066
|
+
* @public
|
|
997
1067
|
* <p>The name of the configuration set that the tracking options should be associated
|
|
998
1068
|
* with.</p>
|
|
999
1069
|
*/
|
|
1000
1070
|
ConfigurationSetName: string | undefined;
|
|
1001
1071
|
/**
|
|
1072
|
+
* @public
|
|
1002
1073
|
* <p>A domain that is used to redirect email recipients to an Amazon SES-operated domain. This
|
|
1003
1074
|
* domain captures open and click events generated by Amazon SES emails.</p>
|
|
1004
1075
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/ses/latest/DeveloperGuide/configure-custom-open-click-domains.html">Configuring
|
|
@@ -1044,6 +1115,7 @@ export declare class TrackingOptionsAlreadyExistsException extends __BaseExcepti
|
|
|
1044
1115
|
readonly name: "TrackingOptionsAlreadyExistsException";
|
|
1045
1116
|
readonly $fault: "client";
|
|
1046
1117
|
/**
|
|
1118
|
+
* @public
|
|
1047
1119
|
* <p>Indicates that a TrackingOptions object already exists in the specified configuration
|
|
1048
1120
|
* set.</p>
|
|
1049
1121
|
*/
|
|
@@ -1059,18 +1131,22 @@ export declare class TrackingOptionsAlreadyExistsException extends __BaseExcepti
|
|
|
1059
1131
|
*/
|
|
1060
1132
|
export interface CreateCustomVerificationEmailTemplateRequest {
|
|
1061
1133
|
/**
|
|
1134
|
+
* @public
|
|
1062
1135
|
* <p>The name of the custom verification email template.</p>
|
|
1063
1136
|
*/
|
|
1064
1137
|
TemplateName: string | undefined;
|
|
1065
1138
|
/**
|
|
1139
|
+
* @public
|
|
1066
1140
|
* <p>The email address that the custom verification email is sent from.</p>
|
|
1067
1141
|
*/
|
|
1068
1142
|
FromEmailAddress: string | undefined;
|
|
1069
1143
|
/**
|
|
1144
|
+
* @public
|
|
1070
1145
|
* <p>The subject line of the custom verification email.</p>
|
|
1071
1146
|
*/
|
|
1072
1147
|
TemplateSubject: string | undefined;
|
|
1073
1148
|
/**
|
|
1149
|
+
* @public
|
|
1074
1150
|
* <p>The content of the custom verification email. The total size of the email must be less
|
|
1075
1151
|
* than 10 MB. The message body may contain HTML, with some limitations. For more
|
|
1076
1152
|
* information, see <a href="https://docs.aws.amazon.com/ses/latest/DeveloperGuide/custom-verification-emails.html#custom-verification-emails-faq">Custom Verification Email Frequently Asked Questions</a> in the <i>Amazon SES
|
|
@@ -1078,11 +1154,13 @@ export interface CreateCustomVerificationEmailTemplateRequest {
|
|
|
1078
1154
|
*/
|
|
1079
1155
|
TemplateContent: string | undefined;
|
|
1080
1156
|
/**
|
|
1157
|
+
* @public
|
|
1081
1158
|
* <p>The URL that the recipient of the verification email is sent to if his or her address
|
|
1082
1159
|
* is successfully verified.</p>
|
|
1083
1160
|
*/
|
|
1084
1161
|
SuccessRedirectionURL: string | undefined;
|
|
1085
1162
|
/**
|
|
1163
|
+
* @public
|
|
1086
1164
|
* <p>The URL that the recipient of the verification email is sent to if his or her address
|
|
1087
1165
|
* is not successfully verified.</p>
|
|
1088
1166
|
*/
|
|
@@ -1109,6 +1187,7 @@ export declare class CustomVerificationEmailTemplateAlreadyExistsException exten
|
|
|
1109
1187
|
readonly name: "CustomVerificationEmailTemplateAlreadyExistsException";
|
|
1110
1188
|
readonly $fault: "client";
|
|
1111
1189
|
/**
|
|
1190
|
+
* @public
|
|
1112
1191
|
* <p>Indicates that the provided custom verification email template with the specified
|
|
1113
1192
|
* template name already exists.</p>
|
|
1114
1193
|
*/
|
|
@@ -1127,6 +1206,7 @@ export declare class FromEmailAddressNotVerifiedException extends __BaseExceptio
|
|
|
1127
1206
|
readonly name: "FromEmailAddressNotVerifiedException";
|
|
1128
1207
|
readonly $fault: "client";
|
|
1129
1208
|
/**
|
|
1209
|
+
* @public
|
|
1130
1210
|
* <p>Indicates that the from email address associated with the custom verification email
|
|
1131
1211
|
* template is not verified.</p>
|
|
1132
1212
|
*/
|
|
@@ -1156,11 +1236,13 @@ export type ReceiptFilterPolicy = (typeof ReceiptFilterPolicy)[keyof typeof Rece
|
|
|
1156
1236
|
*/
|
|
1157
1237
|
export interface ReceiptIpFilter {
|
|
1158
1238
|
/**
|
|
1239
|
+
* @public
|
|
1159
1240
|
* <p>Indicates whether to block or allow incoming mail from the specified IP
|
|
1160
1241
|
* addresses.</p>
|
|
1161
1242
|
*/
|
|
1162
1243
|
Policy: ReceiptFilterPolicy | string | undefined;
|
|
1163
1244
|
/**
|
|
1245
|
+
* @public
|
|
1164
1246
|
* <p>A single IP address or a range of IP addresses that you want to block or allow,
|
|
1165
1247
|
* specified in Classless Inter-Domain Routing (CIDR) notation. An example of a single
|
|
1166
1248
|
* email address is 10.0.0.1. An example of a range of IP addresses is 10.0.0.1/24. For
|
|
@@ -1176,6 +1258,7 @@ export interface ReceiptIpFilter {
|
|
|
1176
1258
|
*/
|
|
1177
1259
|
export interface ReceiptFilter {
|
|
1178
1260
|
/**
|
|
1261
|
+
* @public
|
|
1179
1262
|
* <p>The name of the IP address filter. The name must:</p>
|
|
1180
1263
|
* <ul>
|
|
1181
1264
|
* <li>
|
|
@@ -1192,6 +1275,7 @@ export interface ReceiptFilter {
|
|
|
1192
1275
|
*/
|
|
1193
1276
|
Name: string | undefined;
|
|
1194
1277
|
/**
|
|
1278
|
+
* @public
|
|
1195
1279
|
* <p>A structure that provides the IP addresses to block or allow, and whether to block or
|
|
1196
1280
|
* allow incoming mail from them.</p>
|
|
1197
1281
|
*/
|
|
@@ -1204,6 +1288,7 @@ export interface ReceiptFilter {
|
|
|
1204
1288
|
*/
|
|
1205
1289
|
export interface CreateReceiptFilterRequest {
|
|
1206
1290
|
/**
|
|
1291
|
+
* @public
|
|
1207
1292
|
* <p>A data structure that describes the IP address filter to create, which consists of a
|
|
1208
1293
|
* name, an IP address range, and whether to allow or block mail from it.</p>
|
|
1209
1294
|
*/
|
|
@@ -1232,6 +1317,7 @@ export type InvocationType = "Event" | "RequestResponse";
|
|
|
1232
1317
|
*/
|
|
1233
1318
|
export interface LambdaAction {
|
|
1234
1319
|
/**
|
|
1320
|
+
* @public
|
|
1235
1321
|
* <p>The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the Lambda action is
|
|
1236
1322
|
* taken. An example of an Amazon SNS topic ARN is
|
|
1237
1323
|
* <code>arn:aws:sns:us-west-2:123456789012:MyTopic</code>. For more information about
|
|
@@ -1239,12 +1325,14 @@ export interface LambdaAction {
|
|
|
1239
1325
|
*/
|
|
1240
1326
|
TopicArn?: string;
|
|
1241
1327
|
/**
|
|
1328
|
+
* @public
|
|
1242
1329
|
* <p>The Amazon Resource Name (ARN) of the AWS Lambda function. An example of an AWS Lambda
|
|
1243
1330
|
* function ARN is <code>arn:aws:lambda:us-west-2:account-id:function:MyFunction</code>.
|
|
1244
1331
|
* For more information about AWS Lambda, see the <a href="https://docs.aws.amazon.com/lambda/latest/dg/welcome.html">AWS Lambda Developer Guide</a>.</p>
|
|
1245
1332
|
*/
|
|
1246
1333
|
FunctionArn: string | undefined;
|
|
1247
1334
|
/**
|
|
1335
|
+
* @public
|
|
1248
1336
|
* <p>The invocation type of the AWS Lambda function. An invocation type of
|
|
1249
1337
|
* <code>RequestResponse</code> means that the execution of the function will
|
|
1250
1338
|
* immediately result in a response, and a value of <code>Event</code> means that the
|
|
@@ -1275,6 +1363,7 @@ export interface LambdaAction {
|
|
|
1275
1363
|
*/
|
|
1276
1364
|
export interface S3Action {
|
|
1277
1365
|
/**
|
|
1366
|
+
* @public
|
|
1278
1367
|
* <p>The ARN of the Amazon SNS topic to notify when the message is saved to the Amazon S3 bucket. An
|
|
1279
1368
|
* example of an Amazon SNS topic ARN is
|
|
1280
1369
|
* <code>arn:aws:sns:us-west-2:123456789012:MyTopic</code>. For more information about
|
|
@@ -1282,15 +1371,18 @@ export interface S3Action {
|
|
|
1282
1371
|
*/
|
|
1283
1372
|
TopicArn?: string;
|
|
1284
1373
|
/**
|
|
1374
|
+
* @public
|
|
1285
1375
|
* <p>The name of the Amazon S3 bucket that incoming email will be saved to.</p>
|
|
1286
1376
|
*/
|
|
1287
1377
|
BucketName: string | undefined;
|
|
1288
1378
|
/**
|
|
1379
|
+
* @public
|
|
1289
1380
|
* <p>The key prefix of the Amazon S3 bucket. The key prefix is similar to a directory name that
|
|
1290
1381
|
* enables you to store similar data under the same directory in a bucket.</p>
|
|
1291
1382
|
*/
|
|
1292
1383
|
ObjectKeyPrefix?: string;
|
|
1293
1384
|
/**
|
|
1385
|
+
* @public
|
|
1294
1386
|
* <p>The customer master key that Amazon SES should use to encrypt your emails before saving
|
|
1295
1387
|
* them to the Amazon S3 bucket. You can use the default master key or a custom master key you
|
|
1296
1388
|
* created in AWS KMS as follows:</p>
|
|
@@ -1360,12 +1452,14 @@ export type SNSActionEncoding = (typeof SNSActionEncoding)[keyof typeof SNSActio
|
|
|
1360
1452
|
*/
|
|
1361
1453
|
export interface SNSAction {
|
|
1362
1454
|
/**
|
|
1455
|
+
* @public
|
|
1363
1456
|
* <p>The Amazon Resource Name (ARN) of the Amazon SNS topic to notify. An example of an Amazon SNS
|
|
1364
1457
|
* topic ARN is <code>arn:aws:sns:us-west-2:123456789012:MyTopic</code>. For more
|
|
1365
1458
|
* 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>
|
|
1366
1459
|
*/
|
|
1367
1460
|
TopicArn: string | undefined;
|
|
1368
1461
|
/**
|
|
1462
|
+
* @public
|
|
1369
1463
|
* <p>The encoding to use for the email within the Amazon SNS notification. UTF-8 is easier to
|
|
1370
1464
|
* use, but may not preserve all special characters when a message was encoded with a
|
|
1371
1465
|
* different encoding format. Base64 preserves all special characters. The default value is
|
|
@@ -1393,10 +1487,12 @@ export type StopScope = (typeof StopScope)[keyof typeof StopScope];
|
|
|
1393
1487
|
*/
|
|
1394
1488
|
export interface StopAction {
|
|
1395
1489
|
/**
|
|
1490
|
+
* @public
|
|
1396
1491
|
* <p>The scope of the StopAction. The only acceptable value is <code>RuleSet</code>.</p>
|
|
1397
1492
|
*/
|
|
1398
1493
|
Scope: StopScope | string | undefined;
|
|
1399
1494
|
/**
|
|
1495
|
+
* @public
|
|
1400
1496
|
* <p>The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the stop action is
|
|
1401
1497
|
* taken. An example of an Amazon SNS topic ARN is
|
|
1402
1498
|
* <code>arn:aws:sns:us-west-2:123456789012:MyTopic</code>. For more information about
|
|
@@ -1415,6 +1511,7 @@ export interface StopAction {
|
|
|
1415
1511
|
*/
|
|
1416
1512
|
export interface WorkmailAction {
|
|
1417
1513
|
/**
|
|
1514
|
+
* @public
|
|
1418
1515
|
* <p>The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the WorkMail action
|
|
1419
1516
|
* is called. An example of an Amazon SNS topic ARN is
|
|
1420
1517
|
* <code>arn:aws:sns:us-west-2:123456789012:MyTopic</code>. For more information about
|
|
@@ -1422,6 +1519,7 @@ export interface WorkmailAction {
|
|
|
1422
1519
|
*/
|
|
1423
1520
|
TopicArn?: string;
|
|
1424
1521
|
/**
|
|
1522
|
+
* @public
|
|
1425
1523
|
* <p>The ARN of the Amazon WorkMail organization. An example of an Amazon WorkMail
|
|
1426
1524
|
* organization ARN is
|
|
1427
1525
|
* <code>arn:aws:workmail:us-west-2:123456789012:organization/m-68755160c4cb4e29a2b2f8fb58f359d7</code>.
|
|
@@ -1440,34 +1538,41 @@ export interface WorkmailAction {
|
|
|
1440
1538
|
*/
|
|
1441
1539
|
export interface ReceiptAction {
|
|
1442
1540
|
/**
|
|
1541
|
+
* @public
|
|
1443
1542
|
* <p>Saves the received message to an Amazon Simple Storage Service (Amazon S3) bucket and, optionally, publishes a
|
|
1444
1543
|
* notification to Amazon SNS.</p>
|
|
1445
1544
|
*/
|
|
1446
1545
|
S3Action?: S3Action;
|
|
1447
1546
|
/**
|
|
1547
|
+
* @public
|
|
1448
1548
|
* <p>Rejects the received email by returning a bounce response to the sender and,
|
|
1449
1549
|
* optionally, publishes a notification to Amazon Simple Notification Service (Amazon SNS).</p>
|
|
1450
1550
|
*/
|
|
1451
1551
|
BounceAction?: BounceAction;
|
|
1452
1552
|
/**
|
|
1553
|
+
* @public
|
|
1453
1554
|
* <p>Calls Amazon WorkMail and, optionally, publishes a notification to Amazon
|
|
1454
1555
|
* Amazon SNS.</p>
|
|
1455
1556
|
*/
|
|
1456
1557
|
WorkmailAction?: WorkmailAction;
|
|
1457
1558
|
/**
|
|
1559
|
+
* @public
|
|
1458
1560
|
* <p>Calls an AWS Lambda function, and optionally, publishes a notification to Amazon SNS.</p>
|
|
1459
1561
|
*/
|
|
1460
1562
|
LambdaAction?: LambdaAction;
|
|
1461
1563
|
/**
|
|
1564
|
+
* @public
|
|
1462
1565
|
* <p>Terminates the evaluation of the receipt rule set and optionally publishes a
|
|
1463
1566
|
* notification to Amazon SNS.</p>
|
|
1464
1567
|
*/
|
|
1465
1568
|
StopAction?: StopAction;
|
|
1466
1569
|
/**
|
|
1570
|
+
* @public
|
|
1467
1571
|
* <p>Adds a header to the received email.</p>
|
|
1468
1572
|
*/
|
|
1469
1573
|
AddHeaderAction?: AddHeaderAction;
|
|
1470
1574
|
/**
|
|
1575
|
+
* @public
|
|
1471
1576
|
* <p>Publishes the email content within a notification to Amazon SNS.</p>
|
|
1472
1577
|
*/
|
|
1473
1578
|
SNSAction?: SNSAction;
|
|
@@ -1496,6 +1601,7 @@ export type TlsPolicy = (typeof TlsPolicy)[keyof typeof TlsPolicy];
|
|
|
1496
1601
|
*/
|
|
1497
1602
|
export interface ReceiptRule {
|
|
1498
1603
|
/**
|
|
1604
|
+
* @public
|
|
1499
1605
|
* <p>The name of the receipt rule. The name must:</p>
|
|
1500
1606
|
* <ul>
|
|
1501
1607
|
* <li>
|
|
@@ -1512,11 +1618,13 @@ export interface ReceiptRule {
|
|
|
1512
1618
|
*/
|
|
1513
1619
|
Name: string | undefined;
|
|
1514
1620
|
/**
|
|
1621
|
+
* @public
|
|
1515
1622
|
* <p>If <code>true</code>, the receipt rule is active. The default value is
|
|
1516
1623
|
* <code>false</code>.</p>
|
|
1517
1624
|
*/
|
|
1518
1625
|
Enabled?: boolean;
|
|
1519
1626
|
/**
|
|
1627
|
+
* @public
|
|
1520
1628
|
* <p>Specifies whether Amazon SES should require that incoming email is delivered over a
|
|
1521
1629
|
* connection encrypted with Transport Layer Security (TLS). If this parameter is set to
|
|
1522
1630
|
* <code>Require</code>, Amazon SES will bounce emails that are not received over TLS. The
|
|
@@ -1524,17 +1632,20 @@ export interface ReceiptRule {
|
|
|
1524
1632
|
*/
|
|
1525
1633
|
TlsPolicy?: TlsPolicy | string;
|
|
1526
1634
|
/**
|
|
1635
|
+
* @public
|
|
1527
1636
|
* <p>The recipient domains and email addresses that the receipt rule applies to. If this
|
|
1528
1637
|
* field is not specified, this rule will match all recipients under all verified
|
|
1529
1638
|
* domains.</p>
|
|
1530
1639
|
*/
|
|
1531
1640
|
Recipients?: string[];
|
|
1532
1641
|
/**
|
|
1642
|
+
* @public
|
|
1533
1643
|
* <p>An ordered list of actions to perform on messages that match at least one of the
|
|
1534
1644
|
* recipient email addresses or domains specified in the receipt rule.</p>
|
|
1535
1645
|
*/
|
|
1536
1646
|
Actions?: ReceiptAction[];
|
|
1537
1647
|
/**
|
|
1648
|
+
* @public
|
|
1538
1649
|
* <p>If <code>true</code>, then messages that this receipt rule applies to are scanned for
|
|
1539
1650
|
* spam and viruses. The default value is <code>false</code>.</p>
|
|
1540
1651
|
*/
|
|
@@ -1548,16 +1659,19 @@ export interface ReceiptRule {
|
|
|
1548
1659
|
*/
|
|
1549
1660
|
export interface CreateReceiptRuleRequest {
|
|
1550
1661
|
/**
|
|
1662
|
+
* @public
|
|
1551
1663
|
* <p>The name of the rule set that the receipt rule will be added to.</p>
|
|
1552
1664
|
*/
|
|
1553
1665
|
RuleSetName: string | undefined;
|
|
1554
1666
|
/**
|
|
1667
|
+
* @public
|
|
1555
1668
|
* <p>The name of an existing rule after which the new rule will be placed. If this
|
|
1556
1669
|
* parameter is null, the new rule will be inserted at the beginning of the rule
|
|
1557
1670
|
* list.</p>
|
|
1558
1671
|
*/
|
|
1559
1672
|
After?: string;
|
|
1560
1673
|
/**
|
|
1674
|
+
* @public
|
|
1561
1675
|
* <p>A data structure that contains the specified rule's name, actions, recipients,
|
|
1562
1676
|
* domains, enabled status, scan status, and TLS policy.</p>
|
|
1563
1677
|
*/
|
|
@@ -1580,6 +1694,7 @@ export declare class InvalidLambdaFunctionException extends __BaseException {
|
|
|
1580
1694
|
readonly name: "InvalidLambdaFunctionException";
|
|
1581
1695
|
readonly $fault: "client";
|
|
1582
1696
|
/**
|
|
1697
|
+
* @public
|
|
1583
1698
|
* <p>Indicates that the ARN of the function was not found.</p>
|
|
1584
1699
|
*/
|
|
1585
1700
|
FunctionArn?: string;
|
|
@@ -1599,6 +1714,7 @@ export declare class InvalidS3ConfigurationException extends __BaseException {
|
|
|
1599
1714
|
readonly name: "InvalidS3ConfigurationException";
|
|
1600
1715
|
readonly $fault: "client";
|
|
1601
1716
|
/**
|
|
1717
|
+
* @public
|
|
1602
1718
|
* <p>Indicated that the S3 Bucket was not found.</p>
|
|
1603
1719
|
*/
|
|
1604
1720
|
Bucket?: string;
|
|
@@ -1618,6 +1734,7 @@ export declare class InvalidSnsTopicException extends __BaseException {
|
|
|
1618
1734
|
readonly name: "InvalidSnsTopicException";
|
|
1619
1735
|
readonly $fault: "client";
|
|
1620
1736
|
/**
|
|
1737
|
+
* @public
|
|
1621
1738
|
* <p>Indicates that the topic does not exist.</p>
|
|
1622
1739
|
*/
|
|
1623
1740
|
Topic?: string;
|
|
@@ -1634,6 +1751,7 @@ export declare class RuleDoesNotExistException extends __BaseException {
|
|
|
1634
1751
|
readonly name: "RuleDoesNotExistException";
|
|
1635
1752
|
readonly $fault: "client";
|
|
1636
1753
|
/**
|
|
1754
|
+
* @public
|
|
1637
1755
|
* <p>Indicates that the named receipt rule does not exist.</p>
|
|
1638
1756
|
*/
|
|
1639
1757
|
Name?: string;
|
|
@@ -1650,6 +1768,7 @@ export declare class RuleDoesNotExistException extends __BaseException {
|
|
|
1650
1768
|
*/
|
|
1651
1769
|
export interface CreateReceiptRuleSetRequest {
|
|
1652
1770
|
/**
|
|
1771
|
+
* @public
|
|
1653
1772
|
* <p>The name of the rule set to create. The name must:</p>
|
|
1654
1773
|
* <ul>
|
|
1655
1774
|
* <li>
|
|
@@ -1679,21 +1798,25 @@ export interface CreateReceiptRuleSetResponse {
|
|
|
1679
1798
|
*/
|
|
1680
1799
|
export interface Template {
|
|
1681
1800
|
/**
|
|
1801
|
+
* @public
|
|
1682
1802
|
* <p>The name of the template. You will refer to this name when you send email using the
|
|
1683
1803
|
* <code>SendTemplatedEmail</code> or <code>SendBulkTemplatedEmail</code>
|
|
1684
1804
|
* operations.</p>
|
|
1685
1805
|
*/
|
|
1686
1806
|
TemplateName: string | undefined;
|
|
1687
1807
|
/**
|
|
1808
|
+
* @public
|
|
1688
1809
|
* <p>The subject line of the email.</p>
|
|
1689
1810
|
*/
|
|
1690
1811
|
SubjectPart?: string;
|
|
1691
1812
|
/**
|
|
1813
|
+
* @public
|
|
1692
1814
|
* <p>The email body that will be visible to recipients whose email clients do not display
|
|
1693
1815
|
* HTML.</p>
|
|
1694
1816
|
*/
|
|
1695
1817
|
TextPart?: string;
|
|
1696
1818
|
/**
|
|
1819
|
+
* @public
|
|
1697
1820
|
* <p>The HTML body of the email.</p>
|
|
1698
1821
|
*/
|
|
1699
1822
|
HtmlPart?: string;
|
|
@@ -1705,6 +1828,7 @@ export interface Template {
|
|
|
1705
1828
|
*/
|
|
1706
1829
|
export interface CreateTemplateRequest {
|
|
1707
1830
|
/**
|
|
1831
|
+
* @public
|
|
1708
1832
|
* <p>The content of the email, composed of a subject line, an HTML part, and a text-only
|
|
1709
1833
|
* part.</p>
|
|
1710
1834
|
*/
|
|
@@ -1749,23 +1873,28 @@ export type CustomMailFromStatus = (typeof CustomMailFromStatus)[keyof typeof Cu
|
|
|
1749
1873
|
*/
|
|
1750
1874
|
export interface CustomVerificationEmailTemplate {
|
|
1751
1875
|
/**
|
|
1876
|
+
* @public
|
|
1752
1877
|
* <p>The name of the custom verification email template.</p>
|
|
1753
1878
|
*/
|
|
1754
1879
|
TemplateName?: string;
|
|
1755
1880
|
/**
|
|
1881
|
+
* @public
|
|
1756
1882
|
* <p>The email address that the custom verification email is sent from.</p>
|
|
1757
1883
|
*/
|
|
1758
1884
|
FromEmailAddress?: string;
|
|
1759
1885
|
/**
|
|
1886
|
+
* @public
|
|
1760
1887
|
* <p>The subject line of the custom verification email.</p>
|
|
1761
1888
|
*/
|
|
1762
1889
|
TemplateSubject?: string;
|
|
1763
1890
|
/**
|
|
1891
|
+
* @public
|
|
1764
1892
|
* <p>The URL that the recipient of the verification email is sent to if his or her address
|
|
1765
1893
|
* is successfully verified.</p>
|
|
1766
1894
|
*/
|
|
1767
1895
|
SuccessRedirectionURL?: string;
|
|
1768
1896
|
/**
|
|
1897
|
+
* @public
|
|
1769
1898
|
* <p>The URL that the recipient of the verification email is sent to if his or her address
|
|
1770
1899
|
* is not successfully verified.</p>
|
|
1771
1900
|
*/
|
|
@@ -1780,6 +1909,7 @@ export declare class CustomVerificationEmailTemplateDoesNotExistException extend
|
|
|
1780
1909
|
readonly name: "CustomVerificationEmailTemplateDoesNotExistException";
|
|
1781
1910
|
readonly $fault: "client";
|
|
1782
1911
|
/**
|
|
1912
|
+
* @public
|
|
1783
1913
|
* <p>Indicates that the provided custom verification email template does not exist.</p>
|
|
1784
1914
|
*/
|
|
1785
1915
|
CustomVerificationEmailTemplateName?: string;
|
|
@@ -1797,6 +1927,7 @@ export declare class CustomVerificationEmailTemplateDoesNotExistException extend
|
|
|
1797
1927
|
*/
|
|
1798
1928
|
export interface DeleteConfigurationSetRequest {
|
|
1799
1929
|
/**
|
|
1930
|
+
* @public
|
|
1800
1931
|
* <p>The name of the configuration set to delete.</p>
|
|
1801
1932
|
*/
|
|
1802
1933
|
ConfigurationSetName: string | undefined;
|
|
@@ -1817,10 +1948,12 @@ export interface DeleteConfigurationSetResponse {
|
|
|
1817
1948
|
*/
|
|
1818
1949
|
export interface DeleteConfigurationSetEventDestinationRequest {
|
|
1819
1950
|
/**
|
|
1951
|
+
* @public
|
|
1820
1952
|
* <p>The name of the configuration set from which to delete the event destination.</p>
|
|
1821
1953
|
*/
|
|
1822
1954
|
ConfigurationSetName: string | undefined;
|
|
1823
1955
|
/**
|
|
1956
|
+
* @public
|
|
1824
1957
|
* <p>The name of the event destination to delete.</p>
|
|
1825
1958
|
*/
|
|
1826
1959
|
EventDestinationName: string | undefined;
|
|
@@ -1839,10 +1972,12 @@ export declare class EventDestinationDoesNotExistException extends __BaseExcepti
|
|
|
1839
1972
|
readonly name: "EventDestinationDoesNotExistException";
|
|
1840
1973
|
readonly $fault: "client";
|
|
1841
1974
|
/**
|
|
1975
|
+
* @public
|
|
1842
1976
|
* <p>Indicates that the configuration set does not exist.</p>
|
|
1843
1977
|
*/
|
|
1844
1978
|
ConfigurationSetName?: string;
|
|
1845
1979
|
/**
|
|
1980
|
+
* @public
|
|
1846
1981
|
* <p>Indicates that the event destination does not exist.</p>
|
|
1847
1982
|
*/
|
|
1848
1983
|
EventDestinationName?: string;
|
|
@@ -1858,6 +1993,7 @@ export declare class EventDestinationDoesNotExistException extends __BaseExcepti
|
|
|
1858
1993
|
*/
|
|
1859
1994
|
export interface DeleteConfigurationSetTrackingOptionsRequest {
|
|
1860
1995
|
/**
|
|
1996
|
+
* @public
|
|
1861
1997
|
* <p>The name of the configuration set from which you want to delete the tracking
|
|
1862
1998
|
* options.</p>
|
|
1863
1999
|
*/
|
|
@@ -1877,6 +2013,7 @@ export declare class TrackingOptionsDoesNotExistException extends __BaseExceptio
|
|
|
1877
2013
|
readonly name: "TrackingOptionsDoesNotExistException";
|
|
1878
2014
|
readonly $fault: "client";
|
|
1879
2015
|
/**
|
|
2016
|
+
* @public
|
|
1880
2017
|
* <p>Indicates that a TrackingOptions object does not exist in the specified configuration
|
|
1881
2018
|
* set.</p>
|
|
1882
2019
|
*/
|
|
@@ -1892,6 +2029,7 @@ export declare class TrackingOptionsDoesNotExistException extends __BaseExceptio
|
|
|
1892
2029
|
*/
|
|
1893
2030
|
export interface DeleteCustomVerificationEmailTemplateRequest {
|
|
1894
2031
|
/**
|
|
2032
|
+
* @public
|
|
1895
2033
|
* <p>The name of the custom verification email template that you want to delete.</p>
|
|
1896
2034
|
*/
|
|
1897
2035
|
TemplateName: string | undefined;
|
|
@@ -1903,6 +2041,7 @@ export interface DeleteCustomVerificationEmailTemplateRequest {
|
|
|
1903
2041
|
*/
|
|
1904
2042
|
export interface DeleteIdentityRequest {
|
|
1905
2043
|
/**
|
|
2044
|
+
* @public
|
|
1906
2045
|
* <p>The identity to be removed from the list of identities for the AWS Account.</p>
|
|
1907
2046
|
*/
|
|
1908
2047
|
Identity: string | undefined;
|
|
@@ -1922,6 +2061,7 @@ export interface DeleteIdentityResponse {
|
|
|
1922
2061
|
*/
|
|
1923
2062
|
export interface DeleteIdentityPolicyRequest {
|
|
1924
2063
|
/**
|
|
2064
|
+
* @public
|
|
1925
2065
|
* <p>The identity that is associated with the policy that you want to delete. You can
|
|
1926
2066
|
* specify the identity by using its name or by using its Amazon Resource Name (ARN).
|
|
1927
2067
|
* Examples: <code>user@example.com</code>, <code>example.com</code>,
|
|
@@ -1930,6 +2070,7 @@ export interface DeleteIdentityPolicyRequest {
|
|
|
1930
2070
|
*/
|
|
1931
2071
|
Identity: string | undefined;
|
|
1932
2072
|
/**
|
|
2073
|
+
* @public
|
|
1933
2074
|
* <p>The name of the policy to be deleted.</p>
|
|
1934
2075
|
*/
|
|
1935
2076
|
PolicyName: string | undefined;
|
|
@@ -1948,6 +2089,7 @@ export interface DeleteIdentityPolicyResponse {
|
|
|
1948
2089
|
*/
|
|
1949
2090
|
export interface DeleteReceiptFilterRequest {
|
|
1950
2091
|
/**
|
|
2092
|
+
* @public
|
|
1951
2093
|
* <p>The name of the IP address filter to delete.</p>
|
|
1952
2094
|
*/
|
|
1953
2095
|
FilterName: string | undefined;
|
|
@@ -1966,10 +2108,12 @@ export interface DeleteReceiptFilterResponse {
|
|
|
1966
2108
|
*/
|
|
1967
2109
|
export interface DeleteReceiptRuleRequest {
|
|
1968
2110
|
/**
|
|
2111
|
+
* @public
|
|
1969
2112
|
* <p>The name of the receipt rule set that contains the receipt rule to delete.</p>
|
|
1970
2113
|
*/
|
|
1971
2114
|
RuleSetName: string | undefined;
|
|
1972
2115
|
/**
|
|
2116
|
+
* @public
|
|
1973
2117
|
* <p>The name of the receipt rule to delete.</p>
|
|
1974
2118
|
*/
|
|
1975
2119
|
RuleName: string | undefined;
|
|
@@ -1989,6 +2133,7 @@ export interface DeleteReceiptRuleResponse {
|
|
|
1989
2133
|
*/
|
|
1990
2134
|
export interface DeleteReceiptRuleSetRequest {
|
|
1991
2135
|
/**
|
|
2136
|
+
* @public
|
|
1992
2137
|
* <p>The name of the receipt rule set to delete.</p>
|
|
1993
2138
|
*/
|
|
1994
2139
|
RuleSetName: string | undefined;
|
|
@@ -2006,6 +2151,7 @@ export interface DeleteReceiptRuleSetResponse {
|
|
|
2006
2151
|
*/
|
|
2007
2152
|
export interface DeleteTemplateRequest {
|
|
2008
2153
|
/**
|
|
2154
|
+
* @public
|
|
2009
2155
|
* <p>The name of the template to be deleted.</p>
|
|
2010
2156
|
*/
|
|
2011
2157
|
TemplateName: string | undefined;
|
|
@@ -2022,6 +2168,7 @@ export interface DeleteTemplateResponse {
|
|
|
2022
2168
|
*/
|
|
2023
2169
|
export interface DeleteVerifiedEmailAddressRequest {
|
|
2024
2170
|
/**
|
|
2171
|
+
* @public
|
|
2025
2172
|
* <p>An email address to be removed from the list of verified addresses.</p>
|
|
2026
2173
|
*/
|
|
2027
2174
|
EmailAddress: string | undefined;
|
|
@@ -2033,6 +2180,7 @@ export interface DeleteVerifiedEmailAddressRequest {
|
|
|
2033
2180
|
*/
|
|
2034
2181
|
export interface DeliveryOptions {
|
|
2035
2182
|
/**
|
|
2183
|
+
* @public
|
|
2036
2184
|
* <p>Specifies whether messages that use the configuration set are required to use
|
|
2037
2185
|
* Transport Layer Security (TLS). If the value is <code>Require</code>, messages are only
|
|
2038
2186
|
* delivered if a TLS connection can be established. If the value is <code>Optional</code>,
|
|
@@ -2059,6 +2207,7 @@ export interface DescribeActiveReceiptRuleSetRequest {
|
|
|
2059
2207
|
*/
|
|
2060
2208
|
export interface ReceiptRuleSetMetadata {
|
|
2061
2209
|
/**
|
|
2210
|
+
* @public
|
|
2062
2211
|
* <p>The name of the receipt rule set. The name must:</p>
|
|
2063
2212
|
* <ul>
|
|
2064
2213
|
* <li>
|
|
@@ -2075,6 +2224,7 @@ export interface ReceiptRuleSetMetadata {
|
|
|
2075
2224
|
*/
|
|
2076
2225
|
Name?: string;
|
|
2077
2226
|
/**
|
|
2227
|
+
* @public
|
|
2078
2228
|
* <p>The date and time the receipt rule set was created.</p>
|
|
2079
2229
|
*/
|
|
2080
2230
|
CreatedTimestamp?: Date;
|
|
@@ -2086,11 +2236,13 @@ export interface ReceiptRuleSetMetadata {
|
|
|
2086
2236
|
*/
|
|
2087
2237
|
export interface DescribeActiveReceiptRuleSetResponse {
|
|
2088
2238
|
/**
|
|
2239
|
+
* @public
|
|
2089
2240
|
* <p>The metadata for the currently active receipt rule set. The metadata consists of the
|
|
2090
2241
|
* rule set name and a timestamp of when the rule set was created.</p>
|
|
2091
2242
|
*/
|
|
2092
2243
|
Metadata?: ReceiptRuleSetMetadata;
|
|
2093
2244
|
/**
|
|
2245
|
+
* @public
|
|
2094
2246
|
* <p>The receipt rules that belong to the active rule set.</p>
|
|
2095
2247
|
*/
|
|
2096
2248
|
Rules?: ReceiptRule[];
|
|
@@ -2104,10 +2256,12 @@ export interface DescribeActiveReceiptRuleSetResponse {
|
|
|
2104
2256
|
*/
|
|
2105
2257
|
export interface DescribeConfigurationSetRequest {
|
|
2106
2258
|
/**
|
|
2259
|
+
* @public
|
|
2107
2260
|
* <p>The name of the configuration set to describe.</p>
|
|
2108
2261
|
*/
|
|
2109
2262
|
ConfigurationSetName: string | undefined;
|
|
2110
2263
|
/**
|
|
2264
|
+
* @public
|
|
2111
2265
|
* <p>A list of configuration set attributes to return.</p>
|
|
2112
2266
|
*/
|
|
2113
2267
|
ConfigurationSetAttributeNames?: (ConfigurationSetAttribute | string)[];
|
|
@@ -2118,6 +2272,7 @@ export interface DescribeConfigurationSetRequest {
|
|
|
2118
2272
|
*/
|
|
2119
2273
|
export interface ReputationOptions {
|
|
2120
2274
|
/**
|
|
2275
|
+
* @public
|
|
2121
2276
|
* <p>Describes whether email sending is enabled or disabled for the configuration set. If
|
|
2122
2277
|
* the value is <code>true</code>, then Amazon SES will send emails that use the configuration
|
|
2123
2278
|
* set. If the value is <code>false</code>, Amazon SES will not send emails that use the
|
|
@@ -2126,6 +2281,7 @@ export interface ReputationOptions {
|
|
|
2126
2281
|
*/
|
|
2127
2282
|
SendingEnabled?: boolean;
|
|
2128
2283
|
/**
|
|
2284
|
+
* @public
|
|
2129
2285
|
* <p>Describes whether or not Amazon SES publishes reputation metrics for the configuration set,
|
|
2130
2286
|
* such as bounce and complaint rates, to Amazon CloudWatch.</p>
|
|
2131
2287
|
* <p>If the value is <code>true</code>, reputation metrics are published. If the value is
|
|
@@ -2134,6 +2290,7 @@ export interface ReputationOptions {
|
|
|
2134
2290
|
*/
|
|
2135
2291
|
ReputationMetricsEnabled?: boolean;
|
|
2136
2292
|
/**
|
|
2293
|
+
* @public
|
|
2137
2294
|
* <p>The date and time at which the reputation metrics for the configuration set were last
|
|
2138
2295
|
* reset. Resetting these metrics is known as a <i>fresh start</i>.</p>
|
|
2139
2296
|
* <p>When you disable email sending for a configuration set using <a>UpdateConfigurationSetSendingEnabled</a> and later re-enable it, the
|
|
@@ -2153,24 +2310,29 @@ export interface ReputationOptions {
|
|
|
2153
2310
|
*/
|
|
2154
2311
|
export interface DescribeConfigurationSetResponse {
|
|
2155
2312
|
/**
|
|
2313
|
+
* @public
|
|
2156
2314
|
* <p>The configuration set object associated with the specified configuration set.</p>
|
|
2157
2315
|
*/
|
|
2158
2316
|
ConfigurationSet?: ConfigurationSet;
|
|
2159
2317
|
/**
|
|
2318
|
+
* @public
|
|
2160
2319
|
* <p>A list of event destinations associated with the configuration set. </p>
|
|
2161
2320
|
*/
|
|
2162
2321
|
EventDestinations?: EventDestination[];
|
|
2163
2322
|
/**
|
|
2323
|
+
* @public
|
|
2164
2324
|
* <p>The name of the custom open and click tracking domain associated with the
|
|
2165
2325
|
* configuration set.</p>
|
|
2166
2326
|
*/
|
|
2167
2327
|
TrackingOptions?: TrackingOptions;
|
|
2168
2328
|
/**
|
|
2329
|
+
* @public
|
|
2169
2330
|
* <p>Specifies whether messages that use the configuration set are required to use
|
|
2170
2331
|
* Transport Layer Security (TLS).</p>
|
|
2171
2332
|
*/
|
|
2172
2333
|
DeliveryOptions?: DeliveryOptions;
|
|
2173
2334
|
/**
|
|
2335
|
+
* @public
|
|
2174
2336
|
* <p>An object that represents the reputation settings for the configuration set. </p>
|
|
2175
2337
|
*/
|
|
2176
2338
|
ReputationOptions?: ReputationOptions;
|
|
@@ -2183,10 +2345,12 @@ export interface DescribeConfigurationSetResponse {
|
|
|
2183
2345
|
*/
|
|
2184
2346
|
export interface DescribeReceiptRuleRequest {
|
|
2185
2347
|
/**
|
|
2348
|
+
* @public
|
|
2186
2349
|
* <p>The name of the receipt rule set that the receipt rule belongs to.</p>
|
|
2187
2350
|
*/
|
|
2188
2351
|
RuleSetName: string | undefined;
|
|
2189
2352
|
/**
|
|
2353
|
+
* @public
|
|
2190
2354
|
* <p>The name of the receipt rule.</p>
|
|
2191
2355
|
*/
|
|
2192
2356
|
RuleName: string | undefined;
|
|
@@ -2197,6 +2361,7 @@ export interface DescribeReceiptRuleRequest {
|
|
|
2197
2361
|
*/
|
|
2198
2362
|
export interface DescribeReceiptRuleResponse {
|
|
2199
2363
|
/**
|
|
2364
|
+
* @public
|
|
2200
2365
|
* <p>A data structure that contains the specified receipt rule's name, actions, recipients,
|
|
2201
2366
|
* domains, enabled status, scan status, and Transport Layer Security (TLS) policy.</p>
|
|
2202
2367
|
*/
|
|
@@ -2209,6 +2374,7 @@ export interface DescribeReceiptRuleResponse {
|
|
|
2209
2374
|
*/
|
|
2210
2375
|
export interface DescribeReceiptRuleSetRequest {
|
|
2211
2376
|
/**
|
|
2377
|
+
* @public
|
|
2212
2378
|
* <p>The name of the receipt rule set to describe.</p>
|
|
2213
2379
|
*/
|
|
2214
2380
|
RuleSetName: string | undefined;
|
|
@@ -2219,11 +2385,13 @@ export interface DescribeReceiptRuleSetRequest {
|
|
|
2219
2385
|
*/
|
|
2220
2386
|
export interface DescribeReceiptRuleSetResponse {
|
|
2221
2387
|
/**
|
|
2388
|
+
* @public
|
|
2222
2389
|
* <p>The metadata for the receipt rule set, which consists of the rule set name and the
|
|
2223
2390
|
* timestamp of when the rule set was created.</p>
|
|
2224
2391
|
*/
|
|
2225
2392
|
Metadata?: ReceiptRuleSetMetadata;
|
|
2226
2393
|
/**
|
|
2394
|
+
* @public
|
|
2227
2395
|
* <p>A list of the receipt rules that belong to the specified receipt rule set.</p>
|
|
2228
2396
|
*/
|
|
2229
2397
|
Rules?: ReceiptRule[];
|
|
@@ -2238,17 +2406,20 @@ export type VerificationStatus = "Failed" | "NotStarted" | "Pending" | "Success"
|
|
|
2238
2406
|
*/
|
|
2239
2407
|
export interface IdentityDkimAttributes {
|
|
2240
2408
|
/**
|
|
2409
|
+
* @public
|
|
2241
2410
|
* <p>Is true if DKIM signing is enabled for email sent from the identity. It's false
|
|
2242
2411
|
* otherwise. The default value is true.</p>
|
|
2243
2412
|
*/
|
|
2244
2413
|
DkimEnabled: boolean | undefined;
|
|
2245
2414
|
/**
|
|
2415
|
+
* @public
|
|
2246
2416
|
* <p>Describes whether Amazon SES has successfully verified the DKIM DNS records (tokens)
|
|
2247
2417
|
* published in the domain name's DNS. (This only applies to domain identities, not email
|
|
2248
2418
|
* address identities.)</p>
|
|
2249
2419
|
*/
|
|
2250
2420
|
DkimVerificationStatus: VerificationStatus | string | undefined;
|
|
2251
2421
|
/**
|
|
2422
|
+
* @public
|
|
2252
2423
|
* <p>A set of character strings that represent the domain's identity. Using these tokens,
|
|
2253
2424
|
* you need to create DNS CNAME records that point to DKIM public keys that are hosted by
|
|
2254
2425
|
* Amazon SES. Amazon Web Services eventually detects that you've updated your DNS records. This detection
|
|
@@ -2267,6 +2438,7 @@ export interface IdentityDkimAttributes {
|
|
|
2267
2438
|
*/
|
|
2268
2439
|
export interface GetAccountSendingEnabledResponse {
|
|
2269
2440
|
/**
|
|
2441
|
+
* @public
|
|
2270
2442
|
* <p>Describes whether email sending is enabled or disabled for your Amazon SES account in the
|
|
2271
2443
|
* current AWS Region.</p>
|
|
2272
2444
|
*/
|
|
@@ -2279,6 +2451,7 @@ export interface GetAccountSendingEnabledResponse {
|
|
|
2279
2451
|
*/
|
|
2280
2452
|
export interface GetCustomVerificationEmailTemplateRequest {
|
|
2281
2453
|
/**
|
|
2454
|
+
* @public
|
|
2282
2455
|
* <p>The name of the custom verification email template that you want to retrieve.</p>
|
|
2283
2456
|
*/
|
|
2284
2457
|
TemplateName: string | undefined;
|
|
@@ -2289,27 +2462,33 @@ export interface GetCustomVerificationEmailTemplateRequest {
|
|
|
2289
2462
|
*/
|
|
2290
2463
|
export interface GetCustomVerificationEmailTemplateResponse {
|
|
2291
2464
|
/**
|
|
2465
|
+
* @public
|
|
2292
2466
|
* <p>The name of the custom verification email template.</p>
|
|
2293
2467
|
*/
|
|
2294
2468
|
TemplateName?: string;
|
|
2295
2469
|
/**
|
|
2470
|
+
* @public
|
|
2296
2471
|
* <p>The email address that the custom verification email is sent from.</p>
|
|
2297
2472
|
*/
|
|
2298
2473
|
FromEmailAddress?: string;
|
|
2299
2474
|
/**
|
|
2475
|
+
* @public
|
|
2300
2476
|
* <p>The subject line of the custom verification email.</p>
|
|
2301
2477
|
*/
|
|
2302
2478
|
TemplateSubject?: string;
|
|
2303
2479
|
/**
|
|
2480
|
+
* @public
|
|
2304
2481
|
* <p>The content of the custom verification email.</p>
|
|
2305
2482
|
*/
|
|
2306
2483
|
TemplateContent?: string;
|
|
2307
2484
|
/**
|
|
2485
|
+
* @public
|
|
2308
2486
|
* <p>The URL that the recipient of the verification email is sent to if his or her address
|
|
2309
2487
|
* is successfully verified.</p>
|
|
2310
2488
|
*/
|
|
2311
2489
|
SuccessRedirectionURL?: string;
|
|
2312
2490
|
/**
|
|
2491
|
+
* @public
|
|
2313
2492
|
* <p>The URL that the recipient of the verification email is sent to if his or her address
|
|
2314
2493
|
* is not successfully verified.</p>
|
|
2315
2494
|
*/
|
|
@@ -2324,6 +2503,7 @@ export interface GetCustomVerificationEmailTemplateResponse {
|
|
|
2324
2503
|
*/
|
|
2325
2504
|
export interface GetIdentityDkimAttributesRequest {
|
|
2326
2505
|
/**
|
|
2506
|
+
* @public
|
|
2327
2507
|
* <p>A list of one or more verified identities - email addresses, domains, or both.</p>
|
|
2328
2508
|
*/
|
|
2329
2509
|
Identities: string[] | undefined;
|
|
@@ -2337,6 +2517,7 @@ export interface GetIdentityDkimAttributesRequest {
|
|
|
2337
2517
|
*/
|
|
2338
2518
|
export interface GetIdentityDkimAttributesResponse {
|
|
2339
2519
|
/**
|
|
2520
|
+
* @public
|
|
2340
2521
|
* <p>The DKIM attributes for an email address or a domain.</p>
|
|
2341
2522
|
*/
|
|
2342
2523
|
DkimAttributes: Record<string, IdentityDkimAttributes> | undefined;
|
|
@@ -2349,6 +2530,7 @@ export interface GetIdentityDkimAttributesResponse {
|
|
|
2349
2530
|
*/
|
|
2350
2531
|
export interface GetIdentityMailFromDomainAttributesRequest {
|
|
2351
2532
|
/**
|
|
2533
|
+
* @public
|
|
2352
2534
|
* <p>A list of one or more identities.</p>
|
|
2353
2535
|
*/
|
|
2354
2536
|
Identities: string[] | undefined;
|
|
@@ -2360,10 +2542,12 @@ export interface GetIdentityMailFromDomainAttributesRequest {
|
|
|
2360
2542
|
*/
|
|
2361
2543
|
export interface IdentityMailFromDomainAttributes {
|
|
2362
2544
|
/**
|
|
2545
|
+
* @public
|
|
2363
2546
|
* <p>The custom MAIL FROM domain that the identity is configured to use.</p>
|
|
2364
2547
|
*/
|
|
2365
2548
|
MailFromDomain: string | undefined;
|
|
2366
2549
|
/**
|
|
2550
|
+
* @public
|
|
2367
2551
|
* <p>The state that indicates whether Amazon SES has successfully read the MX record required
|
|
2368
2552
|
* for custom MAIL FROM domain setup. If the state is <code>Success</code>, Amazon SES uses the
|
|
2369
2553
|
* specified custom MAIL FROM domain when the verified identity sends an email. All other
|
|
@@ -2372,6 +2556,7 @@ export interface IdentityMailFromDomainAttributes {
|
|
|
2372
2556
|
*/
|
|
2373
2557
|
MailFromDomainStatus: CustomMailFromStatus | string | undefined;
|
|
2374
2558
|
/**
|
|
2559
|
+
* @public
|
|
2375
2560
|
* <p>The action that Amazon SES takes if it cannot successfully read the required MX record when
|
|
2376
2561
|
* you send an email. A value of <code>UseDefaultValue</code> indicates that if Amazon SES
|
|
2377
2562
|
* cannot read the required MX record, it uses amazonses.com (or a subdomain of that) as
|
|
@@ -2389,6 +2574,7 @@ export interface IdentityMailFromDomainAttributes {
|
|
|
2389
2574
|
*/
|
|
2390
2575
|
export interface GetIdentityMailFromDomainAttributesResponse {
|
|
2391
2576
|
/**
|
|
2577
|
+
* @public
|
|
2392
2578
|
* <p>A map of identities to custom MAIL FROM attributes.</p>
|
|
2393
2579
|
*/
|
|
2394
2580
|
MailFromDomainAttributes: Record<string, IdentityMailFromDomainAttributes> | undefined;
|
|
@@ -2401,6 +2587,7 @@ export interface GetIdentityMailFromDomainAttributesResponse {
|
|
|
2401
2587
|
*/
|
|
2402
2588
|
export interface GetIdentityNotificationAttributesRequest {
|
|
2403
2589
|
/**
|
|
2590
|
+
* @public
|
|
2404
2591
|
* <p>A list of one or more identities. You can specify an identity by using its name or by
|
|
2405
2592
|
* using its Amazon Resource Name (ARN). Examples: <code>user@example.com</code>,
|
|
2406
2593
|
* <code>example.com</code>,
|
|
@@ -2417,21 +2604,25 @@ export interface GetIdentityNotificationAttributesRequest {
|
|
|
2417
2604
|
*/
|
|
2418
2605
|
export interface IdentityNotificationAttributes {
|
|
2419
2606
|
/**
|
|
2607
|
+
* @public
|
|
2420
2608
|
* <p>The Amazon Resource Name (ARN) of the Amazon SNS topic where Amazon SES will publish bounce
|
|
2421
2609
|
* notifications.</p>
|
|
2422
2610
|
*/
|
|
2423
2611
|
BounceTopic: string | undefined;
|
|
2424
2612
|
/**
|
|
2613
|
+
* @public
|
|
2425
2614
|
* <p>The Amazon Resource Name (ARN) of the Amazon SNS topic where Amazon SES will publish complaint
|
|
2426
2615
|
* notifications.</p>
|
|
2427
2616
|
*/
|
|
2428
2617
|
ComplaintTopic: string | undefined;
|
|
2429
2618
|
/**
|
|
2619
|
+
* @public
|
|
2430
2620
|
* <p>The Amazon Resource Name (ARN) of the Amazon SNS topic where Amazon SES will publish delivery
|
|
2431
2621
|
* notifications.</p>
|
|
2432
2622
|
*/
|
|
2433
2623
|
DeliveryTopic: string | undefined;
|
|
2434
2624
|
/**
|
|
2625
|
+
* @public
|
|
2435
2626
|
* <p>Describes whether Amazon SES will forward bounce and complaint notifications as email.
|
|
2436
2627
|
* <code>true</code> indicates that Amazon SES will forward bounce and complaint
|
|
2437
2628
|
* notifications as email, while <code>false</code> indicates that bounce and complaint
|
|
@@ -2440,6 +2631,7 @@ export interface IdentityNotificationAttributes {
|
|
|
2440
2631
|
*/
|
|
2441
2632
|
ForwardingEnabled: boolean | undefined;
|
|
2442
2633
|
/**
|
|
2634
|
+
* @public
|
|
2443
2635
|
* <p>Describes whether Amazon SES includes the original email headers in Amazon SNS notifications of
|
|
2444
2636
|
* type <code>Bounce</code>. A value of <code>true</code> specifies that Amazon SES will include
|
|
2445
2637
|
* headers in bounce notifications, and a value of <code>false</code> specifies that Amazon SES
|
|
@@ -2447,6 +2639,7 @@ export interface IdentityNotificationAttributes {
|
|
|
2447
2639
|
*/
|
|
2448
2640
|
HeadersInBounceNotificationsEnabled?: boolean;
|
|
2449
2641
|
/**
|
|
2642
|
+
* @public
|
|
2450
2643
|
* <p>Describes whether Amazon SES includes the original email headers in Amazon SNS notifications of
|
|
2451
2644
|
* type <code>Complaint</code>. A value of <code>true</code> specifies that Amazon SES will
|
|
2452
2645
|
* include headers in complaint notifications, and a value of <code>false</code> specifies
|
|
@@ -2454,6 +2647,7 @@ export interface IdentityNotificationAttributes {
|
|
|
2454
2647
|
*/
|
|
2455
2648
|
HeadersInComplaintNotificationsEnabled?: boolean;
|
|
2456
2649
|
/**
|
|
2650
|
+
* @public
|
|
2457
2651
|
* <p>Describes whether Amazon SES includes the original email headers in Amazon SNS notifications of
|
|
2458
2652
|
* type <code>Delivery</code>. A value of <code>true</code> specifies that Amazon SES will
|
|
2459
2653
|
* include headers in delivery notifications, and a value of <code>false</code> specifies
|
|
@@ -2467,6 +2661,7 @@ export interface IdentityNotificationAttributes {
|
|
|
2467
2661
|
*/
|
|
2468
2662
|
export interface GetIdentityNotificationAttributesResponse {
|
|
2469
2663
|
/**
|
|
2664
|
+
* @public
|
|
2470
2665
|
* <p>A map of Identity to IdentityNotificationAttributes.</p>
|
|
2471
2666
|
*/
|
|
2472
2667
|
NotificationAttributes: Record<string, IdentityNotificationAttributes> | undefined;
|
|
@@ -2480,6 +2675,7 @@ export interface GetIdentityNotificationAttributesResponse {
|
|
|
2480
2675
|
*/
|
|
2481
2676
|
export interface GetIdentityPoliciesRequest {
|
|
2482
2677
|
/**
|
|
2678
|
+
* @public
|
|
2483
2679
|
* <p>The identity for which the policies will be retrieved. You can specify an identity by
|
|
2484
2680
|
* using its name or by using its Amazon Resource Name (ARN). Examples:
|
|
2485
2681
|
* <code>user@example.com</code>, <code>example.com</code>,
|
|
@@ -2488,6 +2684,7 @@ export interface GetIdentityPoliciesRequest {
|
|
|
2488
2684
|
*/
|
|
2489
2685
|
Identity: string | undefined;
|
|
2490
2686
|
/**
|
|
2687
|
+
* @public
|
|
2491
2688
|
* <p>A list of the names of policies to be retrieved. You can retrieve a maximum of 20
|
|
2492
2689
|
* policies at a time. If you do not know the names of the policies that are attached to
|
|
2493
2690
|
* the identity, you can use <code>ListIdentityPolicies</code>.</p>
|
|
@@ -2500,6 +2697,7 @@ export interface GetIdentityPoliciesRequest {
|
|
|
2500
2697
|
*/
|
|
2501
2698
|
export interface GetIdentityPoliciesResponse {
|
|
2502
2699
|
/**
|
|
2700
|
+
* @public
|
|
2503
2701
|
* <p>A map of policy names to policies.</p>
|
|
2504
2702
|
*/
|
|
2505
2703
|
Policies: Record<string, string> | undefined;
|
|
@@ -2513,6 +2711,7 @@ export interface GetIdentityPoliciesResponse {
|
|
|
2513
2711
|
*/
|
|
2514
2712
|
export interface GetIdentityVerificationAttributesRequest {
|
|
2515
2713
|
/**
|
|
2714
|
+
* @public
|
|
2516
2715
|
* <p>A list of identities.</p>
|
|
2517
2716
|
*/
|
|
2518
2717
|
Identities: string[] | undefined;
|
|
@@ -2523,11 +2722,13 @@ export interface GetIdentityVerificationAttributesRequest {
|
|
|
2523
2722
|
*/
|
|
2524
2723
|
export interface IdentityVerificationAttributes {
|
|
2525
2724
|
/**
|
|
2725
|
+
* @public
|
|
2526
2726
|
* <p>The verification status of the identity: "Pending", "Success", "Failed", or
|
|
2527
2727
|
* "TemporaryFailure".</p>
|
|
2528
2728
|
*/
|
|
2529
2729
|
VerificationStatus: VerificationStatus | string | undefined;
|
|
2530
2730
|
/**
|
|
2731
|
+
* @public
|
|
2531
2732
|
* <p>The verification token for a domain identity. Null for email address
|
|
2532
2733
|
* identities.</p>
|
|
2533
2734
|
*/
|
|
@@ -2540,6 +2741,7 @@ export interface IdentityVerificationAttributes {
|
|
|
2540
2741
|
*/
|
|
2541
2742
|
export interface GetIdentityVerificationAttributesResponse {
|
|
2542
2743
|
/**
|
|
2744
|
+
* @public
|
|
2543
2745
|
* <p>A map of Identities to IdentityVerificationAttributes objects.</p>
|
|
2544
2746
|
*/
|
|
2545
2747
|
VerificationAttributes: Record<string, IdentityVerificationAttributes> | undefined;
|
|
@@ -2551,11 +2753,13 @@ export interface GetIdentityVerificationAttributesResponse {
|
|
|
2551
2753
|
*/
|
|
2552
2754
|
export interface GetSendQuotaResponse {
|
|
2553
2755
|
/**
|
|
2756
|
+
* @public
|
|
2554
2757
|
* <p>The maximum number of emails the user is allowed to send in a 24-hour interval. A
|
|
2555
2758
|
* value of -1 signifies an unlimited quota.</p>
|
|
2556
2759
|
*/
|
|
2557
2760
|
Max24HourSend?: number;
|
|
2558
2761
|
/**
|
|
2762
|
+
* @public
|
|
2559
2763
|
* <p>The maximum number of emails that Amazon SES can accept from the user's account per
|
|
2560
2764
|
* second.</p>
|
|
2561
2765
|
* <note>
|
|
@@ -2565,6 +2769,7 @@ export interface GetSendQuotaResponse {
|
|
|
2565
2769
|
*/
|
|
2566
2770
|
MaxSendRate?: number;
|
|
2567
2771
|
/**
|
|
2772
|
+
* @public
|
|
2568
2773
|
* <p>The number of emails sent during the previous 24 hours.</p>
|
|
2569
2774
|
*/
|
|
2570
2775
|
SentLast24Hours?: number;
|
|
@@ -2576,22 +2781,27 @@ export interface GetSendQuotaResponse {
|
|
|
2576
2781
|
*/
|
|
2577
2782
|
export interface SendDataPoint {
|
|
2578
2783
|
/**
|
|
2784
|
+
* @public
|
|
2579
2785
|
* <p>Time of the data point.</p>
|
|
2580
2786
|
*/
|
|
2581
2787
|
Timestamp?: Date;
|
|
2582
2788
|
/**
|
|
2789
|
+
* @public
|
|
2583
2790
|
* <p>Number of emails that have been sent.</p>
|
|
2584
2791
|
*/
|
|
2585
2792
|
DeliveryAttempts?: number;
|
|
2586
2793
|
/**
|
|
2794
|
+
* @public
|
|
2587
2795
|
* <p>Number of emails that have bounced.</p>
|
|
2588
2796
|
*/
|
|
2589
2797
|
Bounces?: number;
|
|
2590
2798
|
/**
|
|
2799
|
+
* @public
|
|
2591
2800
|
* <p>Number of unwanted emails that were rejected by recipients.</p>
|
|
2592
2801
|
*/
|
|
2593
2802
|
Complaints?: number;
|
|
2594
2803
|
/**
|
|
2804
|
+
* @public
|
|
2595
2805
|
* <p>Number of emails rejected by Amazon SES.</p>
|
|
2596
2806
|
*/
|
|
2597
2807
|
Rejects?: number;
|
|
@@ -2603,6 +2813,7 @@ export interface SendDataPoint {
|
|
|
2603
2813
|
*/
|
|
2604
2814
|
export interface GetSendStatisticsResponse {
|
|
2605
2815
|
/**
|
|
2816
|
+
* @public
|
|
2606
2817
|
* <p>A list of data points, each of which represents 15 minutes of activity.</p>
|
|
2607
2818
|
*/
|
|
2608
2819
|
SendDataPoints?: SendDataPoint[];
|
|
@@ -2612,6 +2823,7 @@ export interface GetSendStatisticsResponse {
|
|
|
2612
2823
|
*/
|
|
2613
2824
|
export interface GetTemplateRequest {
|
|
2614
2825
|
/**
|
|
2826
|
+
* @public
|
|
2615
2827
|
* <p>The name of the template you want to retrieve.</p>
|
|
2616
2828
|
*/
|
|
2617
2829
|
TemplateName: string | undefined;
|
|
@@ -2621,6 +2833,7 @@ export interface GetTemplateRequest {
|
|
|
2621
2833
|
*/
|
|
2622
2834
|
export interface GetTemplateResponse {
|
|
2623
2835
|
/**
|
|
2836
|
+
* @public
|
|
2624
2837
|
* <p>The content of the email, composed of a subject line, an HTML part, and a text-only
|
|
2625
2838
|
* part.</p>
|
|
2626
2839
|
*/
|
|
@@ -2692,11 +2905,13 @@ export declare class InvalidRenderingParameterException extends __BaseException
|
|
|
2692
2905
|
*/
|
|
2693
2906
|
export interface ListConfigurationSetsRequest {
|
|
2694
2907
|
/**
|
|
2908
|
+
* @public
|
|
2695
2909
|
* <p>A token returned from a previous call to <code>ListConfigurationSets</code> to
|
|
2696
2910
|
* indicate the position of the configuration set in the configuration set list.</p>
|
|
2697
2911
|
*/
|
|
2698
2912
|
NextToken?: string;
|
|
2699
2913
|
/**
|
|
2914
|
+
* @public
|
|
2700
2915
|
* <p>The number of configuration sets to return.</p>
|
|
2701
2916
|
*/
|
|
2702
2917
|
MaxItems?: number;
|
|
@@ -2710,10 +2925,12 @@ export interface ListConfigurationSetsRequest {
|
|
|
2710
2925
|
*/
|
|
2711
2926
|
export interface ListConfigurationSetsResponse {
|
|
2712
2927
|
/**
|
|
2928
|
+
* @public
|
|
2713
2929
|
* <p>A list of configuration sets.</p>
|
|
2714
2930
|
*/
|
|
2715
2931
|
ConfigurationSets?: ConfigurationSet[];
|
|
2716
2932
|
/**
|
|
2933
|
+
* @public
|
|
2717
2934
|
* <p>A token indicating that there are additional configuration sets available to be
|
|
2718
2935
|
* listed. Pass this token to successive calls of <code>ListConfigurationSets</code>.
|
|
2719
2936
|
* </p>
|
|
@@ -2730,11 +2947,13 @@ export interface ListConfigurationSetsResponse {
|
|
|
2730
2947
|
*/
|
|
2731
2948
|
export interface ListCustomVerificationEmailTemplatesRequest {
|
|
2732
2949
|
/**
|
|
2950
|
+
* @public
|
|
2733
2951
|
* <p>An array the contains the name and creation time stamp for each template in your Amazon SES
|
|
2734
2952
|
* account.</p>
|
|
2735
2953
|
*/
|
|
2736
2954
|
NextToken?: string;
|
|
2737
2955
|
/**
|
|
2956
|
+
* @public
|
|
2738
2957
|
* <p>The maximum number of custom verification email templates to return. This value must
|
|
2739
2958
|
* be at least 1 and less than or equal to 50. If you do not specify a value, or if you
|
|
2740
2959
|
* specify a value less than 1 or greater than 50, the operation will return up to 50
|
|
@@ -2748,10 +2967,12 @@ export interface ListCustomVerificationEmailTemplatesRequest {
|
|
|
2748
2967
|
*/
|
|
2749
2968
|
export interface ListCustomVerificationEmailTemplatesResponse {
|
|
2750
2969
|
/**
|
|
2970
|
+
* @public
|
|
2751
2971
|
* <p>A list of the custom verification email templates that exist in your account.</p>
|
|
2752
2972
|
*/
|
|
2753
2973
|
CustomVerificationEmailTemplates?: CustomVerificationEmailTemplate[];
|
|
2754
2974
|
/**
|
|
2975
|
+
* @public
|
|
2755
2976
|
* <p>A token indicating that there are additional custom verification email templates
|
|
2756
2977
|
* available to be listed. Pass this token to a subsequent call to
|
|
2757
2978
|
* <code>ListTemplates</code> to retrieve the next 50 custom verification email
|
|
@@ -2767,15 +2988,18 @@ export interface ListCustomVerificationEmailTemplatesResponse {
|
|
|
2767
2988
|
*/
|
|
2768
2989
|
export interface ListIdentitiesRequest {
|
|
2769
2990
|
/**
|
|
2991
|
+
* @public
|
|
2770
2992
|
* <p>The type of the identities to list. Possible values are "EmailAddress" and "Domain".
|
|
2771
2993
|
* If this parameter is omitted, then all identities will be listed.</p>
|
|
2772
2994
|
*/
|
|
2773
2995
|
IdentityType?: IdentityType | string;
|
|
2774
2996
|
/**
|
|
2997
|
+
* @public
|
|
2775
2998
|
* <p>The token to use for pagination.</p>
|
|
2776
2999
|
*/
|
|
2777
3000
|
NextToken?: string;
|
|
2778
3001
|
/**
|
|
3002
|
+
* @public
|
|
2779
3003
|
* <p>The maximum number of identities per page. Possible values are 1-1000
|
|
2780
3004
|
* inclusive.</p>
|
|
2781
3005
|
*/
|
|
@@ -2788,10 +3012,12 @@ export interface ListIdentitiesRequest {
|
|
|
2788
3012
|
*/
|
|
2789
3013
|
export interface ListIdentitiesResponse {
|
|
2790
3014
|
/**
|
|
3015
|
+
* @public
|
|
2791
3016
|
* <p>A list of identities.</p>
|
|
2792
3017
|
*/
|
|
2793
3018
|
Identities: string[] | undefined;
|
|
2794
3019
|
/**
|
|
3020
|
+
* @public
|
|
2795
3021
|
* <p>The token used for pagination.</p>
|
|
2796
3022
|
*/
|
|
2797
3023
|
NextToken?: string;
|
|
@@ -2804,6 +3030,7 @@ export interface ListIdentitiesResponse {
|
|
|
2804
3030
|
*/
|
|
2805
3031
|
export interface ListIdentityPoliciesRequest {
|
|
2806
3032
|
/**
|
|
3033
|
+
* @public
|
|
2807
3034
|
* <p>The identity that is associated with the policy for which the policies will be listed.
|
|
2808
3035
|
* You can specify an identity by using its name or by using its Amazon Resource Name
|
|
2809
3036
|
* (ARN). Examples: <code>user@example.com</code>, <code>example.com</code>,
|
|
@@ -2818,6 +3045,7 @@ export interface ListIdentityPoliciesRequest {
|
|
|
2818
3045
|
*/
|
|
2819
3046
|
export interface ListIdentityPoliciesResponse {
|
|
2820
3047
|
/**
|
|
3048
|
+
* @public
|
|
2821
3049
|
* <p>A list of names of policies that apply to the specified identity.</p>
|
|
2822
3050
|
*/
|
|
2823
3051
|
PolicyNames: string[] | undefined;
|
|
@@ -2837,6 +3065,7 @@ export interface ListReceiptFiltersRequest {
|
|
|
2837
3065
|
*/
|
|
2838
3066
|
export interface ListReceiptFiltersResponse {
|
|
2839
3067
|
/**
|
|
3068
|
+
* @public
|
|
2840
3069
|
* <p>A list of IP address filter data structures, which each consist of a name, an IP
|
|
2841
3070
|
* address range, and whether to allow or block mail from it.</p>
|
|
2842
3071
|
*/
|
|
@@ -2851,6 +3080,7 @@ export interface ListReceiptFiltersResponse {
|
|
|
2851
3080
|
*/
|
|
2852
3081
|
export interface ListReceiptRuleSetsRequest {
|
|
2853
3082
|
/**
|
|
3083
|
+
* @public
|
|
2854
3084
|
* <p>A token returned from a previous call to <code>ListReceiptRuleSets</code> to indicate
|
|
2855
3085
|
* the position in the receipt rule set list.</p>
|
|
2856
3086
|
*/
|
|
@@ -2862,11 +3092,13 @@ export interface ListReceiptRuleSetsRequest {
|
|
|
2862
3092
|
*/
|
|
2863
3093
|
export interface ListReceiptRuleSetsResponse {
|
|
2864
3094
|
/**
|
|
3095
|
+
* @public
|
|
2865
3096
|
* <p>The metadata for the currently active receipt rule set. The metadata consists of the
|
|
2866
3097
|
* rule set name and the timestamp of when the rule set was created.</p>
|
|
2867
3098
|
*/
|
|
2868
3099
|
RuleSets?: ReceiptRuleSetMetadata[];
|
|
2869
3100
|
/**
|
|
3101
|
+
* @public
|
|
2870
3102
|
* <p>A token indicating that there are additional receipt rule sets available to be listed.
|
|
2871
3103
|
* Pass this token to successive calls of <code>ListReceiptRuleSets</code> to retrieve up
|
|
2872
3104
|
* to 100 receipt rule sets at a time.</p>
|
|
@@ -2878,11 +3110,13 @@ export interface ListReceiptRuleSetsResponse {
|
|
|
2878
3110
|
*/
|
|
2879
3111
|
export interface ListTemplatesRequest {
|
|
2880
3112
|
/**
|
|
3113
|
+
* @public
|
|
2881
3114
|
* <p>A token returned from a previous call to <code>ListTemplates</code> to indicate the
|
|
2882
3115
|
* position in the list of email templates.</p>
|
|
2883
3116
|
*/
|
|
2884
3117
|
NextToken?: string;
|
|
2885
3118
|
/**
|
|
3119
|
+
* @public
|
|
2886
3120
|
* <p>The maximum number of templates to return. This value must be at least 1 and less than
|
|
2887
3121
|
* or equal to 10. If you do not specify a value, or if you specify a value less than 1 or
|
|
2888
3122
|
* greater than 10, the operation will return up to 10 results.</p>
|
|
@@ -2895,10 +3129,12 @@ export interface ListTemplatesRequest {
|
|
|
2895
3129
|
*/
|
|
2896
3130
|
export interface TemplateMetadata {
|
|
2897
3131
|
/**
|
|
3132
|
+
* @public
|
|
2898
3133
|
* <p>The name of the template.</p>
|
|
2899
3134
|
*/
|
|
2900
3135
|
Name?: string;
|
|
2901
3136
|
/**
|
|
3137
|
+
* @public
|
|
2902
3138
|
* <p>The time and date the template was created.</p>
|
|
2903
3139
|
*/
|
|
2904
3140
|
CreatedTimestamp?: Date;
|
|
@@ -2908,11 +3144,13 @@ export interface TemplateMetadata {
|
|
|
2908
3144
|
*/
|
|
2909
3145
|
export interface ListTemplatesResponse {
|
|
2910
3146
|
/**
|
|
3147
|
+
* @public
|
|
2911
3148
|
* <p>An array the contains the name and creation time stamp for each template in your Amazon SES
|
|
2912
3149
|
* account.</p>
|
|
2913
3150
|
*/
|
|
2914
3151
|
TemplatesMetadata?: TemplateMetadata[];
|
|
2915
3152
|
/**
|
|
3153
|
+
* @public
|
|
2916
3154
|
* <p>A token indicating that there are additional email templates available to be listed.
|
|
2917
3155
|
* Pass this token to a subsequent call to <code>ListTemplates</code> to retrieve the next
|
|
2918
3156
|
* 50 email templates.</p>
|
|
@@ -2926,6 +3164,7 @@ export interface ListTemplatesResponse {
|
|
|
2926
3164
|
*/
|
|
2927
3165
|
export interface ListVerifiedEmailAddressesResponse {
|
|
2928
3166
|
/**
|
|
3167
|
+
* @public
|
|
2929
3168
|
* <p>A list of email addresses that have been verified.</p>
|
|
2930
3169
|
*/
|
|
2931
3170
|
VerifiedEmailAddresses?: string[];
|
|
@@ -2951,11 +3190,13 @@ export declare class MailFromDomainNotVerifiedException extends __BaseException
|
|
|
2951
3190
|
*/
|
|
2952
3191
|
export interface Message {
|
|
2953
3192
|
/**
|
|
3193
|
+
* @public
|
|
2954
3194
|
* <p>The subject of the message: A short summary of the content, which will appear in the
|
|
2955
3195
|
* recipient's inbox.</p>
|
|
2956
3196
|
*/
|
|
2957
3197
|
Subject: Content | undefined;
|
|
2958
3198
|
/**
|
|
3199
|
+
* @public
|
|
2959
3200
|
* <p>The message body.</p>
|
|
2960
3201
|
*/
|
|
2961
3202
|
Body: Body | undefined;
|
|
@@ -2969,6 +3210,7 @@ export interface Message {
|
|
|
2969
3210
|
*/
|
|
2970
3211
|
export interface MessageDsn {
|
|
2971
3212
|
/**
|
|
3213
|
+
* @public
|
|
2972
3214
|
* <p>The reporting MTA that attempted to deliver the message, formatted as specified in
|
|
2973
3215
|
* <a href="https://tools.ietf.org/html/rfc3464">RFC 3464</a>
|
|
2974
3216
|
* (<code>mta-name-type; mta-name</code>). The default value is <code>dns;
|
|
@@ -2976,10 +3218,12 @@ export interface MessageDsn {
|
|
|
2976
3218
|
*/
|
|
2977
3219
|
ReportingMta: string | undefined;
|
|
2978
3220
|
/**
|
|
3221
|
+
* @public
|
|
2979
3222
|
* <p>When the message was received by the reporting mail transfer agent (MTA), in <a href="https://www.ietf.org/rfc/rfc0822.txt">RFC 822</a> date-time format.</p>
|
|
2980
3223
|
*/
|
|
2981
3224
|
ArrivalDate?: Date;
|
|
2982
3225
|
/**
|
|
3226
|
+
* @public
|
|
2983
3227
|
* <p>Additional X-headers to include in the DSN.</p>
|
|
2984
3228
|
*/
|
|
2985
3229
|
ExtensionFields?: ExtensionField[];
|
|
@@ -3034,11 +3278,13 @@ export declare class ProductionAccessNotGrantedException extends __BaseException
|
|
|
3034
3278
|
*/
|
|
3035
3279
|
export interface PutConfigurationSetDeliveryOptionsRequest {
|
|
3036
3280
|
/**
|
|
3281
|
+
* @public
|
|
3037
3282
|
* <p>The name of the configuration set that you want to specify the delivery options
|
|
3038
3283
|
* for.</p>
|
|
3039
3284
|
*/
|
|
3040
3285
|
ConfigurationSetName: string | undefined;
|
|
3041
3286
|
/**
|
|
3287
|
+
* @public
|
|
3042
3288
|
* <p>Specifies whether messages that use the configuration set are required to use
|
|
3043
3289
|
* Transport Layer Security (TLS).</p>
|
|
3044
3290
|
*/
|
|
@@ -3060,6 +3306,7 @@ export interface PutConfigurationSetDeliveryOptionsResponse {
|
|
|
3060
3306
|
*/
|
|
3061
3307
|
export interface PutIdentityPolicyRequest {
|
|
3062
3308
|
/**
|
|
3309
|
+
* @public
|
|
3063
3310
|
* <p>The identity that the policy will apply to. You can specify an identity by using its
|
|
3064
3311
|
* name or by using its Amazon Resource Name (ARN). Examples:
|
|
3065
3312
|
* <code>user@example.com</code>, <code>example.com</code>,
|
|
@@ -3068,12 +3315,14 @@ export interface PutIdentityPolicyRequest {
|
|
|
3068
3315
|
*/
|
|
3069
3316
|
Identity: string | undefined;
|
|
3070
3317
|
/**
|
|
3318
|
+
* @public
|
|
3071
3319
|
* <p>The name of the policy.</p>
|
|
3072
3320
|
* <p>The policy name cannot exceed 64 characters and can only include alphanumeric
|
|
3073
3321
|
* characters, dashes, and underscores.</p>
|
|
3074
3322
|
*/
|
|
3075
3323
|
PolicyName: string | undefined;
|
|
3076
3324
|
/**
|
|
3325
|
+
* @public
|
|
3077
3326
|
* <p>The text of the policy in JSON format. The policy cannot exceed 4 KB.</p>
|
|
3078
3327
|
* <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
|
|
3079
3328
|
* Guide</a>. </p>
|
|
@@ -3092,6 +3341,7 @@ export interface PutIdentityPolicyResponse {
|
|
|
3092
3341
|
*/
|
|
3093
3342
|
export interface RawMessage {
|
|
3094
3343
|
/**
|
|
3344
|
+
* @public
|
|
3095
3345
|
* <p>The raw data of the message. This data needs to base64-encoded if you are accessing
|
|
3096
3346
|
* Amazon SES directly through the HTTPS interface. If you are accessing Amazon SES using an AWS
|
|
3097
3347
|
* SDK, the SDK takes care of the base 64-encoding for you. In all cases, the client must
|
|
@@ -3117,10 +3367,12 @@ export interface RawMessage {
|
|
|
3117
3367
|
*/
|
|
3118
3368
|
export interface ReorderReceiptRuleSetRequest {
|
|
3119
3369
|
/**
|
|
3370
|
+
* @public
|
|
3120
3371
|
* <p>The name of the receipt rule set to reorder.</p>
|
|
3121
3372
|
*/
|
|
3122
3373
|
RuleSetName: string | undefined;
|
|
3123
3374
|
/**
|
|
3375
|
+
* @public
|
|
3124
3376
|
* <p>A list of the specified receipt rule set's receipt rules in the order that you want to
|
|
3125
3377
|
* put them.</p>
|
|
3126
3378
|
*/
|
|
@@ -3139,30 +3391,36 @@ export interface ReorderReceiptRuleSetResponse {
|
|
|
3139
3391
|
*/
|
|
3140
3392
|
export interface SendBounceRequest {
|
|
3141
3393
|
/**
|
|
3394
|
+
* @public
|
|
3142
3395
|
* <p>The message ID of the message to be bounced.</p>
|
|
3143
3396
|
*/
|
|
3144
3397
|
OriginalMessageId: string | undefined;
|
|
3145
3398
|
/**
|
|
3399
|
+
* @public
|
|
3146
3400
|
* <p>The address to use in the "From" header of the bounce message. This must be an
|
|
3147
3401
|
* identity that you have verified with Amazon SES.</p>
|
|
3148
3402
|
*/
|
|
3149
3403
|
BounceSender: string | undefined;
|
|
3150
3404
|
/**
|
|
3405
|
+
* @public
|
|
3151
3406
|
* <p>Human-readable text for the bounce message to explain the failure. If not specified,
|
|
3152
3407
|
* the text will be auto-generated based on the bounced recipient information.</p>
|
|
3153
3408
|
*/
|
|
3154
3409
|
Explanation?: string;
|
|
3155
3410
|
/**
|
|
3411
|
+
* @public
|
|
3156
3412
|
* <p>Message-related DSN fields. If not specified, Amazon SES will choose the values.</p>
|
|
3157
3413
|
*/
|
|
3158
3414
|
MessageDsn?: MessageDsn;
|
|
3159
3415
|
/**
|
|
3416
|
+
* @public
|
|
3160
3417
|
* <p>A list of recipients of the bounced message, including the information required to
|
|
3161
3418
|
* create the Delivery Status Notifications (DSNs) for the recipients. You must specify at
|
|
3162
3419
|
* least one <code>BouncedRecipientInfo</code> in the list.</p>
|
|
3163
3420
|
*/
|
|
3164
3421
|
BouncedRecipientInfoList: BouncedRecipientInfo[] | undefined;
|
|
3165
3422
|
/**
|
|
3423
|
+
* @public
|
|
3166
3424
|
* <p>This parameter is used only for sending authorization. It is the ARN of the identity
|
|
3167
3425
|
* that is associated with the sending authorization policy that permits you to use the
|
|
3168
3426
|
* address in the "From" header of the bounce. For more information about sending
|
|
@@ -3177,6 +3435,7 @@ export interface SendBounceRequest {
|
|
|
3177
3435
|
*/
|
|
3178
3436
|
export interface SendBounceResponse {
|
|
3179
3437
|
/**
|
|
3438
|
+
* @public
|
|
3180
3439
|
* <p>The message ID of the bounce message.</p>
|
|
3181
3440
|
*/
|
|
3182
3441
|
MessageId?: string;
|
|
@@ -3189,6 +3448,7 @@ export interface SendBounceResponse {
|
|
|
3189
3448
|
*/
|
|
3190
3449
|
export interface SendBulkTemplatedEmailRequest {
|
|
3191
3450
|
/**
|
|
3451
|
+
* @public
|
|
3192
3452
|
* <p>The email address that is sending the email. This email address must be either
|
|
3193
3453
|
* individually verified with Amazon SES, or from a domain that has been verified with Amazon SES.
|
|
3194
3454
|
* For information about verifying identities, see the <a href="https://docs.aws.amazon.com/ses/latest/DeveloperGuide/verify-addresses-and-domains.html">Amazon SES Developer
|
|
@@ -3211,6 +3471,7 @@ export interface SendBulkTemplatedEmailRequest {
|
|
|
3211
3471
|
*/
|
|
3212
3472
|
Source: string | undefined;
|
|
3213
3473
|
/**
|
|
3474
|
+
* @public
|
|
3214
3475
|
* <p>This parameter is used only for sending authorization. It is the ARN of the identity
|
|
3215
3476
|
* that is associated with the sending authorization policy that permits you to send for
|
|
3216
3477
|
* the email address specified in the <code>Source</code> parameter.</p>
|
|
@@ -3225,11 +3486,13 @@ export interface SendBulkTemplatedEmailRequest {
|
|
|
3225
3486
|
*/
|
|
3226
3487
|
SourceArn?: string;
|
|
3227
3488
|
/**
|
|
3489
|
+
* @public
|
|
3228
3490
|
* <p>The reply-to email address(es) for the message. If the recipient replies to the
|
|
3229
3491
|
* message, each reply-to address will receive the reply.</p>
|
|
3230
3492
|
*/
|
|
3231
3493
|
ReplyToAddresses?: string[];
|
|
3232
3494
|
/**
|
|
3495
|
+
* @public
|
|
3233
3496
|
* <p>The email address that bounces and complaints will be forwarded to when feedback
|
|
3234
3497
|
* forwarding is enabled. If the message cannot be delivered to the recipient, then an
|
|
3235
3498
|
* error message will be returned from the recipient's ISP; this message will then be
|
|
@@ -3240,6 +3503,7 @@ export interface SendBulkTemplatedEmailRequest {
|
|
|
3240
3503
|
*/
|
|
3241
3504
|
ReturnPath?: string;
|
|
3242
3505
|
/**
|
|
3506
|
+
* @public
|
|
3243
3507
|
* <p>This parameter is used only for sending authorization. It is the ARN of the identity
|
|
3244
3508
|
* that is associated with the sending authorization policy that permits you to use the
|
|
3245
3509
|
* email address specified in the <code>ReturnPath</code> parameter.</p>
|
|
@@ -3254,24 +3518,29 @@ export interface SendBulkTemplatedEmailRequest {
|
|
|
3254
3518
|
*/
|
|
3255
3519
|
ReturnPathArn?: string;
|
|
3256
3520
|
/**
|
|
3521
|
+
* @public
|
|
3257
3522
|
* <p>The name of the configuration set to use when you send an email using
|
|
3258
3523
|
* <code>SendBulkTemplatedEmail</code>.</p>
|
|
3259
3524
|
*/
|
|
3260
3525
|
ConfigurationSetName?: string;
|
|
3261
3526
|
/**
|
|
3527
|
+
* @public
|
|
3262
3528
|
* <p>A list of tags, in the form of name/value pairs, to apply to an email that you send to
|
|
3263
3529
|
* a destination using <code>SendBulkTemplatedEmail</code>.</p>
|
|
3264
3530
|
*/
|
|
3265
3531
|
DefaultTags?: MessageTag[];
|
|
3266
3532
|
/**
|
|
3533
|
+
* @public
|
|
3267
3534
|
* <p>The template to use when sending this email.</p>
|
|
3268
3535
|
*/
|
|
3269
3536
|
Template: string | undefined;
|
|
3270
3537
|
/**
|
|
3538
|
+
* @public
|
|
3271
3539
|
* <p>The ARN of the template to use when sending this email.</p>
|
|
3272
3540
|
*/
|
|
3273
3541
|
TemplateArn?: string;
|
|
3274
3542
|
/**
|
|
3543
|
+
* @public
|
|
3275
3544
|
* <p>A list of replacement values to apply to the template when replacement data is not
|
|
3276
3545
|
* specified in a Destination object. These values act as a default or fallback option when
|
|
3277
3546
|
* no other data is available.</p>
|
|
@@ -3280,6 +3549,7 @@ export interface SendBulkTemplatedEmailRequest {
|
|
|
3280
3549
|
*/
|
|
3281
3550
|
DefaultTemplateData?: string;
|
|
3282
3551
|
/**
|
|
3552
|
+
* @public
|
|
3283
3553
|
* <p>One or more <code>Destination</code> objects. All of the recipients in a
|
|
3284
3554
|
* <code>Destination</code> will receive the same version of the email. You can specify
|
|
3285
3555
|
* up to 50 <code>Destination</code> objects within a <code>Destinations</code>
|
|
@@ -3292,6 +3562,7 @@ export interface SendBulkTemplatedEmailRequest {
|
|
|
3292
3562
|
*/
|
|
3293
3563
|
export interface SendBulkTemplatedEmailResponse {
|
|
3294
3564
|
/**
|
|
3565
|
+
* @public
|
|
3295
3566
|
* <p>The unique message identifier returned from the <code>SendBulkTemplatedEmail</code>
|
|
3296
3567
|
* action.</p>
|
|
3297
3568
|
*/
|
|
@@ -3304,15 +3575,18 @@ export interface SendBulkTemplatedEmailResponse {
|
|
|
3304
3575
|
*/
|
|
3305
3576
|
export interface SendCustomVerificationEmailRequest {
|
|
3306
3577
|
/**
|
|
3578
|
+
* @public
|
|
3307
3579
|
* <p>The email address to verify.</p>
|
|
3308
3580
|
*/
|
|
3309
3581
|
EmailAddress: string | undefined;
|
|
3310
3582
|
/**
|
|
3583
|
+
* @public
|
|
3311
3584
|
* <p>The name of the custom verification email template to use when sending the
|
|
3312
3585
|
* verification email.</p>
|
|
3313
3586
|
*/
|
|
3314
3587
|
TemplateName: string | undefined;
|
|
3315
3588
|
/**
|
|
3589
|
+
* @public
|
|
3316
3590
|
* <p>Name of a configuration set to use when sending the verification email.</p>
|
|
3317
3591
|
*/
|
|
3318
3592
|
ConfigurationSetName?: string;
|
|
@@ -3323,6 +3597,7 @@ export interface SendCustomVerificationEmailRequest {
|
|
|
3323
3597
|
*/
|
|
3324
3598
|
export interface SendCustomVerificationEmailResponse {
|
|
3325
3599
|
/**
|
|
3600
|
+
* @public
|
|
3326
3601
|
* <p>The unique message identifier returned from the
|
|
3327
3602
|
* <code>SendCustomVerificationEmail</code> operation.</p>
|
|
3328
3603
|
*/
|
|
@@ -3336,6 +3611,7 @@ export interface SendCustomVerificationEmailResponse {
|
|
|
3336
3611
|
*/
|
|
3337
3612
|
export interface SendEmailRequest {
|
|
3338
3613
|
/**
|
|
3614
|
+
* @public
|
|
3339
3615
|
* <p>The email address that is sending the email. This email address must be either
|
|
3340
3616
|
* individually verified with Amazon SES, or from a domain that has been verified with Amazon SES.
|
|
3341
3617
|
* For information about verifying identities, see the <a href="https://docs.aws.amazon.com/ses/latest/DeveloperGuide/verify-addresses-and-domains.html">Amazon SES Developer
|
|
@@ -3358,19 +3634,23 @@ export interface SendEmailRequest {
|
|
|
3358
3634
|
*/
|
|
3359
3635
|
Source: string | undefined;
|
|
3360
3636
|
/**
|
|
3637
|
+
* @public
|
|
3361
3638
|
* <p>The destination for this email, composed of To:, CC:, and BCC: fields.</p>
|
|
3362
3639
|
*/
|
|
3363
3640
|
Destination: Destination | undefined;
|
|
3364
3641
|
/**
|
|
3642
|
+
* @public
|
|
3365
3643
|
* <p>The message to be sent.</p>
|
|
3366
3644
|
*/
|
|
3367
3645
|
Message: Message | undefined;
|
|
3368
3646
|
/**
|
|
3647
|
+
* @public
|
|
3369
3648
|
* <p>The reply-to email address(es) for the message. If the recipient replies to the
|
|
3370
3649
|
* message, each reply-to address will receive the reply.</p>
|
|
3371
3650
|
*/
|
|
3372
3651
|
ReplyToAddresses?: string[];
|
|
3373
3652
|
/**
|
|
3653
|
+
* @public
|
|
3374
3654
|
* <p>The email address that bounces and complaints will be forwarded to when feedback
|
|
3375
3655
|
* forwarding is enabled. If the message cannot be delivered to the recipient, then an
|
|
3376
3656
|
* error message will be returned from the recipient's ISP; this message will then be
|
|
@@ -3381,6 +3661,7 @@ export interface SendEmailRequest {
|
|
|
3381
3661
|
*/
|
|
3382
3662
|
ReturnPath?: string;
|
|
3383
3663
|
/**
|
|
3664
|
+
* @public
|
|
3384
3665
|
* <p>This parameter is used only for sending authorization. It is the ARN of the identity
|
|
3385
3666
|
* that is associated with the sending authorization policy that permits you to send for
|
|
3386
3667
|
* the email address specified in the <code>Source</code> parameter.</p>
|
|
@@ -3395,6 +3676,7 @@ export interface SendEmailRequest {
|
|
|
3395
3676
|
*/
|
|
3396
3677
|
SourceArn?: string;
|
|
3397
3678
|
/**
|
|
3679
|
+
* @public
|
|
3398
3680
|
* <p>This parameter is used only for sending authorization. It is the ARN of the identity
|
|
3399
3681
|
* that is associated with the sending authorization policy that permits you to use the
|
|
3400
3682
|
* email address specified in the <code>ReturnPath</code> parameter.</p>
|
|
@@ -3409,12 +3691,14 @@ export interface SendEmailRequest {
|
|
|
3409
3691
|
*/
|
|
3410
3692
|
ReturnPathArn?: string;
|
|
3411
3693
|
/**
|
|
3694
|
+
* @public
|
|
3412
3695
|
* <p>A list of tags, in the form of name/value pairs, to apply to an email that you send
|
|
3413
3696
|
* using <code>SendEmail</code>. Tags correspond to characteristics of the email that you
|
|
3414
3697
|
* define, so that you can publish email sending events.</p>
|
|
3415
3698
|
*/
|
|
3416
3699
|
Tags?: MessageTag[];
|
|
3417
3700
|
/**
|
|
3701
|
+
* @public
|
|
3418
3702
|
* <p>The name of the configuration set to use when you send an email using
|
|
3419
3703
|
* <code>SendEmail</code>.</p>
|
|
3420
3704
|
*/
|
|
@@ -3426,6 +3710,7 @@ export interface SendEmailRequest {
|
|
|
3426
3710
|
*/
|
|
3427
3711
|
export interface SendEmailResponse {
|
|
3428
3712
|
/**
|
|
3713
|
+
* @public
|
|
3429
3714
|
* <p>The unique message identifier returned from the <code>SendEmail</code> action. </p>
|
|
3430
3715
|
*/
|
|
3431
3716
|
MessageId: string | undefined;
|
|
@@ -3437,6 +3722,7 @@ export interface SendEmailResponse {
|
|
|
3437
3722
|
*/
|
|
3438
3723
|
export interface SendRawEmailRequest {
|
|
3439
3724
|
/**
|
|
3725
|
+
* @public
|
|
3440
3726
|
* <p>The identity's email address. If you do not provide a value for this parameter, you
|
|
3441
3727
|
* must specify a "From" address in the raw text of the message. (You can also specify
|
|
3442
3728
|
* both.)</p>
|
|
@@ -3460,11 +3746,13 @@ export interface SendRawEmailRequest {
|
|
|
3460
3746
|
*/
|
|
3461
3747
|
Source?: string;
|
|
3462
3748
|
/**
|
|
3749
|
+
* @public
|
|
3463
3750
|
* <p>A list of destinations for the message, consisting of To:, CC:, and BCC:
|
|
3464
3751
|
* addresses.</p>
|
|
3465
3752
|
*/
|
|
3466
3753
|
Destinations?: string[];
|
|
3467
3754
|
/**
|
|
3755
|
+
* @public
|
|
3468
3756
|
* <p>The raw email message itself. The message has to meet the following criteria:</p>
|
|
3469
3757
|
* <ul>
|
|
3470
3758
|
* <li>
|
|
@@ -3500,6 +3788,7 @@ export interface SendRawEmailRequest {
|
|
|
3500
3788
|
*/
|
|
3501
3789
|
RawMessage: RawMessage | undefined;
|
|
3502
3790
|
/**
|
|
3791
|
+
* @public
|
|
3503
3792
|
* <p>This parameter is used only for sending authorization. It is the ARN of the identity
|
|
3504
3793
|
* that is associated with the sending authorization policy that permits you to specify a
|
|
3505
3794
|
* particular "From" address in the header of the raw email.</p>
|
|
@@ -3514,6 +3803,7 @@ export interface SendRawEmailRequest {
|
|
|
3514
3803
|
*/
|
|
3515
3804
|
FromArn?: string;
|
|
3516
3805
|
/**
|
|
3806
|
+
* @public
|
|
3517
3807
|
* <p>This parameter is used only for sending authorization. It is the ARN of the identity
|
|
3518
3808
|
* that is associated with the sending authorization policy that permits you to send for
|
|
3519
3809
|
* the email address specified in the <code>Source</code> parameter.</p>
|
|
@@ -3534,6 +3824,7 @@ export interface SendRawEmailRequest {
|
|
|
3534
3824
|
*/
|
|
3535
3825
|
SourceArn?: string;
|
|
3536
3826
|
/**
|
|
3827
|
+
* @public
|
|
3537
3828
|
* <p>This parameter is used only for sending authorization. It is the ARN of the identity
|
|
3538
3829
|
* that is associated with the sending authorization policy that permits you to use the
|
|
3539
3830
|
* email address specified in the <code>ReturnPath</code> parameter.</p>
|
|
@@ -3554,12 +3845,14 @@ export interface SendRawEmailRequest {
|
|
|
3554
3845
|
*/
|
|
3555
3846
|
ReturnPathArn?: string;
|
|
3556
3847
|
/**
|
|
3848
|
+
* @public
|
|
3557
3849
|
* <p>A list of tags, in the form of name/value pairs, to apply to an email that you send
|
|
3558
3850
|
* using <code>SendRawEmail</code>. Tags correspond to characteristics of the email that
|
|
3559
3851
|
* you define, so that you can publish email sending events.</p>
|
|
3560
3852
|
*/
|
|
3561
3853
|
Tags?: MessageTag[];
|
|
3562
3854
|
/**
|
|
3855
|
+
* @public
|
|
3563
3856
|
* <p>The name of the configuration set to use when you send an email using
|
|
3564
3857
|
* <code>SendRawEmail</code>.</p>
|
|
3565
3858
|
*/
|
|
@@ -3571,6 +3864,7 @@ export interface SendRawEmailRequest {
|
|
|
3571
3864
|
*/
|
|
3572
3865
|
export interface SendRawEmailResponse {
|
|
3573
3866
|
/**
|
|
3867
|
+
* @public
|
|
3574
3868
|
* <p>The unique message identifier returned from the <code>SendRawEmail</code> action.
|
|
3575
3869
|
* </p>
|
|
3576
3870
|
*/
|
|
@@ -3584,6 +3878,7 @@ export interface SendRawEmailResponse {
|
|
|
3584
3878
|
*/
|
|
3585
3879
|
export interface SendTemplatedEmailRequest {
|
|
3586
3880
|
/**
|
|
3881
|
+
* @public
|
|
3587
3882
|
* <p>The email address that is sending the email. This email address must be either
|
|
3588
3883
|
* individually verified with Amazon SES, or from a domain that has been verified with Amazon SES.
|
|
3589
3884
|
* For information about verifying identities, see the <a href="https://docs.aws.amazon.com/ses/latest/DeveloperGuide/verify-addresses-and-domains.html">Amazon SES Developer
|
|
@@ -3606,16 +3901,19 @@ export interface SendTemplatedEmailRequest {
|
|
|
3606
3901
|
*/
|
|
3607
3902
|
Source: string | undefined;
|
|
3608
3903
|
/**
|
|
3904
|
+
* @public
|
|
3609
3905
|
* <p>The destination for this email, composed of To:, CC:, and BCC: fields. A Destination
|
|
3610
3906
|
* can include up to 50 recipients across these three fields.</p>
|
|
3611
3907
|
*/
|
|
3612
3908
|
Destination: Destination | undefined;
|
|
3613
3909
|
/**
|
|
3910
|
+
* @public
|
|
3614
3911
|
* <p>The reply-to email address(es) for the message. If the recipient replies to the
|
|
3615
3912
|
* message, each reply-to address will receive the reply.</p>
|
|
3616
3913
|
*/
|
|
3617
3914
|
ReplyToAddresses?: string[];
|
|
3618
3915
|
/**
|
|
3916
|
+
* @public
|
|
3619
3917
|
* <p>The email address that bounces and complaints will be forwarded to when feedback
|
|
3620
3918
|
* forwarding is enabled. If the message cannot be delivered to the recipient, then an
|
|
3621
3919
|
* error message will be returned from the recipient's ISP; this message will then be
|
|
@@ -3626,6 +3924,7 @@ export interface SendTemplatedEmailRequest {
|
|
|
3626
3924
|
*/
|
|
3627
3925
|
ReturnPath?: string;
|
|
3628
3926
|
/**
|
|
3927
|
+
* @public
|
|
3629
3928
|
* <p>This parameter is used only for sending authorization. It is the ARN of the identity
|
|
3630
3929
|
* that is associated with the sending authorization policy that permits you to send for
|
|
3631
3930
|
* the email address specified in the <code>Source</code> parameter.</p>
|
|
@@ -3640,6 +3939,7 @@ export interface SendTemplatedEmailRequest {
|
|
|
3640
3939
|
*/
|
|
3641
3940
|
SourceArn?: string;
|
|
3642
3941
|
/**
|
|
3942
|
+
* @public
|
|
3643
3943
|
* <p>This parameter is used only for sending authorization. It is the ARN of the identity
|
|
3644
3944
|
* that is associated with the sending authorization policy that permits you to use the
|
|
3645
3945
|
* email address specified in the <code>ReturnPath</code> parameter.</p>
|
|
@@ -3654,25 +3954,30 @@ export interface SendTemplatedEmailRequest {
|
|
|
3654
3954
|
*/
|
|
3655
3955
|
ReturnPathArn?: string;
|
|
3656
3956
|
/**
|
|
3957
|
+
* @public
|
|
3657
3958
|
* <p>A list of tags, in the form of name/value pairs, to apply to an email that you send
|
|
3658
3959
|
* using <code>SendTemplatedEmail</code>. Tags correspond to characteristics of the email
|
|
3659
3960
|
* that you define, so that you can publish email sending events.</p>
|
|
3660
3961
|
*/
|
|
3661
3962
|
Tags?: MessageTag[];
|
|
3662
3963
|
/**
|
|
3964
|
+
* @public
|
|
3663
3965
|
* <p>The name of the configuration set to use when you send an email using
|
|
3664
3966
|
* <code>SendTemplatedEmail</code>.</p>
|
|
3665
3967
|
*/
|
|
3666
3968
|
ConfigurationSetName?: string;
|
|
3667
3969
|
/**
|
|
3970
|
+
* @public
|
|
3668
3971
|
* <p>The template to use when sending this email.</p>
|
|
3669
3972
|
*/
|
|
3670
3973
|
Template: string | undefined;
|
|
3671
3974
|
/**
|
|
3975
|
+
* @public
|
|
3672
3976
|
* <p>The ARN of the template to use when sending this email.</p>
|
|
3673
3977
|
*/
|
|
3674
3978
|
TemplateArn?: string;
|
|
3675
3979
|
/**
|
|
3980
|
+
* @public
|
|
3676
3981
|
* <p>A list of replacement values to apply to the template. This parameter is a JSON
|
|
3677
3982
|
* object, typically consisting of key-value pairs in which the keys correspond to
|
|
3678
3983
|
* replacement tags in the email template.</p>
|
|
@@ -3684,6 +3989,7 @@ export interface SendTemplatedEmailRequest {
|
|
|
3684
3989
|
*/
|
|
3685
3990
|
export interface SendTemplatedEmailResponse {
|
|
3686
3991
|
/**
|
|
3992
|
+
* @public
|
|
3687
3993
|
* <p>The unique message identifier returned from the <code>SendTemplatedEmail</code>
|
|
3688
3994
|
* action. </p>
|
|
3689
3995
|
*/
|
|
@@ -3696,6 +4002,7 @@ export interface SendTemplatedEmailResponse {
|
|
|
3696
4002
|
*/
|
|
3697
4003
|
export interface SetActiveReceiptRuleSetRequest {
|
|
3698
4004
|
/**
|
|
4005
|
+
* @public
|
|
3699
4006
|
* <p>The name of the receipt rule set to make active. Setting this value to null disables
|
|
3700
4007
|
* all email receiving.</p>
|
|
3701
4008
|
*/
|
|
@@ -3714,10 +4021,12 @@ export interface SetActiveReceiptRuleSetResponse {
|
|
|
3714
4021
|
*/
|
|
3715
4022
|
export interface SetIdentityDkimEnabledRequest {
|
|
3716
4023
|
/**
|
|
4024
|
+
* @public
|
|
3717
4025
|
* <p>The identity for which DKIM signing should be enabled or disabled.</p>
|
|
3718
4026
|
*/
|
|
3719
4027
|
Identity: string | undefined;
|
|
3720
4028
|
/**
|
|
4029
|
+
* @public
|
|
3721
4030
|
* <p>Sets whether DKIM signing is enabled for an identity. Set to <code>true</code> to
|
|
3722
4031
|
* enable DKIM signing for this identity; <code>false</code> to disable it. </p>
|
|
3723
4032
|
*/
|
|
@@ -3738,11 +4047,13 @@ export interface SetIdentityDkimEnabledResponse {
|
|
|
3738
4047
|
*/
|
|
3739
4048
|
export interface SetIdentityFeedbackForwardingEnabledRequest {
|
|
3740
4049
|
/**
|
|
4050
|
+
* @public
|
|
3741
4051
|
* <p>The identity for which to set bounce and complaint notification forwarding. Examples:
|
|
3742
4052
|
* <code>user@example.com</code>, <code>example.com</code>.</p>
|
|
3743
4053
|
*/
|
|
3744
4054
|
Identity: string | undefined;
|
|
3745
4055
|
/**
|
|
4056
|
+
* @public
|
|
3746
4057
|
* <p>Sets whether Amazon SES will forward bounce and complaint notifications as email.
|
|
3747
4058
|
* <code>true</code> specifies that Amazon SES will forward bounce and complaint
|
|
3748
4059
|
* notifications as email, in addition to any Amazon SNS topic publishing otherwise specified.
|
|
@@ -3768,15 +4079,18 @@ export interface SetIdentityFeedbackForwardingEnabledResponse {
|
|
|
3768
4079
|
*/
|
|
3769
4080
|
export interface SetIdentityHeadersInNotificationsEnabledRequest {
|
|
3770
4081
|
/**
|
|
4082
|
+
* @public
|
|
3771
4083
|
* <p>The identity for which to enable or disable headers in notifications. Examples:
|
|
3772
4084
|
* <code>user@example.com</code>, <code>example.com</code>.</p>
|
|
3773
4085
|
*/
|
|
3774
4086
|
Identity: string | undefined;
|
|
3775
4087
|
/**
|
|
4088
|
+
* @public
|
|
3776
4089
|
* <p>The notification type for which to enable or disable headers in notifications. </p>
|
|
3777
4090
|
*/
|
|
3778
4091
|
NotificationType: NotificationType | string | undefined;
|
|
3779
4092
|
/**
|
|
4093
|
+
* @public
|
|
3780
4094
|
* <p>Sets whether Amazon SES includes the original email headers in Amazon SNS notifications of the
|
|
3781
4095
|
* specified notification type. A value of <code>true</code> specifies that Amazon SES will
|
|
3782
4096
|
* include headers in notifications, and a value of <code>false</code> specifies that Amazon SES
|
|
@@ -3801,11 +4115,13 @@ export interface SetIdentityHeadersInNotificationsEnabledResponse {
|
|
|
3801
4115
|
*/
|
|
3802
4116
|
export interface SetIdentityMailFromDomainRequest {
|
|
3803
4117
|
/**
|
|
4118
|
+
* @public
|
|
3804
4119
|
* <p>The verified identity for which you want to enable or disable the specified custom
|
|
3805
4120
|
* MAIL FROM domain.</p>
|
|
3806
4121
|
*/
|
|
3807
4122
|
Identity: string | undefined;
|
|
3808
4123
|
/**
|
|
4124
|
+
* @public
|
|
3809
4125
|
* <p>The custom MAIL FROM domain that you want the verified identity to use. The MAIL FROM
|
|
3810
4126
|
* domain must 1) be a subdomain of the verified identity, 2) not be used in a "From"
|
|
3811
4127
|
* address if the MAIL FROM domain is the destination of email feedback forwarding (for
|
|
@@ -3815,6 +4131,7 @@ export interface SetIdentityMailFromDomainRequest {
|
|
|
3815
4131
|
*/
|
|
3816
4132
|
MailFromDomain?: string;
|
|
3817
4133
|
/**
|
|
4134
|
+
* @public
|
|
3818
4135
|
* <p>The action that you want Amazon SES to take if it cannot successfully read the required MX
|
|
3819
4136
|
* record when you send an email. If you choose <code>UseDefaultValue</code>, Amazon SES will
|
|
3820
4137
|
* use amazonses.com (or a subdomain of that) as the MAIL FROM domain. If you choose
|
|
@@ -3841,6 +4158,7 @@ export interface SetIdentityMailFromDomainResponse {
|
|
|
3841
4158
|
*/
|
|
3842
4159
|
export interface SetIdentityNotificationTopicRequest {
|
|
3843
4160
|
/**
|
|
4161
|
+
* @public
|
|
3844
4162
|
* <p>The identity (email address or domain) that you want to set the Amazon SNS topic
|
|
3845
4163
|
* for.</p>
|
|
3846
4164
|
* <important>
|
|
@@ -3853,10 +4171,12 @@ export interface SetIdentityNotificationTopicRequest {
|
|
|
3853
4171
|
*/
|
|
3854
4172
|
Identity: string | undefined;
|
|
3855
4173
|
/**
|
|
4174
|
+
* @public
|
|
3856
4175
|
* <p>The type of notifications that will be published to the specified Amazon SNS topic.</p>
|
|
3857
4176
|
*/
|
|
3858
4177
|
NotificationType: NotificationType | string | undefined;
|
|
3859
4178
|
/**
|
|
4179
|
+
* @public
|
|
3860
4180
|
* <p>The Amazon Resource Name (ARN) of the Amazon SNS topic. If the parameter is omitted from
|
|
3861
4181
|
* the request or a null value is passed, <code>SnsTopic</code> is cleared and publishing
|
|
3862
4182
|
* is disabled.</p>
|
|
@@ -3876,14 +4196,17 @@ export interface SetIdentityNotificationTopicResponse {
|
|
|
3876
4196
|
*/
|
|
3877
4197
|
export interface SetReceiptRulePositionRequest {
|
|
3878
4198
|
/**
|
|
4199
|
+
* @public
|
|
3879
4200
|
* <p>The name of the receipt rule set that contains the receipt rule to reposition.</p>
|
|
3880
4201
|
*/
|
|
3881
4202
|
RuleSetName: string | undefined;
|
|
3882
4203
|
/**
|
|
4204
|
+
* @public
|
|
3883
4205
|
* <p>The name of the receipt rule to reposition.</p>
|
|
3884
4206
|
*/
|
|
3885
4207
|
RuleName: string | undefined;
|
|
3886
4208
|
/**
|
|
4209
|
+
* @public
|
|
3887
4210
|
* <p>The name of the receipt rule after which to place the specified receipt rule.</p>
|
|
3888
4211
|
*/
|
|
3889
4212
|
After?: string;
|
|
@@ -3899,10 +4222,12 @@ export interface SetReceiptRulePositionResponse {
|
|
|
3899
4222
|
*/
|
|
3900
4223
|
export interface TestRenderTemplateRequest {
|
|
3901
4224
|
/**
|
|
4225
|
+
* @public
|
|
3902
4226
|
* <p>The name of the template that you want to render.</p>
|
|
3903
4227
|
*/
|
|
3904
4228
|
TemplateName: string | undefined;
|
|
3905
4229
|
/**
|
|
4230
|
+
* @public
|
|
3906
4231
|
* <p>A list of replacement values to apply to the template. This parameter is a JSON
|
|
3907
4232
|
* object, typically consisting of key-value pairs in which the keys correspond to
|
|
3908
4233
|
* replacement tags in the email template.</p>
|
|
@@ -3914,6 +4239,7 @@ export interface TestRenderTemplateRequest {
|
|
|
3914
4239
|
*/
|
|
3915
4240
|
export interface TestRenderTemplateResponse {
|
|
3916
4241
|
/**
|
|
4242
|
+
* @public
|
|
3917
4243
|
* <p>The complete MIME message rendered by applying the data in the TemplateData parameter
|
|
3918
4244
|
* to the template specified in the TemplateName parameter.</p>
|
|
3919
4245
|
*/
|
|
@@ -3926,6 +4252,7 @@ export interface TestRenderTemplateResponse {
|
|
|
3926
4252
|
*/
|
|
3927
4253
|
export interface UpdateAccountSendingEnabledRequest {
|
|
3928
4254
|
/**
|
|
4255
|
+
* @public
|
|
3929
4256
|
* <p>Describes whether email sending is enabled or disabled for your Amazon SES account in the
|
|
3930
4257
|
* current AWS Region.</p>
|
|
3931
4258
|
*/
|
|
@@ -3940,11 +4267,13 @@ export interface UpdateAccountSendingEnabledRequest {
|
|
|
3940
4267
|
*/
|
|
3941
4268
|
export interface UpdateConfigurationSetEventDestinationRequest {
|
|
3942
4269
|
/**
|
|
4270
|
+
* @public
|
|
3943
4271
|
* <p>The name of the configuration set that contains the event destination that you want to
|
|
3944
4272
|
* update.</p>
|
|
3945
4273
|
*/
|
|
3946
4274
|
ConfigurationSetName: string | undefined;
|
|
3947
4275
|
/**
|
|
4276
|
+
* @public
|
|
3948
4277
|
* <p>The event destination object that you want to apply to the specified configuration
|
|
3949
4278
|
* set.</p>
|
|
3950
4279
|
*/
|
|
@@ -3963,10 +4292,12 @@ export interface UpdateConfigurationSetEventDestinationResponse {
|
|
|
3963
4292
|
*/
|
|
3964
4293
|
export interface UpdateConfigurationSetReputationMetricsEnabledRequest {
|
|
3965
4294
|
/**
|
|
4295
|
+
* @public
|
|
3966
4296
|
* <p>The name of the configuration set that you want to update.</p>
|
|
3967
4297
|
*/
|
|
3968
4298
|
ConfigurationSetName: string | undefined;
|
|
3969
4299
|
/**
|
|
4300
|
+
* @public
|
|
3970
4301
|
* <p>Describes whether or not Amazon SES will publish reputation metrics for the configuration
|
|
3971
4302
|
* set, such as bounce and complaint rates, to Amazon CloudWatch.</p>
|
|
3972
4303
|
*/
|
|
@@ -3979,10 +4310,12 @@ export interface UpdateConfigurationSetReputationMetricsEnabledRequest {
|
|
|
3979
4310
|
*/
|
|
3980
4311
|
export interface UpdateConfigurationSetSendingEnabledRequest {
|
|
3981
4312
|
/**
|
|
4313
|
+
* @public
|
|
3982
4314
|
* <p>The name of the configuration set that you want to update.</p>
|
|
3983
4315
|
*/
|
|
3984
4316
|
ConfigurationSetName: string | undefined;
|
|
3985
4317
|
/**
|
|
4318
|
+
* @public
|
|
3986
4319
|
* <p>Describes whether email sending is enabled or disabled for the configuration set.
|
|
3987
4320
|
* </p>
|
|
3988
4321
|
*/
|
|
@@ -3994,11 +4327,13 @@ export interface UpdateConfigurationSetSendingEnabledRequest {
|
|
|
3994
4327
|
*/
|
|
3995
4328
|
export interface UpdateConfigurationSetTrackingOptionsRequest {
|
|
3996
4329
|
/**
|
|
4330
|
+
* @public
|
|
3997
4331
|
* <p>The name of the configuration set for which you want to update the custom tracking
|
|
3998
4332
|
* domain.</p>
|
|
3999
4333
|
*/
|
|
4000
4334
|
ConfigurationSetName: string | undefined;
|
|
4001
4335
|
/**
|
|
4336
|
+
* @public
|
|
4002
4337
|
* <p>A domain that is used to redirect email recipients to an Amazon SES-operated domain. This
|
|
4003
4338
|
* domain captures open and click events generated by Amazon SES emails.</p>
|
|
4004
4339
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/ses/latest/DeveloperGuide/configure-custom-open-click-domains.html">Configuring
|
|
@@ -4019,18 +4354,22 @@ export interface UpdateConfigurationSetTrackingOptionsResponse {
|
|
|
4019
4354
|
*/
|
|
4020
4355
|
export interface UpdateCustomVerificationEmailTemplateRequest {
|
|
4021
4356
|
/**
|
|
4357
|
+
* @public
|
|
4022
4358
|
* <p>The name of the custom verification email template that you want to update.</p>
|
|
4023
4359
|
*/
|
|
4024
4360
|
TemplateName: string | undefined;
|
|
4025
4361
|
/**
|
|
4362
|
+
* @public
|
|
4026
4363
|
* <p>The email address that the custom verification email is sent from.</p>
|
|
4027
4364
|
*/
|
|
4028
4365
|
FromEmailAddress?: string;
|
|
4029
4366
|
/**
|
|
4367
|
+
* @public
|
|
4030
4368
|
* <p>The subject line of the custom verification email.</p>
|
|
4031
4369
|
*/
|
|
4032
4370
|
TemplateSubject?: string;
|
|
4033
4371
|
/**
|
|
4372
|
+
* @public
|
|
4034
4373
|
* <p>The content of the custom verification email. The total size of the email must be less
|
|
4035
4374
|
* than 10 MB. The message body may contain HTML, with some limitations. For more
|
|
4036
4375
|
* information, see <a href="https://docs.aws.amazon.com/ses/latest/DeveloperGuide/custom-verification-emails.html#custom-verification-emails-faq">Custom Verification Email Frequently Asked Questions</a> in the <i>Amazon SES
|
|
@@ -4038,11 +4377,13 @@ export interface UpdateCustomVerificationEmailTemplateRequest {
|
|
|
4038
4377
|
*/
|
|
4039
4378
|
TemplateContent?: string;
|
|
4040
4379
|
/**
|
|
4380
|
+
* @public
|
|
4041
4381
|
* <p>The URL that the recipient of the verification email is sent to if his or her address
|
|
4042
4382
|
* is successfully verified.</p>
|
|
4043
4383
|
*/
|
|
4044
4384
|
SuccessRedirectionURL?: string;
|
|
4045
4385
|
/**
|
|
4386
|
+
* @public
|
|
4046
4387
|
* <p>The URL that the recipient of the verification email is sent to if his or her address
|
|
4047
4388
|
* is not successfully verified.</p>
|
|
4048
4389
|
*/
|
|
@@ -4056,10 +4397,12 @@ export interface UpdateCustomVerificationEmailTemplateRequest {
|
|
|
4056
4397
|
*/
|
|
4057
4398
|
export interface UpdateReceiptRuleRequest {
|
|
4058
4399
|
/**
|
|
4400
|
+
* @public
|
|
4059
4401
|
* <p>The name of the receipt rule set that the receipt rule belongs to.</p>
|
|
4060
4402
|
*/
|
|
4061
4403
|
RuleSetName: string | undefined;
|
|
4062
4404
|
/**
|
|
4405
|
+
* @public
|
|
4063
4406
|
* <p>A data structure that contains the updated receipt rule information.</p>
|
|
4064
4407
|
*/
|
|
4065
4408
|
Rule: ReceiptRule | undefined;
|
|
@@ -4075,6 +4418,7 @@ export interface UpdateReceiptRuleResponse {
|
|
|
4075
4418
|
*/
|
|
4076
4419
|
export interface UpdateTemplateRequest {
|
|
4077
4420
|
/**
|
|
4421
|
+
* @public
|
|
4078
4422
|
* <p>The content of the email, composed of a subject line, an HTML part, and a text-only
|
|
4079
4423
|
* part.</p>
|
|
4080
4424
|
*/
|
|
@@ -4093,6 +4437,7 @@ export interface UpdateTemplateResponse {
|
|
|
4093
4437
|
*/
|
|
4094
4438
|
export interface VerifyDomainDkimRequest {
|
|
4095
4439
|
/**
|
|
4440
|
+
* @public
|
|
4096
4441
|
* <p>The name of the domain to be verified for Easy DKIM signing.</p>
|
|
4097
4442
|
*/
|
|
4098
4443
|
Domain: string | undefined;
|
|
@@ -4104,6 +4449,7 @@ export interface VerifyDomainDkimRequest {
|
|
|
4104
4449
|
*/
|
|
4105
4450
|
export interface VerifyDomainDkimResponse {
|
|
4106
4451
|
/**
|
|
4452
|
+
* @public
|
|
4107
4453
|
* <p>A set of character strings that represent the domain's identity. If the identity is an
|
|
4108
4454
|
* email address, the tokens represent the domain of that address.</p>
|
|
4109
4455
|
* <p>Using these tokens, you need to create DNS CNAME records that point to DKIM public
|
|
@@ -4125,6 +4471,7 @@ export interface VerifyDomainDkimResponse {
|
|
|
4125
4471
|
*/
|
|
4126
4472
|
export interface VerifyDomainIdentityRequest {
|
|
4127
4473
|
/**
|
|
4474
|
+
* @public
|
|
4128
4475
|
* <p>The domain to be verified.</p>
|
|
4129
4476
|
*/
|
|
4130
4477
|
Domain: string | undefined;
|
|
@@ -4136,6 +4483,7 @@ export interface VerifyDomainIdentityRequest {
|
|
|
4136
4483
|
*/
|
|
4137
4484
|
export interface VerifyDomainIdentityResponse {
|
|
4138
4485
|
/**
|
|
4486
|
+
* @public
|
|
4139
4487
|
* <p>A TXT record that you must place in the DNS settings of the domain to complete domain
|
|
4140
4488
|
* verification with Amazon SES.</p>
|
|
4141
4489
|
* <p>As Amazon SES searches for the TXT record, the domain's verification status is "Pending".
|
|
@@ -4154,6 +4502,7 @@ export interface VerifyDomainIdentityResponse {
|
|
|
4154
4502
|
*/
|
|
4155
4503
|
export interface VerifyEmailAddressRequest {
|
|
4156
4504
|
/**
|
|
4505
|
+
* @public
|
|
4157
4506
|
* <p>The email address to be verified.</p>
|
|
4158
4507
|
*/
|
|
4159
4508
|
EmailAddress: string | undefined;
|
|
@@ -4166,6 +4515,7 @@ export interface VerifyEmailAddressRequest {
|
|
|
4166
4515
|
*/
|
|
4167
4516
|
export interface VerifyEmailIdentityRequest {
|
|
4168
4517
|
/**
|
|
4518
|
+
* @public
|
|
4169
4519
|
* <p>The email address to be verified.</p>
|
|
4170
4520
|
*/
|
|
4171
4521
|
EmailAddress: string | undefined;
|