@aws-sdk/client-sesv2 3.287.0 → 3.288.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-cjs/endpoint/ruleset.js +3 -3
- package/dist-cjs/models/models_0.js +1 -0
- package/dist-es/endpoint/ruleset.js +3 -3
- package/dist-es/models/models_0.js +1 -0
- package/dist-types/SESv2.d.ts +70 -81
- package/dist-types/SESv2Client.d.ts +2 -3
- package/dist-types/commands/BatchGetMetricDataCommand.d.ts +1 -1
- package/dist-types/commands/CreateConfigurationSetEventDestinationCommand.d.ts +1 -1
- package/dist-types/commands/CreateCustomVerificationEmailTemplateCommand.d.ts +2 -2
- package/dist-types/commands/CreateEmailIdentityCommand.d.ts +5 -5
- package/dist-types/commands/CreateEmailIdentityPolicyCommand.d.ts +4 -5
- package/dist-types/commands/CreateEmailTemplateCommand.d.ts +1 -1
- package/dist-types/commands/DeleteConfigurationSetCommand.d.ts +1 -1
- package/dist-types/commands/DeleteConfigurationSetEventDestinationCommand.d.ts +1 -1
- package/dist-types/commands/DeleteCustomVerificationEmailTemplateCommand.d.ts +2 -2
- package/dist-types/commands/DeleteEmailIdentityPolicyCommand.d.ts +4 -5
- package/dist-types/commands/DeleteEmailTemplateCommand.d.ts +1 -2
- package/dist-types/commands/GetConfigurationSetCommand.d.ts +1 -1
- package/dist-types/commands/GetConfigurationSetEventDestinationsCommand.d.ts +1 -1
- package/dist-types/commands/GetCustomVerificationEmailTemplateCommand.d.ts +2 -2
- package/dist-types/commands/GetDeliverabilityDashboardOptionsCommand.d.ts +1 -2
- package/dist-types/commands/GetEmailIdentityPoliciesCommand.d.ts +4 -4
- package/dist-types/commands/GetEmailTemplateCommand.d.ts +1 -2
- package/dist-types/commands/ListConfigurationSetsCommand.d.ts +1 -1
- package/dist-types/commands/ListCustomVerificationEmailTemplatesCommand.d.ts +2 -2
- package/dist-types/commands/ListEmailTemplatesCommand.d.ts +1 -2
- package/dist-types/commands/ListRecommendationsCommand.d.ts +1 -1
- package/dist-types/commands/PutAccountVdmAttributesCommand.d.ts +1 -1
- package/dist-types/commands/PutConfigurationSetVdmOptionsCommand.d.ts +1 -1
- package/dist-types/commands/PutDedicatedIpInPoolCommand.d.ts +2 -3
- package/dist-types/commands/PutDeliverabilityDashboardOptionCommand.d.ts +1 -2
- package/dist-types/commands/PutEmailIdentityDkimSigningAttributesCommand.d.ts +7 -7
- package/dist-types/commands/PutEmailIdentityFeedbackAttributesCommand.d.ts +2 -2
- package/dist-types/commands/SendCustomVerificationEmailCommand.d.ts +2 -2
- package/dist-types/commands/SendEmailCommand.d.ts +4 -4
- package/dist-types/commands/TagResourceCommand.d.ts +1 -1
- package/dist-types/commands/TestRenderEmailTemplateCommand.d.ts +1 -2
- package/dist-types/commands/UpdateConfigurationSetEventDestinationCommand.d.ts +1 -1
- package/dist-types/commands/UpdateCustomVerificationEmailTemplateCommand.d.ts +2 -2
- package/dist-types/commands/UpdateEmailIdentityPolicyCommand.d.ts +4 -5
- package/dist-types/commands/UpdateEmailTemplateCommand.d.ts +1 -1
- package/dist-types/models/models_0.d.ts +307 -231
- package/dist-types/ts3.4/models/models_0.d.ts +1 -0
- package/package.json +4 -4
|
@@ -21,24 +21,24 @@ export interface ReviewDetails {
|
|
|
21
21
|
/**
|
|
22
22
|
* <p>The status of the latest review of your account. The status can be one of the
|
|
23
23
|
* following:</p>
|
|
24
|
-
*
|
|
24
|
+
* <ul>
|
|
25
25
|
* <li>
|
|
26
|
-
*
|
|
26
|
+
* <p>
|
|
27
27
|
* <code>PENDING</code> – We have received your appeal and are in the
|
|
28
28
|
* process of reviewing it.</p>
|
|
29
29
|
* </li>
|
|
30
30
|
* <li>
|
|
31
|
-
*
|
|
31
|
+
* <p>
|
|
32
32
|
* <code>GRANTED</code> – Your appeal has been reviewed and your production
|
|
33
33
|
* access has been granted.</p>
|
|
34
34
|
* </li>
|
|
35
35
|
* <li>
|
|
36
|
-
*
|
|
36
|
+
* <p>
|
|
37
37
|
* <code>DENIED</code> – Your appeal has been reviewed and your production
|
|
38
38
|
* access has been denied.</p>
|
|
39
39
|
* </li>
|
|
40
40
|
* <li>
|
|
41
|
-
*
|
|
41
|
+
* <p>
|
|
42
42
|
* <code>FAILED</code> – An internal error occurred and we didn't receive
|
|
43
43
|
* your appeal. You can submit your appeal again.</p>
|
|
44
44
|
* </li>
|
|
@@ -57,14 +57,14 @@ export interface AccountDetails {
|
|
|
57
57
|
/**
|
|
58
58
|
* <p>The type of email your account is sending. The mail type can be one of the
|
|
59
59
|
* following:</p>
|
|
60
|
-
*
|
|
60
|
+
* <ul>
|
|
61
61
|
* <li>
|
|
62
|
-
*
|
|
62
|
+
* <p>
|
|
63
63
|
* <code>MARKETING</code> – Most of your sending traffic is to keep your
|
|
64
64
|
* customers informed of your latest offering.</p>
|
|
65
65
|
* </li>
|
|
66
66
|
* <li>
|
|
67
|
-
*
|
|
67
|
+
* <p>
|
|
68
68
|
* <code>TRANSACTIONAL</code> – Most of your sending traffic is to
|
|
69
69
|
* communicate during a transaction with a customer.</p>
|
|
70
70
|
* </li>
|
|
@@ -164,63 +164,63 @@ export interface BatchGetMetricDataQuery {
|
|
|
164
164
|
Namespace: MetricNamespace | string | undefined;
|
|
165
165
|
/**
|
|
166
166
|
* <p>The queried metric. This can be one of the following:</p>
|
|
167
|
-
*
|
|
167
|
+
* <ul>
|
|
168
168
|
* <li>
|
|
169
|
-
*
|
|
169
|
+
* <p>
|
|
170
170
|
* <code>SEND</code> – Emails sent eligible for tracking
|
|
171
171
|
* in the VDM dashboard. This excludes emails sent to the mailbox simulator and emails
|
|
172
172
|
* addressed to more than one recipient.</p>
|
|
173
173
|
* </li>
|
|
174
174
|
* <li>
|
|
175
|
-
*
|
|
175
|
+
* <p>
|
|
176
176
|
* <code>COMPLAINT</code> – Complaints received for your
|
|
177
177
|
* account. This excludes complaints from the mailbox simulator, those originating from
|
|
178
178
|
* your account-level suppression list (if enabled), and those for emails addressed to more
|
|
179
179
|
* than one recipient</p>
|
|
180
180
|
* </li>
|
|
181
181
|
* <li>
|
|
182
|
-
*
|
|
182
|
+
* <p>
|
|
183
183
|
* <code>PERMANENT_BOUNCE</code> – Permanent bounces - i.e. feedback received for
|
|
184
184
|
* emails sent to non-existent mailboxes. Excludes bounces from the mailbox simulator, those
|
|
185
185
|
* originating from your account-level suppression list (if enabled), and those for emails
|
|
186
186
|
* addressed to more than one recipient.</p>
|
|
187
187
|
* </li>
|
|
188
188
|
* <li>
|
|
189
|
-
*
|
|
189
|
+
* <p>
|
|
190
190
|
* <code>TRANSIENT_BOUNCE</code> – Transient bounces - i.e. feedback received for
|
|
191
191
|
* delivery failures excluding issues with non-existent mailboxes. Excludes bounces from the
|
|
192
192
|
* mailbox simulator, and those for emails addressed to more than one recipient.</p>
|
|
193
193
|
* </li>
|
|
194
194
|
* <li>
|
|
195
|
-
*
|
|
195
|
+
* <p>
|
|
196
196
|
* <code>OPEN</code> – Unique open events for emails including open trackers.
|
|
197
197
|
* Excludes opens for emails addressed to more than one recipient.</p>
|
|
198
198
|
* </li>
|
|
199
199
|
* <li>
|
|
200
|
-
*
|
|
200
|
+
* <p>
|
|
201
201
|
* <code>CLICK</code> – Unique click events for emails including wrapped links.
|
|
202
202
|
* Excludes clicks for emails addressed to more than one recipient.</p>
|
|
203
203
|
* </li>
|
|
204
204
|
* <li>
|
|
205
|
-
*
|
|
205
|
+
* <p>
|
|
206
206
|
* <code>DELIVERY</code> – Successful deliveries for email sending attempts.
|
|
207
207
|
* Excludes deliveries to the mailbox simulator and for emails addressed to more
|
|
208
208
|
* than one recipient.</p>
|
|
209
209
|
* </li>
|
|
210
210
|
* <li>
|
|
211
|
-
*
|
|
211
|
+
* <p>
|
|
212
212
|
* <code>DELIVERY_OPEN</code> – Successful deliveries for email sending attempts.
|
|
213
213
|
* Excludes deliveries to the mailbox simulator, for emails addressed to more than one recipient,
|
|
214
214
|
* and emails without open trackers.</p>
|
|
215
215
|
* </li>
|
|
216
216
|
* <li>
|
|
217
|
-
*
|
|
217
|
+
* <p>
|
|
218
218
|
* <code>DELIVERY_CLICK</code> – Successful deliveries for email sending attempts.
|
|
219
219
|
* Excludes deliveries to the mailbox simulator, for emails addressed to more than one recipient,
|
|
220
220
|
* and emails without click trackers.</p>
|
|
221
221
|
* </li>
|
|
222
222
|
* <li>
|
|
223
|
-
*
|
|
223
|
+
* <p>
|
|
224
224
|
* <code>DELIVERY_COMPLAINT</code> – Successful deliveries for email sending attempts.
|
|
225
225
|
* Excludes deliveries to the mailbox simulator, for emails addressed to more than one recipient,
|
|
226
226
|
* and emails addressed to recipients hosted by ISPs with which Amazon SES does not have a
|
|
@@ -266,13 +266,13 @@ export interface MetricDataError {
|
|
|
266
266
|
Id?: string;
|
|
267
267
|
/**
|
|
268
268
|
* <p>The query error code. Can be one of:</p>
|
|
269
|
-
*
|
|
269
|
+
* <ul>
|
|
270
270
|
* <li>
|
|
271
|
-
*
|
|
271
|
+
* <p>
|
|
272
272
|
* <code>INTERNAL_FAILURE</code> – Amazon SES has failed to process one of the queries.</p>
|
|
273
273
|
* </li>
|
|
274
274
|
* <li>
|
|
275
|
-
*
|
|
275
|
+
* <p>
|
|
276
276
|
* <code>ACCESS_DENIED</code> – You have insufficient access to retrieve metrics
|
|
277
277
|
* based on the given query.</p>
|
|
278
278
|
* </li>
|
|
@@ -440,14 +440,14 @@ export interface BulkEmailContent {
|
|
|
440
440
|
}
|
|
441
441
|
/**
|
|
442
442
|
* <p>An object that describes the recipients for an email.</p>
|
|
443
|
-
*
|
|
443
|
+
* <note>
|
|
444
444
|
* <p>Amazon SES does not support the SMTPUTF8 extension, as described in <a href="https://tools.ietf.org/html/rfc6531">RFC6531</a>. For this reason, the
|
|
445
445
|
* <i>local part</i> of a destination email address (the part of the
|
|
446
446
|
* email address that precedes the @ sign) may only contain <a href="https://en.wikipedia.org/wiki/Email_address#Local-part">7-bit ASCII
|
|
447
447
|
* characters</a>. If the <i>domain part</i> of an address (the
|
|
448
448
|
* part after the @ sign) contains non-ASCII characters, they must be encoded using
|
|
449
449
|
* Punycode, as described in <a href="https://tools.ietf.org/html/rfc3492.html">RFC3492</a>.</p>
|
|
450
|
-
*
|
|
450
|
+
* </note>
|
|
451
451
|
*/
|
|
452
452
|
export interface Destination {
|
|
453
453
|
/**
|
|
@@ -499,13 +499,13 @@ export interface MessageTag {
|
|
|
499
499
|
/**
|
|
500
500
|
* <p>The name of the message tag. The message tag name has to meet the following
|
|
501
501
|
* criteria:</p>
|
|
502
|
-
*
|
|
502
|
+
* <ul>
|
|
503
503
|
* <li>
|
|
504
|
-
*
|
|
504
|
+
* <p>It can only contain ASCII letters (a–z, A–Z), numbers (0–9),
|
|
505
505
|
* underscores (_), or dashes (-).</p>
|
|
506
506
|
* </li>
|
|
507
507
|
* <li>
|
|
508
|
-
*
|
|
508
|
+
* <p>It can contain no more than 256 characters.</p>
|
|
509
509
|
* </li>
|
|
510
510
|
* </ul>
|
|
511
511
|
*/
|
|
@@ -513,13 +513,13 @@ export interface MessageTag {
|
|
|
513
513
|
/**
|
|
514
514
|
* <p>The value of the message tag. The message tag value has to meet the following
|
|
515
515
|
* criteria:</p>
|
|
516
|
-
*
|
|
516
|
+
* <ul>
|
|
517
517
|
* <li>
|
|
518
|
-
*
|
|
518
|
+
* <p>It can only contain ASCII letters (a–z, A–Z), numbers (0–9),
|
|
519
519
|
* underscores (_), or dashes (-).</p>
|
|
520
520
|
* </li>
|
|
521
521
|
* <li>
|
|
522
|
-
*
|
|
522
|
+
* <p>It can contain no more than 256 characters.</p>
|
|
523
523
|
* </li>
|
|
524
524
|
* </ul>
|
|
525
525
|
*/
|
|
@@ -529,14 +529,14 @@ export interface BulkEmailEntry {
|
|
|
529
529
|
/**
|
|
530
530
|
* <p>Represents the destination of the message, consisting of To:, CC:, and BCC:
|
|
531
531
|
* fields.</p>
|
|
532
|
-
*
|
|
532
|
+
* <note>
|
|
533
533
|
* <p>Amazon SES does not support the SMTPUTF8 extension, as described in <a href="https://tools.ietf.org/html/rfc6531">RFC6531</a>. For this reason, the
|
|
534
534
|
* local part of a destination email address (the part of the email address that
|
|
535
535
|
* precedes the @ sign) may only contain <a href="https://en.wikipedia.org/wiki/Email_address#Local-part">7-bit ASCII
|
|
536
536
|
* characters</a>. If the domain part of an address (the part after the @ sign)
|
|
537
537
|
* contains non-ASCII characters, they must be encoded using Punycode, as described in
|
|
538
538
|
* <a href="https://tools.ietf.org/html/rfc3492.html">RFC3492</a>.</p>
|
|
539
|
-
*
|
|
539
|
+
* </note>
|
|
540
540
|
*/
|
|
541
541
|
Destination: Destination | undefined;
|
|
542
542
|
/**
|
|
@@ -576,62 +576,62 @@ export interface BulkEmailEntryResult {
|
|
|
576
576
|
/**
|
|
577
577
|
* <p>The status of a message sent using the <code>SendBulkTemplatedEmail</code>
|
|
578
578
|
* operation.</p>
|
|
579
|
-
*
|
|
580
|
-
*
|
|
579
|
+
* <p>Possible values for this parameter include:</p>
|
|
580
|
+
* <ul>
|
|
581
581
|
* <li>
|
|
582
|
-
*
|
|
582
|
+
* <p>SUCCESS: Amazon SES accepted the message, and will attempt to deliver it to
|
|
583
583
|
* the recipients.</p>
|
|
584
584
|
* </li>
|
|
585
585
|
* <li>
|
|
586
|
-
*
|
|
586
|
+
* <p>MESSAGE_REJECTED: The message was rejected because it contained a
|
|
587
587
|
* virus.</p>
|
|
588
588
|
* </li>
|
|
589
589
|
* <li>
|
|
590
|
-
*
|
|
590
|
+
* <p>MAIL_FROM_DOMAIN_NOT_VERIFIED: The sender's email address or domain was not
|
|
591
591
|
* verified.</p>
|
|
592
592
|
* </li>
|
|
593
593
|
* <li>
|
|
594
|
-
*
|
|
594
|
+
* <p>CONFIGURATION_SET_DOES_NOT_EXIST: The configuration set you specified does not
|
|
595
595
|
* exist.</p>
|
|
596
596
|
* </li>
|
|
597
597
|
* <li>
|
|
598
|
-
*
|
|
598
|
+
* <p>TEMPLATE_DOES_NOT_EXIST: The template you specified does not exist.</p>
|
|
599
599
|
* </li>
|
|
600
600
|
* <li>
|
|
601
|
-
*
|
|
601
|
+
* <p>ACCOUNT_SUSPENDED: Your account has been shut down because of issues related
|
|
602
602
|
* to your email sending practices.</p>
|
|
603
603
|
* </li>
|
|
604
604
|
* <li>
|
|
605
|
-
*
|
|
605
|
+
* <p>ACCOUNT_THROTTLED: The number of emails you can send has been reduced because
|
|
606
606
|
* your account has exceeded its allocated sending limit.</p>
|
|
607
607
|
* </li>
|
|
608
608
|
* <li>
|
|
609
|
-
*
|
|
609
|
+
* <p>ACCOUNT_DAILY_QUOTA_EXCEEDED: You have reached or exceeded the maximum number
|
|
610
610
|
* of emails you can send from your account in a 24-hour period.</p>
|
|
611
611
|
* </li>
|
|
612
612
|
* <li>
|
|
613
|
-
*
|
|
613
|
+
* <p>INVALID_SENDING_POOL_NAME: The configuration set you specified refers to an IP
|
|
614
614
|
* pool that does not exist.</p>
|
|
615
615
|
* </li>
|
|
616
616
|
* <li>
|
|
617
|
-
*
|
|
617
|
+
* <p>ACCOUNT_SENDING_PAUSED: Email sending for the Amazon SES account was disabled
|
|
618
618
|
* using the <a href="https://docs.aws.amazon.com/ses/latest/APIReference/API_UpdateAccountSendingEnabled.html">UpdateAccountSendingEnabled</a> operation.</p>
|
|
619
619
|
* </li>
|
|
620
620
|
* <li>
|
|
621
|
-
*
|
|
621
|
+
* <p>CONFIGURATION_SET_SENDING_PAUSED: Email sending for this configuration set was
|
|
622
622
|
* disabled using the <a href="https://docs.aws.amazon.com/ses/latest/APIReference/API_UpdateConfigurationSetSendingEnabled.html">UpdateConfigurationSetSendingEnabled</a> operation.</p>
|
|
623
623
|
* </li>
|
|
624
624
|
* <li>
|
|
625
|
-
*
|
|
625
|
+
* <p>INVALID_PARAMETER_VALUE: One or more of the parameters you specified when
|
|
626
626
|
* calling this operation was invalid. See the error message for additional
|
|
627
627
|
* information.</p>
|
|
628
628
|
* </li>
|
|
629
629
|
* <li>
|
|
630
|
-
*
|
|
630
|
+
* <p>TRANSIENT_FAILURE: Amazon SES was unable to process your request because of a
|
|
631
631
|
* temporary issue.</p>
|
|
632
632
|
* </li>
|
|
633
633
|
* <li>
|
|
634
|
-
*
|
|
634
|
+
* <p>FAILED: Amazon SES was unable to process your request. See the error message
|
|
635
635
|
* for additional information.</p>
|
|
636
636
|
* </li>
|
|
637
637
|
* </ul>
|
|
@@ -661,13 +661,13 @@ export interface CloudWatchDimensionConfiguration {
|
|
|
661
661
|
/**
|
|
662
662
|
* <p>The name of an Amazon CloudWatch dimension associated with an email sending metric. The name has to
|
|
663
663
|
* meet the following criteria:</p>
|
|
664
|
-
*
|
|
664
|
+
* <ul>
|
|
665
665
|
* <li>
|
|
666
|
-
*
|
|
666
|
+
* <p>It can only contain ASCII letters (a–z, A–Z), numbers (0–9),
|
|
667
667
|
* underscores (_), or dashes (-).</p>
|
|
668
668
|
* </li>
|
|
669
669
|
* <li>
|
|
670
|
-
*
|
|
670
|
+
* <p>It can contain no more than 256 characters.</p>
|
|
671
671
|
* </li>
|
|
672
672
|
* </ul>
|
|
673
673
|
*/
|
|
@@ -684,13 +684,13 @@ export interface CloudWatchDimensionConfiguration {
|
|
|
684
684
|
* <p>The default value of the dimension that is published to Amazon CloudWatch if you don't provide the
|
|
685
685
|
* value of the dimension when you send an email. This value has to meet the following
|
|
686
686
|
* criteria:</p>
|
|
687
|
-
*
|
|
687
|
+
* <ul>
|
|
688
688
|
* <li>
|
|
689
|
-
*
|
|
689
|
+
* <p>Can only contain ASCII letters (a–z, A–Z), numbers (0–9),
|
|
690
690
|
* underscores (_), or dashes (-), at signs (@), and periods (.).</p>
|
|
691
691
|
* </li>
|
|
692
692
|
* <li>
|
|
693
|
-
*
|
|
693
|
+
* <p>It can contain no more than 256 characters.</p>
|
|
694
694
|
* </li>
|
|
695
695
|
* </ul>
|
|
696
696
|
*/
|
|
@@ -802,13 +802,13 @@ export interface ContactListDestination {
|
|
|
802
802
|
/**
|
|
803
803
|
* <p>>The type of action to perform on the addresses. The following are the
|
|
804
804
|
* possible values:</p>
|
|
805
|
-
*
|
|
805
|
+
* <ul>
|
|
806
806
|
* <li>
|
|
807
|
-
*
|
|
807
|
+
* <p>PUT: add the addresses to the contact list. If the record already exists, it
|
|
808
808
|
* will override it with the new value.</p>
|
|
809
809
|
* </li>
|
|
810
810
|
* <li>
|
|
811
|
-
*
|
|
811
|
+
* <p>DELETE: remove the addresses from the contact list.</p>
|
|
812
812
|
* </li>
|
|
813
813
|
* </ul>
|
|
814
814
|
*/
|
|
@@ -876,15 +876,15 @@ export interface SuppressionOptions {
|
|
|
876
876
|
* <p>A list that contains the reasons that email addresses are automatically added to the
|
|
877
877
|
* suppression list for your account. This list can contain any or all of the
|
|
878
878
|
* following:</p>
|
|
879
|
-
*
|
|
879
|
+
* <ul>
|
|
880
880
|
* <li>
|
|
881
|
-
*
|
|
881
|
+
* <p>
|
|
882
882
|
* <code>COMPLAINT</code> – Amazon SES adds an email address to the suppression
|
|
883
883
|
* list for your account when a message sent to that address results in a
|
|
884
884
|
* complaint.</p>
|
|
885
885
|
* </li>
|
|
886
886
|
* <li>
|
|
887
|
-
*
|
|
887
|
+
* <p>
|
|
888
888
|
* <code>BOUNCE</code> – Amazon SES adds an email address to the suppression
|
|
889
889
|
* list for your account when a message sent to that address results in a hard
|
|
890
890
|
* bounce.</p>
|
|
@@ -899,29 +899,29 @@ export interface SuppressionOptions {
|
|
|
899
899
|
* a resource. Tags can help you categorize and manage resources in different ways, such as
|
|
900
900
|
* by purpose, owner, environment, or other criteria. A resource can have as many as 50
|
|
901
901
|
* tags.</p>
|
|
902
|
-
*
|
|
902
|
+
* <p>Each tag consists of a required <i>tag key</i> and an
|
|
903
903
|
* associated <i>tag value</i>, both of which you define. A tag key is a
|
|
904
904
|
* general label that acts as a category for a more specific tag value. A tag value acts as
|
|
905
905
|
* a descriptor within a tag key. A tag key can contain as many as 128 characters. A tag
|
|
906
906
|
* value can contain as many as 256 characters. The characters can be Unicode letters,
|
|
907
907
|
* digits, white space, or one of the following symbols: _ . : / = + -. The following
|
|
908
908
|
* additional restrictions apply to tags:</p>
|
|
909
|
-
*
|
|
909
|
+
* <ul>
|
|
910
910
|
* <li>
|
|
911
|
-
*
|
|
911
|
+
* <p>Tag keys and values are case sensitive.</p>
|
|
912
912
|
* </li>
|
|
913
913
|
* <li>
|
|
914
|
-
*
|
|
914
|
+
* <p>For each associated resource, each tag key must be unique and it can have only
|
|
915
915
|
* one value.</p>
|
|
916
916
|
* </li>
|
|
917
917
|
* <li>
|
|
918
|
-
*
|
|
918
|
+
* <p>The <code>aws:</code> prefix is reserved for use by Amazon Web Services; you can’t use it in
|
|
919
919
|
* any tag keys or values that you define. In addition, you can't edit or remove
|
|
920
920
|
* tag keys or values that use this prefix. Tags that use this prefix don’t count
|
|
921
921
|
* against the limit of 50 tags per resource.</p>
|
|
922
922
|
* </li>
|
|
923
923
|
* <li>
|
|
924
|
-
*
|
|
924
|
+
* <p>You can associate tags with public or shared resources, but the tags are
|
|
925
925
|
* available only for your Amazon Web Services account, not any other accounts that share the
|
|
926
926
|
* resource. In addition, the tags are available only for resources that are
|
|
927
927
|
* located in the specified Amazon Web Services Region for your Amazon Web Services account.</p>
|
|
@@ -947,7 +947,7 @@ export interface Tag {
|
|
|
947
947
|
* Amazon SES API v2 to send an email, it contains an invisible image that's used to track when
|
|
948
948
|
* recipients open your email. If your email contains links, those links are changed
|
|
949
949
|
* slightly in order to track when recipients click them.</p>
|
|
950
|
-
*
|
|
950
|
+
* <p>These images and links include references to a domain operated by Amazon Web Services. You can
|
|
951
951
|
* optionally configure the Amazon SES to use a domain that you operate for these images and
|
|
952
952
|
* links.</p>
|
|
953
953
|
*/
|
|
@@ -962,54 +962,64 @@ export declare enum FeatureStatus {
|
|
|
962
962
|
ENABLED = "ENABLED"
|
|
963
963
|
}
|
|
964
964
|
/**
|
|
965
|
-
* <p>An object containing additional settings for your VDM configuration as applicable to
|
|
965
|
+
* <p>An object containing additional settings for your VDM configuration as applicable to
|
|
966
|
+
* the Dashboard.</p>
|
|
966
967
|
*/
|
|
967
968
|
export interface DashboardOptions {
|
|
968
969
|
/**
|
|
969
|
-
* <p>Specifies the status of your VDM engagement metrics collection. Can be one of the
|
|
970
|
-
*
|
|
970
|
+
* <p>Specifies the status of your VDM engagement metrics collection. Can be one of the
|
|
971
|
+
* following:</p>
|
|
972
|
+
* <ul>
|
|
971
973
|
* <li>
|
|
972
|
-
*
|
|
973
|
-
* <code>ENABLED</code> – Amazon SES enables engagement metrics for the
|
|
974
|
+
* <p>
|
|
975
|
+
* <code>ENABLED</code> – Amazon SES enables engagement metrics for the
|
|
976
|
+
* configuration set.</p>
|
|
974
977
|
* </li>
|
|
975
978
|
* <li>
|
|
976
|
-
*
|
|
977
|
-
* <code>DISABLED</code> – Amazon SES disables engagement metrics for the
|
|
979
|
+
* <p>
|
|
980
|
+
* <code>DISABLED</code> – Amazon SES disables engagement metrics for the
|
|
981
|
+
* configuration set.</p>
|
|
978
982
|
* </li>
|
|
979
983
|
* </ul>
|
|
980
984
|
*/
|
|
981
985
|
EngagementMetrics?: FeatureStatus | string;
|
|
982
986
|
}
|
|
983
987
|
/**
|
|
984
|
-
* <p>An object containing additional settings for your VDM configuration as applicable to
|
|
988
|
+
* <p>An object containing additional settings for your VDM configuration as applicable to
|
|
989
|
+
* the Guardian.</p>
|
|
985
990
|
*/
|
|
986
991
|
export interface GuardianOptions {
|
|
987
992
|
/**
|
|
988
|
-
* <p>Specifies the status of your VDM optimized shared delivery. Can be one of the
|
|
989
|
-
*
|
|
993
|
+
* <p>Specifies the status of your VDM optimized shared delivery. Can be one of the
|
|
994
|
+
* following:</p>
|
|
995
|
+
* <ul>
|
|
990
996
|
* <li>
|
|
991
|
-
*
|
|
992
|
-
* <code>ENABLED</code> – Amazon SES enables optimized shared delivery for the
|
|
997
|
+
* <p>
|
|
998
|
+
* <code>ENABLED</code> – Amazon SES enables optimized shared delivery for the
|
|
999
|
+
* configuration set.</p>
|
|
993
1000
|
* </li>
|
|
994
1001
|
* <li>
|
|
995
|
-
*
|
|
996
|
-
* <code>DISABLED</code> – Amazon SES disables optimized shared delivery for the
|
|
1002
|
+
* <p>
|
|
1003
|
+
* <code>DISABLED</code> – Amazon SES disables optimized shared delivery for the
|
|
1004
|
+
* configuration set.</p>
|
|
997
1005
|
* </li>
|
|
998
1006
|
* </ul>
|
|
999
1007
|
*/
|
|
1000
1008
|
OptimizedSharedDelivery?: FeatureStatus | string;
|
|
1001
1009
|
}
|
|
1002
1010
|
/**
|
|
1003
|
-
* <p>An object that defines the VDM settings that apply to emails that you send
|
|
1004
|
-
*
|
|
1011
|
+
* <p>An object that defines the VDM settings that apply to emails that you send using the
|
|
1012
|
+
* configuration set.</p>
|
|
1005
1013
|
*/
|
|
1006
1014
|
export interface VdmOptions {
|
|
1007
1015
|
/**
|
|
1008
|
-
* <p>Specifies additional settings for your VDM configuration as applicable to the
|
|
1016
|
+
* <p>Specifies additional settings for your VDM configuration as applicable to the
|
|
1017
|
+
* Dashboard.</p>
|
|
1009
1018
|
*/
|
|
1010
1019
|
DashboardOptions?: DashboardOptions;
|
|
1011
1020
|
/**
|
|
1012
|
-
* <p>Specifies additional settings for your VDM configuration as applicable to the
|
|
1021
|
+
* <p>Specifies additional settings for your VDM configuration as applicable to the
|
|
1022
|
+
* Guardian.</p>
|
|
1013
1023
|
*/
|
|
1014
1024
|
GuardianOptions?: GuardianOptions;
|
|
1015
1025
|
}
|
|
@@ -1053,7 +1063,8 @@ export interface CreateConfigurationSetRequest {
|
|
|
1053
1063
|
*/
|
|
1054
1064
|
SuppressionOptions?: SuppressionOptions;
|
|
1055
1065
|
/**
|
|
1056
|
-
* <p>An object that defines the VDM options for emails that you send using the
|
|
1066
|
+
* <p>An object that defines the VDM options for emails that you send using the
|
|
1067
|
+
* configuration set.</p>
|
|
1057
1068
|
*/
|
|
1058
1069
|
VdmOptions?: VdmOptions;
|
|
1059
1070
|
}
|
|
@@ -1136,7 +1147,7 @@ export interface EventDestinationDefinition {
|
|
|
1136
1147
|
* <p>If <code>true</code>, the event destination is enabled. When the event destination is
|
|
1137
1148
|
* enabled, the specified event types are sent to the destinations in this
|
|
1138
1149
|
* <code>EventDestinationDefinition</code>.</p>
|
|
1139
|
-
*
|
|
1150
|
+
* <p>If <code>false</code>, the event destination is disabled. When the event destination
|
|
1140
1151
|
* is disabled, events aren't sent to the specified destinations.</p>
|
|
1141
1152
|
*/
|
|
1142
1153
|
Enabled?: boolean;
|
|
@@ -1334,30 +1345,30 @@ export interface CreateDedicatedIpPoolResponse {
|
|
|
1334
1345
|
export interface RawMessage {
|
|
1335
1346
|
/**
|
|
1336
1347
|
* <p>The raw email message. The message has to meet the following criteria:</p>
|
|
1337
|
-
*
|
|
1348
|
+
* <ul>
|
|
1338
1349
|
* <li>
|
|
1339
|
-
*
|
|
1350
|
+
* <p>The message has to contain a header and a body, separated by one blank
|
|
1340
1351
|
* line.</p>
|
|
1341
1352
|
* </li>
|
|
1342
1353
|
* <li>
|
|
1343
|
-
*
|
|
1354
|
+
* <p>All of the required header fields must be present in the message.</p>
|
|
1344
1355
|
* </li>
|
|
1345
1356
|
* <li>
|
|
1346
|
-
*
|
|
1357
|
+
* <p>Each part of a multipart MIME message must be formatted properly.</p>
|
|
1347
1358
|
* </li>
|
|
1348
1359
|
* <li>
|
|
1349
|
-
*
|
|
1360
|
+
* <p>Attachments must be in a file format that the Amazon SES supports.</p>
|
|
1350
1361
|
* </li>
|
|
1351
1362
|
* <li>
|
|
1352
|
-
*
|
|
1363
|
+
* <p>The entire message must be Base64 encoded.</p>
|
|
1353
1364
|
* </li>
|
|
1354
1365
|
* <li>
|
|
1355
|
-
*
|
|
1366
|
+
* <p>If any of the MIME parts in your message contain content that is outside of
|
|
1356
1367
|
* the 7-bit ASCII character range, you should encode that content to ensure that
|
|
1357
1368
|
* recipients' email clients render the message properly.</p>
|
|
1358
1369
|
* </li>
|
|
1359
1370
|
* <li>
|
|
1360
|
-
*
|
|
1371
|
+
* <p>The length of any single line of text in the message can't exceed 1,000
|
|
1361
1372
|
* characters. This restriction is defined in <a href="https://tools.ietf.org/html/rfc5321">RFC 5321</a>.</p>
|
|
1362
1373
|
* </li>
|
|
1363
1374
|
* </ul>
|
|
@@ -1395,32 +1406,32 @@ export interface EmailContent {
|
|
|
1395
1406
|
Simple?: Message;
|
|
1396
1407
|
/**
|
|
1397
1408
|
* <p>The raw email message. The message has to meet the following criteria:</p>
|
|
1398
|
-
*
|
|
1409
|
+
* <ul>
|
|
1399
1410
|
* <li>
|
|
1400
|
-
*
|
|
1411
|
+
* <p>The message has to contain a header and a body, separated by one blank
|
|
1401
1412
|
* line.</p>
|
|
1402
1413
|
* </li>
|
|
1403
1414
|
* <li>
|
|
1404
|
-
*
|
|
1415
|
+
* <p>All of the required header fields must be present in the message.</p>
|
|
1405
1416
|
* </li>
|
|
1406
1417
|
* <li>
|
|
1407
|
-
*
|
|
1418
|
+
* <p>Each part of a multipart MIME message must be formatted properly.</p>
|
|
1408
1419
|
* </li>
|
|
1409
1420
|
* <li>
|
|
1410
|
-
*
|
|
1421
|
+
* <p>If you include attachments, they must be in a file format that the Amazon SES API v2
|
|
1411
1422
|
* supports.
|
|
1412
1423
|
* </p>
|
|
1413
1424
|
* </li>
|
|
1414
1425
|
* <li>
|
|
1415
|
-
*
|
|
1426
|
+
* <p>The entire message must be Base64 encoded.</p>
|
|
1416
1427
|
* </li>
|
|
1417
1428
|
* <li>
|
|
1418
|
-
*
|
|
1429
|
+
* <p>If any of the MIME parts in your message contain content that is outside of
|
|
1419
1430
|
* the 7-bit ASCII character range, you should encode that content to ensure that
|
|
1420
1431
|
* recipients' email clients render the message properly.</p>
|
|
1421
1432
|
* </li>
|
|
1422
1433
|
* <li>
|
|
1423
|
-
*
|
|
1434
|
+
* <p>The length of any single line of text in the message can't exceed 1,000
|
|
1424
1435
|
* characters. This restriction is defined in <a href="https://tools.ietf.org/html/rfc5321">RFC 5321</a>.</p>
|
|
1425
1436
|
* </li>
|
|
1426
1437
|
* </ul>
|
|
@@ -1529,7 +1540,7 @@ export interface DkimSigningAttributes {
|
|
|
1529
1540
|
DomainSigningSelector?: string;
|
|
1530
1541
|
/**
|
|
1531
1542
|
* <p>[Bring Your Own DKIM] A private key that's used to generate a DKIM signature.</p>
|
|
1532
|
-
*
|
|
1543
|
+
* <p>The private key must use 1024 or 2048-bit RSA encryption, and must be encoded using
|
|
1533
1544
|
* base64 encoding.</p>
|
|
1534
1545
|
*/
|
|
1535
1546
|
DomainSigningPrivateKey?: string;
|
|
@@ -1557,7 +1568,7 @@ export interface CreateEmailIdentityRequest {
|
|
|
1557
1568
|
* Own DKIM (BYODKIM) for DKIM authentication purposes, or, configures the key length to be
|
|
1558
1569
|
* used for <a href="https://docs.aws.amazon.com/ses/latest/DeveloperGuide/easy-dkim.html">Easy
|
|
1559
1570
|
* DKIM</a>.</p>
|
|
1560
|
-
*
|
|
1571
|
+
* <p>You can only specify this object if the email identity is a domain, as opposed to an
|
|
1561
1572
|
* address.</p>
|
|
1562
1573
|
*/
|
|
1563
1574
|
DkimSigningAttributes?: DkimSigningAttributes;
|
|
@@ -1581,7 +1592,7 @@ export declare enum DkimStatus {
|
|
|
1581
1592
|
/**
|
|
1582
1593
|
* <p>An object that contains information about the DKIM authentication status for an email
|
|
1583
1594
|
* identity.</p>
|
|
1584
|
-
*
|
|
1595
|
+
* <p>Amazon SES determines the authentication status by searching for specific records in the
|
|
1585
1596
|
* DNS configuration for the domain. If you used <a href="https://docs.aws.amazon.com/ses/latest/DeveloperGuide/easy-dkim.html">Easy DKIM</a> to set up DKIM
|
|
1586
1597
|
* authentication, Amazon SES tries to find three unique CNAME records in the DNS configuration
|
|
1587
1598
|
* for your domain. If you provided a public key to perform DKIM authentication, Amazon SES
|
|
@@ -1599,31 +1610,31 @@ export interface DkimAttributes {
|
|
|
1599
1610
|
/**
|
|
1600
1611
|
* <p>Describes whether or not Amazon SES has successfully located the DKIM records in the DNS
|
|
1601
1612
|
* records for the domain. The status can be one of the following:</p>
|
|
1602
|
-
*
|
|
1613
|
+
* <ul>
|
|
1603
1614
|
* <li>
|
|
1604
|
-
*
|
|
1615
|
+
* <p>
|
|
1605
1616
|
* <code>PENDING</code> – The verification process was initiated, but Amazon SES
|
|
1606
1617
|
* hasn't yet detected the DKIM records in the DNS configuration for the
|
|
1607
1618
|
* domain.</p>
|
|
1608
1619
|
* </li>
|
|
1609
1620
|
* <li>
|
|
1610
|
-
*
|
|
1621
|
+
* <p>
|
|
1611
1622
|
* <code>SUCCESS</code> – The verification process completed
|
|
1612
1623
|
* successfully.</p>
|
|
1613
1624
|
* </li>
|
|
1614
1625
|
* <li>
|
|
1615
|
-
*
|
|
1626
|
+
* <p>
|
|
1616
1627
|
* <code>FAILED</code> – The verification process failed. This typically
|
|
1617
1628
|
* occurs when Amazon SES fails to find the DKIM records in the DNS configuration of the
|
|
1618
1629
|
* domain.</p>
|
|
1619
1630
|
* </li>
|
|
1620
1631
|
* <li>
|
|
1621
|
-
*
|
|
1632
|
+
* <p>
|
|
1622
1633
|
* <code>TEMPORARY_FAILURE</code> – A temporary issue is preventing Amazon SES
|
|
1623
1634
|
* from determining the DKIM authentication status of the domain.</p>
|
|
1624
1635
|
* </li>
|
|
1625
1636
|
* <li>
|
|
1626
|
-
*
|
|
1637
|
+
* <p>
|
|
1627
1638
|
* <code>NOT_STARTED</code> – The DKIM verification process hasn't been
|
|
1628
1639
|
* initiated for the domain.</p>
|
|
1629
1640
|
* </li>
|
|
@@ -1635,24 +1646,24 @@ export interface DkimAttributes {
|
|
|
1635
1646
|
* contains a set of unique strings that you use to create a set of CNAME records that you
|
|
1636
1647
|
* add to the DNS configuration for your domain. When Amazon SES detects these records in the
|
|
1637
1648
|
* DNS configuration for your domain, the DKIM authentication process is complete.</p>
|
|
1638
|
-
*
|
|
1649
|
+
* <p>If you configured DKIM authentication for the domain by providing your own
|
|
1639
1650
|
* public-private key pair, then this object contains the selector for the public
|
|
1640
1651
|
* key.</p>
|
|
1641
|
-
*
|
|
1652
|
+
* <p>Regardless of the DKIM authentication method you use, Amazon SES searches for the
|
|
1642
1653
|
* appropriate records in the DNS configuration of the domain for up to 72 hours.</p>
|
|
1643
1654
|
*/
|
|
1644
1655
|
Tokens?: string[];
|
|
1645
1656
|
/**
|
|
1646
1657
|
* <p>A string that indicates how DKIM was configured for the identity. These are the
|
|
1647
1658
|
* possible values:</p>
|
|
1648
|
-
*
|
|
1659
|
+
* <ul>
|
|
1649
1660
|
* <li>
|
|
1650
|
-
*
|
|
1661
|
+
* <p>
|
|
1651
1662
|
* <code>AWS_SES</code> – Indicates that DKIM was configured for the
|
|
1652
1663
|
* identity by using <a href="https://docs.aws.amazon.com/ses/latest/DeveloperGuide/easy-dkim.html">Easy DKIM</a>.</p>
|
|
1653
1664
|
* </li>
|
|
1654
1665
|
* <li>
|
|
1655
|
-
*
|
|
1666
|
+
* <p>
|
|
1656
1667
|
* <code>EXTERNAL</code> – Indicates that DKIM was configured for the
|
|
1657
1668
|
* identity by using Bring Your Own DKIM (BYODKIM).</p>
|
|
1658
1669
|
* </li>
|
|
@@ -1680,7 +1691,7 @@ export declare enum IdentityType {
|
|
|
1680
1691
|
/**
|
|
1681
1692
|
* <p>If the email identity is a domain, this object contains information about the DKIM
|
|
1682
1693
|
* verification status for the domain.</p>
|
|
1683
|
-
*
|
|
1694
|
+
* <p>If the email identity is an email address, this object is empty. </p>
|
|
1684
1695
|
*/
|
|
1685
1696
|
export interface CreateEmailIdentityResponse {
|
|
1686
1697
|
/**
|
|
@@ -1711,14 +1722,13 @@ export interface CreateEmailIdentityPolicyRequest {
|
|
|
1711
1722
|
EmailIdentity: string | undefined;
|
|
1712
1723
|
/**
|
|
1713
1724
|
* <p>The name of the policy.</p>
|
|
1714
|
-
*
|
|
1715
|
-
* <p>The policy name cannot exceed 64 characters and can only include alphanumeric
|
|
1725
|
+
* <p>The policy name cannot exceed 64 characters and can only include alphanumeric
|
|
1716
1726
|
* characters, dashes, and underscores.</p>
|
|
1717
1727
|
*/
|
|
1718
1728
|
PolicyName: string | undefined;
|
|
1719
1729
|
/**
|
|
1720
1730
|
* <p>The text of the policy in JSON format. The policy cannot exceed 4 KB.</p>
|
|
1721
|
-
*
|
|
1731
|
+
* <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
|
|
1722
1732
|
* Guide</a>.</p>
|
|
1723
1733
|
*/
|
|
1724
1734
|
Policy: string | undefined;
|
|
@@ -1797,13 +1807,13 @@ export declare enum SuppressionListImportAction {
|
|
|
1797
1807
|
export interface SuppressionListDestination {
|
|
1798
1808
|
/**
|
|
1799
1809
|
* <p>The type of action to perform on the address. The following are possible values:</p>
|
|
1800
|
-
*
|
|
1810
|
+
* <ul>
|
|
1801
1811
|
* <li>
|
|
1802
|
-
*
|
|
1812
|
+
* <p>PUT: add the addresses to the suppression list. If the record already exists,
|
|
1803
1813
|
* it will override it with the new value.</p>
|
|
1804
1814
|
* </li>
|
|
1805
1815
|
* <li>
|
|
1806
|
-
*
|
|
1816
|
+
* <p>DELETE: remove the addresses from the suppression list.</p>
|
|
1807
1817
|
* </li>
|
|
1808
1818
|
* </ul>
|
|
1809
1819
|
*/
|
|
@@ -1955,13 +1965,13 @@ export interface DailyVolume {
|
|
|
1955
1965
|
export interface DashboardAttributes {
|
|
1956
1966
|
/**
|
|
1957
1967
|
* <p>Specifies the status of your VDM engagement metrics collection. Can be one of the following:</p>
|
|
1958
|
-
*
|
|
1968
|
+
* <ul>
|
|
1959
1969
|
* <li>
|
|
1960
|
-
*
|
|
1970
|
+
* <p>
|
|
1961
1971
|
* <code>ENABLED</code> – Amazon SES enables engagement metrics for your account.</p>
|
|
1962
1972
|
* </li>
|
|
1963
1973
|
* <li>
|
|
1964
|
-
*
|
|
1974
|
+
* <p>
|
|
1965
1975
|
* <code>DISABLED</code> – Amazon SES disables engagement metrics for your account.</p>
|
|
1966
1976
|
* </li>
|
|
1967
1977
|
* </ul>
|
|
@@ -1975,7 +1985,7 @@ export declare enum WarmupStatus {
|
|
|
1975
1985
|
/**
|
|
1976
1986
|
* <p>Contains information about a dedicated IP address that is associated with your Amazon SES
|
|
1977
1987
|
* account.</p>
|
|
1978
|
-
*
|
|
1988
|
+
* <p>To learn more about requesting dedicated IP addresses, see <a href="https://docs.aws.amazon.com/ses/latest/DeveloperGuide/dedicated-ip-case.html">Requesting and Relinquishing
|
|
1979
1989
|
* Dedicated IP Addresses</a> in the <i>Amazon SES Developer
|
|
1980
1990
|
* Guide</i>.</p>
|
|
1981
1991
|
*/
|
|
@@ -1987,14 +1997,14 @@ export interface DedicatedIp {
|
|
|
1987
1997
|
/**
|
|
1988
1998
|
* <p>The warm-up status of a dedicated IP address. The status can have one of the following
|
|
1989
1999
|
* values:</p>
|
|
1990
|
-
*
|
|
2000
|
+
* <ul>
|
|
1991
2001
|
* <li>
|
|
1992
|
-
*
|
|
2002
|
+
* <p>
|
|
1993
2003
|
* <code>IN_PROGRESS</code> – The IP address isn't ready to use because the
|
|
1994
2004
|
* dedicated IP warm-up process is ongoing.</p>
|
|
1995
2005
|
* </li>
|
|
1996
2006
|
* <li>
|
|
1997
|
-
*
|
|
2007
|
+
* <p>
|
|
1998
2008
|
* <code>DONE</code> – The dedicated IP warm-up process is complete, and
|
|
1999
2009
|
* the IP address is ready to use.</p>
|
|
2000
2010
|
* </li>
|
|
@@ -2021,13 +2031,13 @@ export interface DedicatedIpPool {
|
|
|
2021
2031
|
PoolName: string | undefined;
|
|
2022
2032
|
/**
|
|
2023
2033
|
* <p>The type of the dedicated IP pool.</p>
|
|
2024
|
-
*
|
|
2034
|
+
* <ul>
|
|
2025
2035
|
* <li>
|
|
2026
|
-
*
|
|
2036
|
+
* <p>
|
|
2027
2037
|
* <code>STANDARD</code> – A dedicated IP pool where the customer can control which IPs are part of the pool.</p>
|
|
2028
2038
|
* </li>
|
|
2029
2039
|
* <li>
|
|
2030
|
-
*
|
|
2040
|
+
* <p>
|
|
2031
2041
|
* <code>MANAGED</code> – A dedicated IP pool where the reputation and number of IPs is automatically managed by Amazon SES.</p>
|
|
2032
2042
|
* </li>
|
|
2033
2043
|
* </ul>
|
|
@@ -2148,8 +2158,7 @@ export interface DeleteEmailIdentityPolicyRequest {
|
|
|
2148
2158
|
EmailIdentity: string | undefined;
|
|
2149
2159
|
/**
|
|
2150
2160
|
* <p>The name of the policy.</p>
|
|
2151
|
-
*
|
|
2152
|
-
* <p>The policy name cannot exceed 64 characters and can only include alphanumeric
|
|
2161
|
+
* <p>The policy name cannot exceed 64 characters and can only include alphanumeric
|
|
2153
2162
|
* characters, dashes, and underscores.</p>
|
|
2154
2163
|
*/
|
|
2155
2164
|
PolicyName: string | undefined;
|
|
@@ -2374,12 +2383,79 @@ export interface EventDestination {
|
|
|
2374
2383
|
* <p>If <code>true</code>, the event destination is enabled. When the event destination is
|
|
2375
2384
|
* enabled, the specified event types are sent to the destinations in this
|
|
2376
2385
|
* <code>EventDestinationDefinition</code>.</p>
|
|
2377
|
-
*
|
|
2386
|
+
* <p>If <code>false</code>, the event destination is disabled. When the event destination
|
|
2378
2387
|
* is disabled, events aren't sent to the specified destinations.</p>
|
|
2379
2388
|
*/
|
|
2380
2389
|
Enabled?: boolean;
|
|
2381
2390
|
/**
|
|
2382
2391
|
* <p>The types of events that Amazon SES sends to the specified event destinations.</p>
|
|
2392
|
+
* <ul>
|
|
2393
|
+
* <li>
|
|
2394
|
+
* <p>
|
|
2395
|
+
* <code>SEND</code> - The send request was successful and SES will
|
|
2396
|
+
* attempt to deliver the message to the recipient’s mail server. (If account-level
|
|
2397
|
+
* or global suppression is being used, SES will still count it as a send,
|
|
2398
|
+
* but delivery is suppressed.)</p>
|
|
2399
|
+
* </li>
|
|
2400
|
+
* <li>
|
|
2401
|
+
* <p>
|
|
2402
|
+
* <code>REJECT</code> - SES accepted the email, but determined that it
|
|
2403
|
+
* contained a virus and didn’t attempt to deliver it to the recipient’s mail
|
|
2404
|
+
* server.</p>
|
|
2405
|
+
* </li>
|
|
2406
|
+
* <li>
|
|
2407
|
+
* <p>
|
|
2408
|
+
* <code>BOUNCE</code> - (<i>Hard bounce</i>) The recipient's
|
|
2409
|
+
* mail server permanently rejected the email. (<i>Soft bounces</i>
|
|
2410
|
+
* are only included when SES fails to deliver the email after retrying for
|
|
2411
|
+
* a period of time.)</p>
|
|
2412
|
+
* </li>
|
|
2413
|
+
* <li>
|
|
2414
|
+
* <p>
|
|
2415
|
+
* <code>COMPLAINT</code> - The email was successfully delivered to the
|
|
2416
|
+
* recipient’s mail server, but the recipient marked it as spam.</p>
|
|
2417
|
+
* </li>
|
|
2418
|
+
* <li>
|
|
2419
|
+
* <p>
|
|
2420
|
+
* <code>DELIVERY</code> - SES successfully delivered the email to the
|
|
2421
|
+
* recipient's mail server.</p>
|
|
2422
|
+
* </li>
|
|
2423
|
+
* <li>
|
|
2424
|
+
* <p>
|
|
2425
|
+
* <code>OPEN</code> - The recipient received the message and opened it in their
|
|
2426
|
+
* email client.</p>
|
|
2427
|
+
* </li>
|
|
2428
|
+
* <li>
|
|
2429
|
+
* <p>
|
|
2430
|
+
* <code>CLICK</code> - The recipient clicked one or more links in the
|
|
2431
|
+
* email.</p>
|
|
2432
|
+
* </li>
|
|
2433
|
+
* <li>
|
|
2434
|
+
* <p>
|
|
2435
|
+
* <code>RENDERING_FAILURE</code> - The email wasn't sent because of a
|
|
2436
|
+
* template rendering issue. This event type can occur when template data is
|
|
2437
|
+
* missing, or when there is a mismatch between template parameters and data. (This
|
|
2438
|
+
* event type only occurs when you send email using the <a href="https://docs.aws.amazon.com/ses/latest/APIReference/API_SendTemplatedEmail.html">
|
|
2439
|
+
* <code>SendTemplatedEmail</code>
|
|
2440
|
+
* </a> or <a href="https://docs.aws.amazon.com/ses/latest/APIReference/API_SendBulkTemplatedEmail.html">
|
|
2441
|
+
* <code>SendBulkTemplatedEmail</code>
|
|
2442
|
+
* </a> API operations.) </p>
|
|
2443
|
+
* </li>
|
|
2444
|
+
* <li>
|
|
2445
|
+
* <p>
|
|
2446
|
+
* <code>DELIVERY_DELAY</code> - The email couldn't be delivered to the
|
|
2447
|
+
* recipient’s mail server because a temporary issue occurred. Delivery delays can
|
|
2448
|
+
* occur, for example, when the recipient's inbox is full, or when the
|
|
2449
|
+
* receiving email server experiences a transient issue.</p>
|
|
2450
|
+
* </li>
|
|
2451
|
+
* <li>
|
|
2452
|
+
* <p>
|
|
2453
|
+
* <code>SUBSCRIPTION</code> - The email was successfully delivered, but the
|
|
2454
|
+
* recipient updated their subscription preferences by clicking on an
|
|
2455
|
+
* <i>unsubscribe</i> link as part of your <a href="https://docs.aws.amazon.com/ses/latest/dg/sending-email-subscription-management.html">subscription
|
|
2456
|
+
* management</a>.</p>
|
|
2457
|
+
* </li>
|
|
2458
|
+
* </ul>
|
|
2383
2459
|
*/
|
|
2384
2460
|
MatchingEventTypes: (EventType | string)[] | undefined;
|
|
2385
2461
|
/**
|
|
@@ -2457,15 +2533,15 @@ export interface SuppressionAttributes {
|
|
|
2457
2533
|
* <p>A list that contains the reasons that email addresses will be automatically added to
|
|
2458
2534
|
* the suppression list for your account. This list can contain any or all of the
|
|
2459
2535
|
* following:</p>
|
|
2460
|
-
*
|
|
2536
|
+
* <ul>
|
|
2461
2537
|
* <li>
|
|
2462
|
-
*
|
|
2538
|
+
* <p>
|
|
2463
2539
|
* <code>COMPLAINT</code> – Amazon SES adds an email address to the suppression
|
|
2464
2540
|
* list for your account when a message sent to that address results in a
|
|
2465
2541
|
* complaint.</p>
|
|
2466
2542
|
* </li>
|
|
2467
2543
|
* <li>
|
|
2468
|
-
*
|
|
2544
|
+
* <p>
|
|
2469
2545
|
* <code>BOUNCE</code> – Amazon SES adds an email address to the suppression
|
|
2470
2546
|
* list for your account when a message sent to that address results in a hard
|
|
2471
2547
|
* bounce.</p>
|
|
@@ -2480,13 +2556,13 @@ export interface SuppressionAttributes {
|
|
|
2480
2556
|
export interface GuardianAttributes {
|
|
2481
2557
|
/**
|
|
2482
2558
|
* <p>Specifies the status of your VDM optimized shared delivery. Can be one of the following:</p>
|
|
2483
|
-
*
|
|
2559
|
+
* <ul>
|
|
2484
2560
|
* <li>
|
|
2485
|
-
*
|
|
2561
|
+
* <p>
|
|
2486
2562
|
* <code>ENABLED</code> – Amazon SES enables optimized shared delivery for your account.</p>
|
|
2487
2563
|
* </li>
|
|
2488
2564
|
* <li>
|
|
2489
|
-
*
|
|
2565
|
+
* <p>
|
|
2490
2566
|
* <code>DISABLED</code> – Amazon SES disables optimized shared delivery for your account.</p>
|
|
2491
2567
|
* </li>
|
|
2492
2568
|
* </ul>
|
|
@@ -2499,13 +2575,13 @@ export interface GuardianAttributes {
|
|
|
2499
2575
|
export interface VdmAttributes {
|
|
2500
2576
|
/**
|
|
2501
2577
|
* <p>Specifies the status of your VDM configuration. Can be one of the following:</p>
|
|
2502
|
-
*
|
|
2578
|
+
* <ul>
|
|
2503
2579
|
* <li>
|
|
2504
|
-
*
|
|
2580
|
+
* <p>
|
|
2505
2581
|
* <code>ENABLED</code> – Amazon SES enables VDM for your account.</p>
|
|
2506
2582
|
* </li>
|
|
2507
2583
|
* <li>
|
|
2508
|
-
*
|
|
2584
|
+
* <p>
|
|
2509
2585
|
* <code>DISABLED</code> – Amazon SES disables VDM for your account.</p>
|
|
2510
2586
|
* </li>
|
|
2511
2587
|
* </ul>
|
|
@@ -2533,20 +2609,20 @@ export interface GetAccountResponse {
|
|
|
2533
2609
|
/**
|
|
2534
2610
|
* <p>The reputation status of your Amazon SES account. The status can be one of the
|
|
2535
2611
|
* following:</p>
|
|
2536
|
-
*
|
|
2612
|
+
* <ul>
|
|
2537
2613
|
* <li>
|
|
2538
|
-
*
|
|
2614
|
+
* <p>
|
|
2539
2615
|
* <code>HEALTHY</code> – There are no reputation-related issues that
|
|
2540
2616
|
* currently impact your account.</p>
|
|
2541
2617
|
* </li>
|
|
2542
2618
|
* <li>
|
|
2543
|
-
*
|
|
2619
|
+
* <p>
|
|
2544
2620
|
* <code>PROBATION</code> – We've identified potential issues with your
|
|
2545
2621
|
* Amazon SES account. We're placing your account under review while you work on
|
|
2546
2622
|
* correcting these issues.</p>
|
|
2547
2623
|
* </li>
|
|
2548
2624
|
* <li>
|
|
2549
|
-
*
|
|
2625
|
+
* <p>
|
|
2550
2626
|
* <code>SHUTDOWN</code> – Your account's ability to send email is
|
|
2551
2627
|
* currently paused because of an issue with the email sent from your account. When
|
|
2552
2628
|
* you correct the issue, you can contact us and request that your account's
|
|
@@ -2558,12 +2634,12 @@ export interface GetAccountResponse {
|
|
|
2558
2634
|
/**
|
|
2559
2635
|
* <p>Indicates whether or not your account has production access in the current Amazon Web Services
|
|
2560
2636
|
* Region.</p>
|
|
2561
|
-
*
|
|
2637
|
+
* <p>If the value is <code>false</code>, then your account is in the
|
|
2562
2638
|
* <i>sandbox</i>. When your account is in the sandbox, you can only send
|
|
2563
2639
|
* email to verified identities. Additionally, the maximum number of emails you can send in
|
|
2564
2640
|
* a 24-hour period (your sending quota) is 200, and the maximum number of emails you can
|
|
2565
2641
|
* send per second (your maximum sending rate) is 1.</p>
|
|
2566
|
-
*
|
|
2642
|
+
* <p>If the value is <code>true</code>, then your account has production access. When your
|
|
2567
2643
|
* account has production access, you can send email to any address. The sending quota and
|
|
2568
2644
|
* maximum sending rate for your account vary based on your specific use case.</p>
|
|
2569
2645
|
*/
|
|
@@ -2662,7 +2738,8 @@ export interface GetConfigurationSetResponse {
|
|
|
2662
2738
|
*/
|
|
2663
2739
|
SuppressionOptions?: SuppressionOptions;
|
|
2664
2740
|
/**
|
|
2665
|
-
* <p>An object that contains information about the VDM preferences for your configuration
|
|
2741
|
+
* <p>An object that contains information about the VDM preferences for your configuration
|
|
2742
|
+
* set.</p>
|
|
2666
2743
|
*/
|
|
2667
2744
|
VdmOptions?: VdmOptions;
|
|
2668
2745
|
}
|
|
@@ -2883,8 +2960,7 @@ export interface GetDedicatedIpsResponse {
|
|
|
2883
2960
|
* <p>Retrieve information about the status of the Deliverability dashboard for your Amazon Web Services account.
|
|
2884
2961
|
* When the Deliverability dashboard is enabled, you gain access to reputation, deliverability, and
|
|
2885
2962
|
* other metrics for your domains. You also gain the ability to perform predictive inbox placement tests.</p>
|
|
2886
|
-
*
|
|
2887
|
-
* <p>When you use the Deliverability dashboard, you pay a monthly subscription charge, in addition
|
|
2963
|
+
* <p>When you use the Deliverability dashboard, you pay a monthly subscription charge, in addition
|
|
2888
2964
|
* to any other fees that you accrue by using Amazon SES and other Amazon Web Services services. For more
|
|
2889
2965
|
* information about the features and cost of a Deliverability dashboard subscription, see <a href="http://aws.amazon.com/pinpoint/pricing/">Amazon Pinpoint Pricing</a>.</p>
|
|
2890
2966
|
*/
|
|
@@ -3115,24 +3191,24 @@ export interface MailFromAttributes {
|
|
|
3115
3191
|
MailFromDomain: string | undefined;
|
|
3116
3192
|
/**
|
|
3117
3193
|
* <p>The status of the MAIL FROM domain. This status can have the following values:</p>
|
|
3118
|
-
*
|
|
3194
|
+
* <ul>
|
|
3119
3195
|
* <li>
|
|
3120
|
-
*
|
|
3196
|
+
* <p>
|
|
3121
3197
|
* <code>PENDING</code> – Amazon SES hasn't started searching for the MX record
|
|
3122
3198
|
* yet.</p>
|
|
3123
3199
|
* </li>
|
|
3124
3200
|
* <li>
|
|
3125
|
-
*
|
|
3201
|
+
* <p>
|
|
3126
3202
|
* <code>SUCCESS</code> – Amazon SES detected the required MX record for the
|
|
3127
3203
|
* MAIL FROM domain.</p>
|
|
3128
3204
|
* </li>
|
|
3129
3205
|
* <li>
|
|
3130
|
-
*
|
|
3206
|
+
* <p>
|
|
3131
3207
|
* <code>FAILED</code> – Amazon SES can't find the required MX record, or the
|
|
3132
3208
|
* record no longer exists.</p>
|
|
3133
3209
|
* </li>
|
|
3134
3210
|
* <li>
|
|
3135
|
-
*
|
|
3211
|
+
* <p>
|
|
3136
3212
|
* <code>TEMPORARY_FAILURE</code> – A temporary issue occurred, which
|
|
3137
3213
|
* prevented Amazon SES from determining the status of the MAIL FROM domain.</p>
|
|
3138
3214
|
* </li>
|
|
@@ -3146,7 +3222,7 @@ export interface MailFromAttributes {
|
|
|
3146
3222
|
* to <code>REJECT_MESSAGE</code>, the Amazon SES API v2 returns a
|
|
3147
3223
|
* <code>MailFromDomainNotVerified</code> error, and doesn't attempt to deliver the
|
|
3148
3224
|
* email.</p>
|
|
3149
|
-
*
|
|
3225
|
+
* <p>These behaviors are taken when the custom MAIL FROM domain configuration is in the
|
|
3150
3226
|
* <code>Pending</code>, <code>Failed</code>, and <code>TemporaryFailure</code>
|
|
3151
3227
|
* states.</p>
|
|
3152
3228
|
*/
|
|
@@ -3170,10 +3246,10 @@ export interface GetEmailIdentityResponse {
|
|
|
3170
3246
|
IdentityType?: IdentityType | string;
|
|
3171
3247
|
/**
|
|
3172
3248
|
* <p>The feedback forwarding configuration for the identity.</p>
|
|
3173
|
-
*
|
|
3249
|
+
* <p>If the value is <code>true</code>, you receive email notifications when bounce or
|
|
3174
3250
|
* complaint events occur. These notifications are sent to the address that you specified
|
|
3175
3251
|
* in the <code>Return-Path</code> header of the original email.</p>
|
|
3176
|
-
*
|
|
3252
|
+
* <p>You're required to have a method of tracking bounces and complaints. If you haven't
|
|
3177
3253
|
* set up another mechanism for receiving bounce or complaint notifications (for example,
|
|
3178
3254
|
* by setting up an event destination), you receive an email notification when these events
|
|
3179
3255
|
* occur (even if this setting is disabled).</p>
|
|
@@ -3209,28 +3285,28 @@ export interface GetEmailIdentityResponse {
|
|
|
3209
3285
|
ConfigurationSetName?: string;
|
|
3210
3286
|
/**
|
|
3211
3287
|
* <p>The verification status of the identity. The status can be one of the following:</p>
|
|
3212
|
-
*
|
|
3288
|
+
* <ul>
|
|
3213
3289
|
* <li>
|
|
3214
|
-
*
|
|
3290
|
+
* <p>
|
|
3215
3291
|
* <code>PENDING</code> – The verification process was initiated, but Amazon SES
|
|
3216
3292
|
* hasn't yet been able to verify the identity.</p>
|
|
3217
3293
|
* </li>
|
|
3218
3294
|
* <li>
|
|
3219
|
-
*
|
|
3295
|
+
* <p>
|
|
3220
3296
|
* <code>SUCCESS</code> – The verification process completed
|
|
3221
3297
|
* successfully.</p>
|
|
3222
3298
|
* </li>
|
|
3223
3299
|
* <li>
|
|
3224
|
-
*
|
|
3300
|
+
* <p>
|
|
3225
3301
|
* <code>FAILED</code> – The verification process failed.</p>
|
|
3226
3302
|
* </li>
|
|
3227
3303
|
* <li>
|
|
3228
|
-
*
|
|
3304
|
+
* <p>
|
|
3229
3305
|
* <code>TEMPORARY_FAILURE</code> – A temporary issue is preventing Amazon SES
|
|
3230
3306
|
* from determining the verification status of the identity.</p>
|
|
3231
3307
|
* </li>
|
|
3232
3308
|
* <li>
|
|
3233
|
-
*
|
|
3309
|
+
* <p>
|
|
3234
3310
|
* <code>NOT_STARTED</code> – The verification process hasn't been
|
|
3235
3311
|
* initiated for the identity.</p>
|
|
3236
3312
|
* </li>
|
|
@@ -3413,35 +3489,35 @@ export interface IdentityInfo {
|
|
|
3413
3489
|
IdentityName?: string;
|
|
3414
3490
|
/**
|
|
3415
3491
|
* <p>Indicates whether or not you can send email from the identity.</p>
|
|
3416
|
-
*
|
|
3492
|
+
* <p>An <i>identity</i> is an email address or domain that you send email
|
|
3417
3493
|
* from. Before you can send email from an identity, you have to demostrate that you own
|
|
3418
3494
|
* the identity, and that you authorize Amazon SES to send email from that identity.</p>
|
|
3419
3495
|
*/
|
|
3420
3496
|
SendingEnabled?: boolean;
|
|
3421
3497
|
/**
|
|
3422
3498
|
* <p>The verification status of the identity. The status can be one of the following:</p>
|
|
3423
|
-
*
|
|
3499
|
+
* <ul>
|
|
3424
3500
|
* <li>
|
|
3425
|
-
*
|
|
3501
|
+
* <p>
|
|
3426
3502
|
* <code>PENDING</code> – The verification process was initiated, but Amazon SES
|
|
3427
3503
|
* hasn't yet been able to verify the identity.</p>
|
|
3428
3504
|
* </li>
|
|
3429
3505
|
* <li>
|
|
3430
|
-
*
|
|
3506
|
+
* <p>
|
|
3431
3507
|
* <code>SUCCESS</code> – The verification process completed
|
|
3432
3508
|
* successfully.</p>
|
|
3433
3509
|
* </li>
|
|
3434
3510
|
* <li>
|
|
3435
|
-
*
|
|
3511
|
+
* <p>
|
|
3436
3512
|
* <code>FAILED</code> – The verification process failed.</p>
|
|
3437
3513
|
* </li>
|
|
3438
3514
|
* <li>
|
|
3439
|
-
*
|
|
3515
|
+
* <p>
|
|
3440
3516
|
* <code>TEMPORARY_FAILURE</code> – A temporary issue is preventing Amazon SES
|
|
3441
3517
|
* from determining the verification status of the identity.</p>
|
|
3442
3518
|
* </li>
|
|
3443
3519
|
* <li>
|
|
3444
|
-
*
|
|
3520
|
+
* <p>
|
|
3445
3521
|
* <code>NOT_STARTED</code> – The verification process hasn't been
|
|
3446
3522
|
* initiated for the identity.</p>
|
|
3447
3523
|
* </li>
|
|
@@ -3641,7 +3717,7 @@ export interface ListCustomVerificationEmailTemplatesRequest {
|
|
|
3641
3717
|
* larger than the number you specified in this parameter, then the response includes a
|
|
3642
3718
|
* <code>NextToken</code> element, which you can use to obtain additional
|
|
3643
3719
|
* results.</p>
|
|
3644
|
-
*
|
|
3720
|
+
* <p>The value you specify has to be at least 1, and can be no more than 50.</p>
|
|
3645
3721
|
*/
|
|
3646
3722
|
PageSize?: number;
|
|
3647
3723
|
}
|
|
@@ -3709,7 +3785,7 @@ export interface ListDeliverabilityTestReportsRequest {
|
|
|
3709
3785
|
* the number you specified in this parameter, then the response includes a
|
|
3710
3786
|
* <code>NextToken</code> element, which you can use to obtain additional
|
|
3711
3787
|
* results.</p>
|
|
3712
|
-
*
|
|
3788
|
+
* <p>The value you specify has to be at least 0, and can be no more than 1000.</p>
|
|
3713
3789
|
*/
|
|
3714
3790
|
PageSize?: number;
|
|
3715
3791
|
}
|
|
@@ -3799,7 +3875,7 @@ export interface ListEmailIdentitiesRequest {
|
|
|
3799
3875
|
* the number of results is larger than the number you specified in this parameter, then
|
|
3800
3876
|
* the response includes a <code>NextToken</code> element, which you can use to obtain
|
|
3801
3877
|
* additional results.</p>
|
|
3802
|
-
*
|
|
3878
|
+
* <p>The value you specify has to be at least 0, and can be no more than 1000.</p>
|
|
3803
3879
|
*/
|
|
3804
3880
|
PageSize?: number;
|
|
3805
3881
|
}
|
|
@@ -3836,7 +3912,7 @@ export interface ListEmailTemplatesRequest {
|
|
|
3836
3912
|
* <p>The number of results to show in a single call to <code>ListEmailTemplates</code>. If the number of
|
|
3837
3913
|
* results is larger than the number you specified in this parameter, then the response
|
|
3838
3914
|
* includes a <code>NextToken</code> element, which you can use to obtain additional results.</p>
|
|
3839
|
-
*
|
|
3915
|
+
* <p>The value you specify has to be at least 1, and can be no more than 10.</p>
|
|
3840
3916
|
*/
|
|
3841
3917
|
PageSize?: number;
|
|
3842
3918
|
}
|
|
@@ -3939,7 +4015,7 @@ export interface ListRecommendationsRequest {
|
|
|
3939
4015
|
* the number you specified in this parameter, then the response includes a
|
|
3940
4016
|
* <code>NextToken</code> element, which you can use to obtain additional
|
|
3941
4017
|
* results.</p>
|
|
3942
|
-
*
|
|
4018
|
+
* <p>The value you specify has to be at least 1, and can be no more than 100.</p>
|
|
3943
4019
|
*/
|
|
3944
4020
|
PageSize?: number;
|
|
3945
4021
|
}
|
|
@@ -3952,6 +4028,7 @@ export declare enum RecommendationStatus {
|
|
|
3952
4028
|
OPEN = "OPEN"
|
|
3953
4029
|
}
|
|
3954
4030
|
export declare enum RecommendationType {
|
|
4031
|
+
BIMI = "BIMI",
|
|
3955
4032
|
DKIM = "DKIM",
|
|
3956
4033
|
DMARC = "DMARC",
|
|
3957
4034
|
SPF = "SPF"
|
|
@@ -3967,7 +4044,7 @@ export interface Recommendation {
|
|
|
3967
4044
|
ResourceArn?: string;
|
|
3968
4045
|
/**
|
|
3969
4046
|
* <p>The recommendation type, with values like <code>DKIM</code>,
|
|
3970
|
-
* <code>SPF</code> or <code>
|
|
4047
|
+
* <code>SPF</code>, <code>DMARC</code> or <code>BIMI</code>.</p>
|
|
3971
4048
|
*/
|
|
3972
4049
|
Type?: RecommendationType | string;
|
|
3973
4050
|
/**
|
|
@@ -4140,12 +4217,12 @@ export interface PutAccountDetailsRequest {
|
|
|
4140
4217
|
/**
|
|
4141
4218
|
* <p>Indicates whether or not your account should have production access in the current
|
|
4142
4219
|
* Amazon Web Services Region.</p>
|
|
4143
|
-
*
|
|
4220
|
+
* <p>If the value is <code>false</code>, then your account is in the
|
|
4144
4221
|
* <i>sandbox</i>. When your account is in the sandbox, you can only send
|
|
4145
4222
|
* email to verified identities. Additionally, the maximum number of emails you can send in
|
|
4146
4223
|
* a 24-hour period (your sending quota) is 200, and the maximum number of emails you can
|
|
4147
4224
|
* send per second (your maximum sending rate) is 1.</p>
|
|
4148
|
-
*
|
|
4225
|
+
* <p>If the value is <code>true</code>, then your account has production access. When your
|
|
4149
4226
|
* account has production access, you can send email to any address. The sending quota and
|
|
4150
4227
|
* maximum sending rate for your account vary based on your specific use case.</p>
|
|
4151
4228
|
*/
|
|
@@ -4164,10 +4241,10 @@ export interface PutAccountSendingAttributesRequest {
|
|
|
4164
4241
|
/**
|
|
4165
4242
|
* <p>Enables or disables your account's ability to send email. Set to <code>true</code> to
|
|
4166
4243
|
* enable email sending, or set to <code>false</code> to disable email sending.</p>
|
|
4167
|
-
*
|
|
4244
|
+
* <note>
|
|
4168
4245
|
* <p>If Amazon Web Services paused your account's ability to send email, you can't use this operation
|
|
4169
4246
|
* to resume your account's ability to send email.</p>
|
|
4170
|
-
*
|
|
4247
|
+
* </note>
|
|
4171
4248
|
*/
|
|
4172
4249
|
SendingEnabled?: boolean;
|
|
4173
4250
|
}
|
|
@@ -4185,15 +4262,15 @@ export interface PutAccountSuppressionAttributesRequest {
|
|
|
4185
4262
|
* <p>A list that contains the reasons that email addresses will be automatically added to
|
|
4186
4263
|
* the suppression list for your account. This list can contain any or all of the
|
|
4187
4264
|
* following:</p>
|
|
4188
|
-
*
|
|
4265
|
+
* <ul>
|
|
4189
4266
|
* <li>
|
|
4190
|
-
*
|
|
4267
|
+
* <p>
|
|
4191
4268
|
* <code>COMPLAINT</code> – Amazon SES adds an email address to the suppression
|
|
4192
4269
|
* list for your account when a message sent to that address results in a
|
|
4193
4270
|
* complaint.</p>
|
|
4194
4271
|
* </li>
|
|
4195
4272
|
* <li>
|
|
4196
|
-
*
|
|
4273
|
+
* <p>
|
|
4197
4274
|
* <code>BOUNCE</code> – Amazon SES adds an email address to the suppression
|
|
4198
4275
|
* list for your account when a message sent to that address results in a hard
|
|
4199
4276
|
* bounce.</p>
|
|
@@ -4302,15 +4379,15 @@ export interface PutConfigurationSetSuppressionOptionsRequest {
|
|
|
4302
4379
|
* <p>A list that contains the reasons that email addresses are automatically added to the
|
|
4303
4380
|
* suppression list for your account. This list can contain any or all of the
|
|
4304
4381
|
* following:</p>
|
|
4305
|
-
*
|
|
4382
|
+
* <ul>
|
|
4306
4383
|
* <li>
|
|
4307
|
-
*
|
|
4384
|
+
* <p>
|
|
4308
4385
|
* <code>COMPLAINT</code> – Amazon SES adds an email address to the suppression
|
|
4309
4386
|
* list for your account when a message sent to that address results in a
|
|
4310
4387
|
* complaint.</p>
|
|
4311
4388
|
* </li>
|
|
4312
4389
|
* <li>
|
|
4313
|
-
*
|
|
4390
|
+
* <p>
|
|
4314
4391
|
* <code>BOUNCE</code> – Amazon SES adds an email address to the suppression
|
|
4315
4392
|
* list for your account when a message sent to that address results in a hard
|
|
4316
4393
|
* bounce.</p>
|
|
@@ -4410,7 +4487,7 @@ export interface PutDedicatedIpWarmupAttributesResponse {
|
|
|
4410
4487
|
* <p>Enable or disable the Deliverability dashboard. When you enable the Deliverability dashboard, you gain
|
|
4411
4488
|
* access to reputation, deliverability, and other metrics for the domains that you use to
|
|
4412
4489
|
* send email using Amazon SES API v2. You also gain the ability to perform predictive inbox placement tests.</p>
|
|
4413
|
-
*
|
|
4490
|
+
* <p>When you use the Deliverability dashboard, you pay a monthly subscription charge, in addition
|
|
4414
4491
|
* to any other fees that you accrue by using Amazon SES and other Amazon Web Services services. For more
|
|
4415
4492
|
* information about the features and cost of a Deliverability dashboard subscription, see <a href="http://aws.amazon.com/pinpoint/pricing/">Amazon Pinpoint Pricing</a>.</p>
|
|
4416
4493
|
*/
|
|
@@ -4461,7 +4538,7 @@ export interface PutEmailIdentityDkimAttributesRequest {
|
|
|
4461
4538
|
EmailIdentity: string | undefined;
|
|
4462
4539
|
/**
|
|
4463
4540
|
* <p>Sets the DKIM signing configuration for the identity.</p>
|
|
4464
|
-
*
|
|
4541
|
+
* <p>When you set this value <code>true</code>, then the messages that are sent from the
|
|
4465
4542
|
* identity are signed using DKIM. If you set this value to <code>false</code>, your
|
|
4466
4543
|
* messages are sent without DKIM signing.</p>
|
|
4467
4544
|
*/
|
|
@@ -4484,14 +4561,14 @@ export interface PutEmailIdentityDkimSigningAttributesRequest {
|
|
|
4484
4561
|
/**
|
|
4485
4562
|
* <p>The method to use to configure DKIM for the identity. There are the following possible
|
|
4486
4563
|
* values:</p>
|
|
4487
|
-
*
|
|
4564
|
+
* <ul>
|
|
4488
4565
|
* <li>
|
|
4489
|
-
*
|
|
4566
|
+
* <p>
|
|
4490
4567
|
* <code>AWS_SES</code> – Configure DKIM for the identity by using <a href="https://docs.aws.amazon.com/ses/latest/DeveloperGuide/easy-dkim.html">Easy
|
|
4491
4568
|
* DKIM</a>.</p>
|
|
4492
4569
|
* </li>
|
|
4493
4570
|
* <li>
|
|
4494
|
-
*
|
|
4571
|
+
* <p>
|
|
4495
4572
|
* <code>EXTERNAL</code> – Configure DKIM for the identity by using Bring
|
|
4496
4573
|
* Your Own DKIM (BYODKIM).</p>
|
|
4497
4574
|
* </li>
|
|
@@ -4507,7 +4584,7 @@ export interface PutEmailIdentityDkimSigningAttributesRequest {
|
|
|
4507
4584
|
}
|
|
4508
4585
|
/**
|
|
4509
4586
|
* <p>If the action is successful, the service sends back an HTTP 200 response.</p>
|
|
4510
|
-
*
|
|
4587
|
+
* <p>The following data is returned in JSON format by the service.</p>
|
|
4511
4588
|
*/
|
|
4512
4589
|
export interface PutEmailIdentityDkimSigningAttributesResponse {
|
|
4513
4590
|
/**
|
|
@@ -4516,36 +4593,36 @@ export interface PutEmailIdentityDkimSigningAttributesResponse {
|
|
|
4516
4593
|
* you used <a href="https://docs.aws.amazon.com/ses/latest/DeveloperGuide/easy-dkim.html">Easy
|
|
4517
4594
|
* DKIM</a> to set up DKIM authentication, Amazon SES tries to find three unique CNAME
|
|
4518
4595
|
* records in the DNS configuration for your domain.</p>
|
|
4519
|
-
*
|
|
4596
|
+
* <p>If you provided a public key to perform DKIM authentication, Amazon SES tries to find a TXT
|
|
4520
4597
|
* record that uses the selector that you specified. The value of the TXT record must be a
|
|
4521
4598
|
* public key that's paired with the private key that you specified in the process of
|
|
4522
4599
|
* creating the identity.</p>
|
|
4523
|
-
*
|
|
4524
|
-
*
|
|
4600
|
+
* <p>The status can be one of the following:</p>
|
|
4601
|
+
* <ul>
|
|
4525
4602
|
* <li>
|
|
4526
|
-
*
|
|
4603
|
+
* <p>
|
|
4527
4604
|
* <code>PENDING</code> – The verification process was initiated, but Amazon SES
|
|
4528
4605
|
* hasn't yet detected the DKIM records in the DNS configuration for the
|
|
4529
4606
|
* domain.</p>
|
|
4530
4607
|
* </li>
|
|
4531
4608
|
* <li>
|
|
4532
|
-
*
|
|
4609
|
+
* <p>
|
|
4533
4610
|
* <code>SUCCESS</code> – The verification process completed
|
|
4534
4611
|
* successfully.</p>
|
|
4535
4612
|
* </li>
|
|
4536
4613
|
* <li>
|
|
4537
|
-
*
|
|
4614
|
+
* <p>
|
|
4538
4615
|
* <code>FAILED</code> – The verification process failed. This typically
|
|
4539
4616
|
* occurs when Amazon SES fails to find the DKIM records in the DNS configuration of the
|
|
4540
4617
|
* domain.</p>
|
|
4541
4618
|
* </li>
|
|
4542
4619
|
* <li>
|
|
4543
|
-
*
|
|
4620
|
+
* <p>
|
|
4544
4621
|
* <code>TEMPORARY_FAILURE</code> – A temporary issue is preventing Amazon SES
|
|
4545
4622
|
* from determining the DKIM authentication status of the domain.</p>
|
|
4546
4623
|
* </li>
|
|
4547
4624
|
* <li>
|
|
4548
|
-
*
|
|
4625
|
+
* <p>
|
|
4549
4626
|
* <code>NOT_STARTED</code> – The DKIM verification process hasn't been
|
|
4550
4627
|
* initiated for the domain.</p>
|
|
4551
4628
|
* </li>
|
|
@@ -4557,10 +4634,10 @@ export interface PutEmailIdentityDkimSigningAttributesResponse {
|
|
|
4557
4634
|
* contains a set of unique strings that you use to create a set of CNAME records that you
|
|
4558
4635
|
* add to the DNS configuration for your domain. When Amazon SES detects these records in the
|
|
4559
4636
|
* DNS configuration for your domain, the DKIM authentication process is complete.</p>
|
|
4560
|
-
*
|
|
4637
|
+
* <p>If you configured DKIM authentication for the domain by providing your own
|
|
4561
4638
|
* public-private key pair, then this object contains the selector that's associated with
|
|
4562
4639
|
* your public key.</p>
|
|
4563
|
-
*
|
|
4640
|
+
* <p>Regardless of the DKIM authentication method you use, Amazon SES searches for the
|
|
4564
4641
|
* appropriate records in the DNS configuration of the domain for up to 72 hours.</p>
|
|
4565
4642
|
*/
|
|
4566
4643
|
DkimTokens?: string[];
|
|
@@ -4576,10 +4653,10 @@ export interface PutEmailIdentityFeedbackAttributesRequest {
|
|
|
4576
4653
|
EmailIdentity: string | undefined;
|
|
4577
4654
|
/**
|
|
4578
4655
|
* <p>Sets the feedback forwarding configuration for the identity.</p>
|
|
4579
|
-
*
|
|
4656
|
+
* <p>If the value is <code>true</code>, you receive email notifications when bounce or
|
|
4580
4657
|
* complaint events occur. These notifications are sent to the address that you specified
|
|
4581
4658
|
* in the <code>Return-Path</code> header of the original email.</p>
|
|
4582
|
-
*
|
|
4659
|
+
* <p>You're required to have a method of tracking bounces and complaints. If you haven't
|
|
4583
4660
|
* set up another mechanism for receiving bounce or complaint notifications (for example,
|
|
4584
4661
|
* by setting up an event destination), you receive an email notification when these events
|
|
4585
4662
|
* occur (even if this setting is disabled).</p>
|
|
@@ -4603,15 +4680,15 @@ export interface PutEmailIdentityMailFromAttributesRequest {
|
|
|
4603
4680
|
/**
|
|
4604
4681
|
* <p> The custom MAIL FROM domain that you want the verified identity to use. The MAIL FROM
|
|
4605
4682
|
* domain must meet the following criteria:</p>
|
|
4606
|
-
*
|
|
4683
|
+
* <ul>
|
|
4607
4684
|
* <li>
|
|
4608
|
-
*
|
|
4685
|
+
* <p>It has to be a subdomain of the verified identity.</p>
|
|
4609
4686
|
* </li>
|
|
4610
4687
|
* <li>
|
|
4611
|
-
*
|
|
4688
|
+
* <p>It can't be used to receive email.</p>
|
|
4612
4689
|
* </li>
|
|
4613
4690
|
* <li>
|
|
4614
|
-
*
|
|
4691
|
+
* <p>It can't be used in a "From" address if the MAIL FROM domain is a destination
|
|
4615
4692
|
* for feedback forwarding emails.</p>
|
|
4616
4693
|
* </li>
|
|
4617
4694
|
* </ul>
|
|
@@ -4624,7 +4701,7 @@ export interface PutEmailIdentityMailFromAttributesRequest {
|
|
|
4624
4701
|
* to <code>RejectMessage</code>, the Amazon SES API v2 returns a
|
|
4625
4702
|
* <code>MailFromDomainNotVerified</code> error, and doesn't attempt to deliver the
|
|
4626
4703
|
* email.</p>
|
|
4627
|
-
*
|
|
4704
|
+
* <p>These behaviors are taken when the custom MAIL FROM domain configuration is in the
|
|
4628
4705
|
* <code>Pending</code>, <code>Failed</code>, and <code>TemporaryFailure</code>
|
|
4629
4706
|
* states.</p>
|
|
4630
4707
|
*/
|
|
@@ -4672,13 +4749,13 @@ export interface SendBulkEmailRequest {
|
|
|
4672
4749
|
* <p>This parameter is used only for sending authorization. It is the ARN of the identity
|
|
4673
4750
|
* that is associated with the sending authorization policy that permits you to use the
|
|
4674
4751
|
* email address specified in the <code>FromEmailAddress</code> parameter.</p>
|
|
4675
|
-
*
|
|
4752
|
+
* <p>For example, if the owner of example.com (which has ARN
|
|
4676
4753
|
* arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it that
|
|
4677
4754
|
* authorizes you to use sender@example.com, then you would specify the
|
|
4678
4755
|
* <code>FromEmailAddressIdentityArn</code> to be
|
|
4679
4756
|
* arn:aws:ses:us-east-1:123456789012:identity/example.com, and the
|
|
4680
4757
|
* <code>FromEmailAddress</code> to be sender@example.com.</p>
|
|
4681
|
-
*
|
|
4758
|
+
* <p>For more information about sending authorization, see the <a href="https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html">Amazon SES Developer
|
|
4682
4759
|
* Guide</a>.</p>
|
|
4683
4760
|
*/
|
|
4684
4761
|
FromEmailAddressIdentityArn?: string;
|
|
@@ -4696,13 +4773,13 @@ export interface SendBulkEmailRequest {
|
|
|
4696
4773
|
* that is associated with the sending authorization policy that permits you to use the
|
|
4697
4774
|
* email address specified in the <code>FeedbackForwardingEmailAddress</code>
|
|
4698
4775
|
* parameter.</p>
|
|
4699
|
-
*
|
|
4776
|
+
* <p>For example, if the owner of example.com (which has ARN
|
|
4700
4777
|
* arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it that
|
|
4701
4778
|
* authorizes you to use feedback@example.com, then you would specify the
|
|
4702
4779
|
* <code>FeedbackForwardingEmailAddressIdentityArn</code> to be
|
|
4703
4780
|
* arn:aws:ses:us-east-1:123456789012:identity/example.com, and the
|
|
4704
4781
|
* <code>FeedbackForwardingEmailAddress</code> to be feedback@example.com.</p>
|
|
4705
|
-
*
|
|
4782
|
+
* <p>For more information about sending authorization, see the <a href="https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html">Amazon SES Developer
|
|
4706
4783
|
* Guide</a>.</p>
|
|
4707
4784
|
*/
|
|
4708
4785
|
FeedbackForwardingEmailAddressIdentityArn?: string;
|
|
@@ -4781,15 +4858,15 @@ export interface SendEmailRequest {
|
|
|
4781
4858
|
* <p>This parameter is used only for sending authorization. It is the ARN of the identity
|
|
4782
4859
|
* that is associated with the sending authorization policy that permits you to use the
|
|
4783
4860
|
* email address specified in the <code>FromEmailAddress</code> parameter.</p>
|
|
4784
|
-
*
|
|
4861
|
+
* <p>For example, if the owner of example.com (which has ARN
|
|
4785
4862
|
* arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it that
|
|
4786
4863
|
* authorizes you to use sender@example.com, then you would specify the
|
|
4787
4864
|
* <code>FromEmailAddressIdentityArn</code> to be
|
|
4788
4865
|
* arn:aws:ses:us-east-1:123456789012:identity/example.com, and the
|
|
4789
4866
|
* <code>FromEmailAddress</code> to be sender@example.com.</p>
|
|
4790
|
-
*
|
|
4867
|
+
* <p>For more information about sending authorization, see the <a href="https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html">Amazon SES Developer
|
|
4791
4868
|
* Guide</a>.</p>
|
|
4792
|
-
*
|
|
4869
|
+
* <p>For Raw emails, the <code>FromEmailAddressIdentityArn</code> value overrides the
|
|
4793
4870
|
* X-SES-SOURCE-ARN and X-SES-FROM-ARN headers specified in raw email message
|
|
4794
4871
|
* content.</p>
|
|
4795
4872
|
*/
|
|
@@ -4812,13 +4889,13 @@ export interface SendEmailRequest {
|
|
|
4812
4889
|
* that is associated with the sending authorization policy that permits you to use the
|
|
4813
4890
|
* email address specified in the <code>FeedbackForwardingEmailAddress</code>
|
|
4814
4891
|
* parameter.</p>
|
|
4815
|
-
*
|
|
4892
|
+
* <p>For example, if the owner of example.com (which has ARN
|
|
4816
4893
|
* arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it that
|
|
4817
4894
|
* authorizes you to use feedback@example.com, then you would specify the
|
|
4818
4895
|
* <code>FeedbackForwardingEmailAddressIdentityArn</code> to be
|
|
4819
4896
|
* arn:aws:ses:us-east-1:123456789012:identity/example.com, and the
|
|
4820
4897
|
* <code>FeedbackForwardingEmailAddress</code> to be feedback@example.com.</p>
|
|
4821
|
-
*
|
|
4898
|
+
* <p>For more information about sending authorization, see the <a href="https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html">Amazon SES Developer
|
|
4822
4899
|
* Guide</a>.</p>
|
|
4823
4900
|
*/
|
|
4824
4901
|
FeedbackForwardingEmailAddressIdentityArn?: string;
|
|
@@ -4850,12 +4927,12 @@ export interface SendEmailResponse {
|
|
|
4850
4927
|
/**
|
|
4851
4928
|
* <p>A unique identifier for the message that is generated when the message is
|
|
4852
4929
|
* accepted.</p>
|
|
4853
|
-
*
|
|
4930
|
+
* <note>
|
|
4854
4931
|
* <p>It's possible for Amazon SES to accept a message without sending it. This can happen
|
|
4855
4932
|
* when the message that you're trying to send has an attachment contains a virus, or
|
|
4856
4933
|
* when you send a templated email that contains invalid personalization content, for
|
|
4857
4934
|
* example.</p>
|
|
4858
|
-
*
|
|
4935
|
+
* </note>
|
|
4859
4936
|
*/
|
|
4860
4937
|
MessageId?: string;
|
|
4861
4938
|
}
|
|
@@ -4911,11 +4988,11 @@ export interface UntagResourceRequest {
|
|
|
4911
4988
|
/**
|
|
4912
4989
|
* <p>The tags (tag keys) that you want to remove from the resource. When you specify a tag
|
|
4913
4990
|
* key, the action removes both that key and its associated tag value.</p>
|
|
4914
|
-
*
|
|
4991
|
+
* <p>To remove more than one tag from the resource, append the <code>TagKeys</code>
|
|
4915
4992
|
* parameter and argument for each additional tag to remove, separated by an ampersand. For
|
|
4916
4993
|
* example:
|
|
4917
4994
|
* <code>/v2/email/tags?ResourceArn=ResourceArn&TagKeys=Key1&TagKeys=Key2</code>
|
|
4918
|
-
*
|
|
4995
|
+
* </p>
|
|
4919
4996
|
*/
|
|
4920
4997
|
TagKeys: string[] | undefined;
|
|
4921
4998
|
}
|
|
@@ -5040,14 +5117,13 @@ export interface UpdateEmailIdentityPolicyRequest {
|
|
|
5040
5117
|
EmailIdentity: string | undefined;
|
|
5041
5118
|
/**
|
|
5042
5119
|
* <p>The name of the policy.</p>
|
|
5043
|
-
*
|
|
5044
|
-
* <p>The policy name cannot exceed 64 characters and can only include alphanumeric
|
|
5120
|
+
* <p>The policy name cannot exceed 64 characters and can only include alphanumeric
|
|
5045
5121
|
* characters, dashes, and underscores.</p>
|
|
5046
5122
|
*/
|
|
5047
5123
|
PolicyName: string | undefined;
|
|
5048
5124
|
/**
|
|
5049
5125
|
* <p>The text of the policy in JSON format. The policy cannot exceed 4 KB.</p>
|
|
5050
|
-
*
|
|
5126
|
+
* <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
|
|
5051
5127
|
* Guide</a>.</p>
|
|
5052
5128
|
*/
|
|
5053
5129
|
Policy: string | undefined;
|