@aws-sdk/client-ses 3.388.0 → 3.390.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/README.md +25 -0
- package/dist-cjs/endpoint/ruleset.js +3 -3
- package/dist-cjs/models/models_0.js +21 -1
- package/dist-es/endpoint/ruleset.js +3 -3
- package/dist-es/models/models_0.js +20 -0
- package/dist-types/SES.d.ts +28 -3
- package/dist-types/SESClient.d.ts +28 -3
- package/dist-types/commands/CloneReceiptRuleSetCommand.d.ts +2 -3
- package/dist-types/commands/CreateConfigurationSetCommand.d.ts +4 -4
- package/dist-types/commands/CreateConfigurationSetEventDestinationCommand.d.ts +8 -8
- package/dist-types/commands/CreateConfigurationSetTrackingOptionsCommand.d.ts +5 -5
- package/dist-types/commands/CreateCustomVerificationEmailTemplateCommand.d.ts +3 -2
- package/dist-types/commands/CreateReceiptFilterCommand.d.ts +4 -3
- package/dist-types/commands/CreateReceiptRuleCommand.d.ts +11 -11
- package/dist-types/commands/CreateReceiptRuleSetCommand.d.ts +2 -3
- package/dist-types/commands/CreateTemplateCommand.d.ts +3 -3
- package/dist-types/commands/DeleteConfigurationSetCommand.d.ts +3 -2
- package/dist-types/commands/DeleteConfigurationSetEventDestinationCommand.d.ts +3 -2
- package/dist-types/commands/DeleteConfigurationSetTrackingOptionsCommand.d.ts +5 -5
- package/dist-types/commands/DeleteCustomVerificationEmailTemplateCommand.d.ts +3 -2
- package/dist-types/commands/DeleteIdentityCommand.d.ts +1 -1
- package/dist-types/commands/DeleteIdentityPolicyCommand.d.ts +10 -10
- package/dist-types/commands/DeleteReceiptFilterCommand.d.ts +2 -2
- package/dist-types/commands/DeleteReceiptRuleCommand.d.ts +2 -2
- package/dist-types/commands/DeleteReceiptRuleSetCommand.d.ts +5 -4
- package/dist-types/commands/DeleteTemplateCommand.d.ts +1 -1
- package/dist-types/commands/DescribeActiveReceiptRuleSetCommand.d.ts +6 -7
- package/dist-types/commands/DescribeConfigurationSetCommand.d.ts +7 -7
- package/dist-types/commands/DescribeReceiptRuleCommand.d.ts +7 -7
- package/dist-types/commands/DescribeReceiptRuleSetCommand.d.ts +7 -6
- package/dist-types/commands/GetAccountSendingEnabledCommand.d.ts +2 -2
- package/dist-types/commands/GetCustomVerificationEmailTemplateCommand.d.ts +3 -2
- package/dist-types/commands/GetIdentityDkimAttributesCommand.d.ts +9 -8
- package/dist-types/commands/GetIdentityMailFromDomainAttributesCommand.d.ts +3 -3
- package/dist-types/commands/GetIdentityNotificationAttributesCommand.d.ts +2 -2
- package/dist-types/commands/GetIdentityPoliciesCommand.d.ts +8 -8
- package/dist-types/commands/GetIdentityVerificationAttributesCommand.d.ts +8 -8
- package/dist-types/commands/GetSendQuotaCommand.d.ts +1 -1
- package/dist-types/commands/GetSendStatisticsCommand.d.ts +2 -2
- package/dist-types/commands/GetTemplateCommand.d.ts +1 -1
- package/dist-types/commands/ListConfigurationSetsCommand.d.ts +6 -5
- package/dist-types/commands/ListCustomVerificationEmailTemplatesCommand.d.ts +4 -3
- package/dist-types/commands/ListIdentitiesCommand.d.ts +13 -3
- package/dist-types/commands/ListIdentityPoliciesCommand.d.ts +10 -10
- package/dist-types/commands/ListReceiptFiltersCommand.d.ts +5 -5
- package/dist-types/commands/ListReceiptRuleSetsCommand.d.ts +5 -4
- package/dist-types/commands/ListTemplatesCommand.d.ts +3 -3
- package/dist-types/commands/PutConfigurationSetDeliveryOptionsCommand.d.ts +1 -1
- package/dist-types/commands/PutIdentityPolicyCommand.d.ts +8 -8
- package/dist-types/commands/ReorderReceiptRuleSetCommand.d.ts +7 -7
- package/dist-types/commands/SendBounceCommand.d.ts +11 -10
- package/dist-types/commands/SendBulkTemplatedEmailCommand.d.ts +19 -19
- package/dist-types/commands/SendCustomVerificationEmailCommand.d.ts +5 -5
- package/dist-types/commands/SendEmailCommand.d.ts +19 -21
- package/dist-types/commands/SendRawEmailCommand.d.ts +50 -58
- package/dist-types/commands/SendTemplatedEmailCommand.d.ts +21 -22
- package/dist-types/commands/SetActiveReceiptRuleSetCommand.d.ts +7 -6
- package/dist-types/commands/SetIdentityDkimEnabledCommand.d.ts +6 -5
- package/dist-types/commands/SetIdentityFeedbackForwardingEnabledCommand.d.ts +4 -4
- package/dist-types/commands/SetIdentityHeadersInNotificationsEnabledCommand.d.ts +3 -3
- package/dist-types/commands/SetIdentityMailFromDomainCommand.d.ts +6 -7
- package/dist-types/commands/SetIdentityNotificationTopicCommand.d.ts +4 -4
- package/dist-types/commands/SetReceiptRulePositionCommand.d.ts +2 -2
- package/dist-types/commands/TestRenderTemplateCommand.d.ts +1 -1
- package/dist-types/commands/UpdateAccountSendingEnabledCommand.d.ts +3 -3
- package/dist-types/commands/UpdateConfigurationSetEventDestinationCommand.d.ts +7 -7
- package/dist-types/commands/UpdateConfigurationSetReputationMetricsEnabledCommand.d.ts +2 -2
- package/dist-types/commands/UpdateConfigurationSetSendingEnabledCommand.d.ts +2 -2
- package/dist-types/commands/UpdateConfigurationSetTrackingOptionsCommand.d.ts +5 -5
- package/dist-types/commands/UpdateCustomVerificationEmailTemplateCommand.d.ts +3 -2
- package/dist-types/commands/UpdateReceiptRuleCommand.d.ts +10 -10
- package/dist-types/commands/UpdateTemplateCommand.d.ts +3 -3
- package/dist-types/commands/VerifyDomainDkimCommand.d.ts +13 -13
- package/dist-types/commands/VerifyDomainIdentityCommand.d.ts +5 -6
- package/dist-types/commands/VerifyEmailIdentityCommand.d.ts +2 -2
- package/dist-types/index.d.ts +28 -3
- package/dist-types/models/models_0.d.ts +710 -639
- package/dist-types/ts3.4/models/models_0.d.ts +26 -8
- package/package.json +1 -1
|
@@ -3,7 +3,7 @@ import { SESServiceException as __BaseException } from "./SESServiceException";
|
|
|
3
3
|
/**
|
|
4
4
|
* @public
|
|
5
5
|
* <p>Indicates that email sending is disabled for your entire Amazon SES account.</p>
|
|
6
|
-
*
|
|
6
|
+
* <p>You can enable or disable email sending for your Amazon SES account using <a>UpdateAccountSendingEnabled</a>.</p>
|
|
7
7
|
*/
|
|
8
8
|
export declare class AccountSendingPausedException extends __BaseException {
|
|
9
9
|
readonly name: "AccountSendingPausedException";
|
|
@@ -17,20 +17,21 @@ export declare class AccountSendingPausedException extends __BaseException {
|
|
|
17
17
|
* @public
|
|
18
18
|
* <p>When included in a receipt rule, this action adds a header to the received
|
|
19
19
|
* email.</p>
|
|
20
|
-
*
|
|
21
|
-
* Developer Guide</a>.</p>
|
|
20
|
+
* <p>For information about adding a header using a receipt rule, see the <a href="https://docs.aws.amazon.com/ses/latest/dg/receiving-email-action-add-header.html">Amazon SES Developer Guide</a>.</p>
|
|
22
21
|
*/
|
|
23
22
|
export interface AddHeaderAction {
|
|
24
23
|
/**
|
|
25
24
|
* @public
|
|
26
|
-
* <p>The name of the header to add
|
|
27
|
-
*
|
|
25
|
+
* <p>The name of the header to add to the incoming message. The name must contain at least
|
|
26
|
+
* one character, and can contain up to 50 characters. It consists of alphanumeric (a–z,
|
|
27
|
+
* A–Z, 0–9) characters and dashes.</p>
|
|
28
28
|
*/
|
|
29
29
|
HeaderName: string | undefined;
|
|
30
30
|
/**
|
|
31
31
|
* @public
|
|
32
|
-
* <p>
|
|
33
|
-
*
|
|
32
|
+
* <p>The content to include in the header. This value can contain up to 2048 characters. It
|
|
33
|
+
* can't contain newline (<code>\n</code>) or carriage return (<code>\r</code>)
|
|
34
|
+
* characters.</p>
|
|
34
35
|
*/
|
|
35
36
|
HeaderValue: string | undefined;
|
|
36
37
|
}
|
|
@@ -67,7 +68,7 @@ export type BehaviorOnMXFailure = (typeof BehaviorOnMXFailure)[keyof typeof Beha
|
|
|
67
68
|
/**
|
|
68
69
|
* @public
|
|
69
70
|
* <p>Represents textual data, plus an optional character set specification.</p>
|
|
70
|
-
*
|
|
71
|
+
* <p>By default, the text must be 7-bit ASCII, due to the constraints of the SMTP protocol.
|
|
71
72
|
* If the text must contain any other characters, then you must also specify a character
|
|
72
73
|
* set. Examples include UTF-8, ISO-8859-1, and Shift_JIS.</p>
|
|
73
74
|
*/
|
|
@@ -109,17 +110,16 @@ export interface Body {
|
|
|
109
110
|
* <p>When included in a receipt rule, this action rejects the received email by returning a
|
|
110
111
|
* bounce response to the sender and, optionally, publishes a notification to Amazon Simple Notification Service
|
|
111
112
|
* (Amazon SNS).</p>
|
|
112
|
-
*
|
|
113
|
-
* the <a href="https://docs.aws.amazon.com/ses/latest/
|
|
114
|
-
* Guide</a>.</p>
|
|
113
|
+
* <p>For information about sending a bounce message in response to a received email, see
|
|
114
|
+
* the <a href="https://docs.aws.amazon.com/ses/latest/dg/receiving-email-action-bounce.html">Amazon SES Developer Guide</a>.</p>
|
|
115
115
|
*/
|
|
116
116
|
export interface BounceAction {
|
|
117
117
|
/**
|
|
118
118
|
* @public
|
|
119
119
|
* <p>The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the bounce action is
|
|
120
|
-
* taken.
|
|
121
|
-
*
|
|
122
|
-
*
|
|
120
|
+
* taken. You can find the ARN of a topic by using the <a href="https://docs.aws.amazon.com/sns/latest/api/API_ListTopics.html">ListTopics</a> operation in
|
|
121
|
+
* Amazon SNS.</p>
|
|
122
|
+
* <p>For 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>
|
|
123
123
|
*/
|
|
124
124
|
TopicArn?: string;
|
|
125
125
|
/**
|
|
@@ -140,7 +140,7 @@ export interface BounceAction {
|
|
|
140
140
|
/**
|
|
141
141
|
* @public
|
|
142
142
|
* <p>The email address of the sender of the bounced email. This is the address from which
|
|
143
|
-
* the bounce message
|
|
143
|
+
* the bounce message is sent.</p>
|
|
144
144
|
*/
|
|
145
145
|
Sender: string | undefined;
|
|
146
146
|
}
|
|
@@ -179,8 +179,8 @@ export type DsnAction = (typeof DsnAction)[keyof typeof DsnAction];
|
|
|
179
179
|
* @public
|
|
180
180
|
* <p>Additional X-headers to include in the Delivery Status Notification (DSN) when an
|
|
181
181
|
* email that Amazon SES receives on your behalf bounces.</p>
|
|
182
|
-
*
|
|
183
|
-
*
|
|
182
|
+
* <p>For information about receiving email through Amazon SES, see the <a href="https://docs.aws.amazon.com/ses/latest/dg/receiving-email.html">Amazon SES Developer
|
|
183
|
+
* Guide</a>.</p>
|
|
184
184
|
*/
|
|
185
185
|
export interface ExtensionField {
|
|
186
186
|
/**
|
|
@@ -191,7 +191,7 @@ export interface ExtensionField {
|
|
|
191
191
|
Name: string | undefined;
|
|
192
192
|
/**
|
|
193
193
|
* @public
|
|
194
|
-
* <p>The value of the header to add. Must
|
|
194
|
+
* <p>The value of the header to add. Must contain 2048 characters or fewer, and must not
|
|
195
195
|
* contain newline characters ("\r" or "\n").</p>
|
|
196
196
|
*/
|
|
197
197
|
Value: string | undefined;
|
|
@@ -200,22 +200,22 @@ export interface ExtensionField {
|
|
|
200
200
|
* @public
|
|
201
201
|
* <p>Recipient-related information to include in the Delivery Status Notification (DSN)
|
|
202
202
|
* when an email that Amazon SES receives on your behalf bounces.</p>
|
|
203
|
-
*
|
|
204
|
-
*
|
|
203
|
+
* <p>For information about receiving email through Amazon SES, see the <a href="https://docs.aws.amazon.com/ses/latest/dg/receiving-email.html">Amazon SES Developer
|
|
204
|
+
* Guide</a>.</p>
|
|
205
205
|
*/
|
|
206
206
|
export interface RecipientDsnFields {
|
|
207
207
|
/**
|
|
208
208
|
* @public
|
|
209
209
|
* <p>The email address that the message was ultimately delivered to. This corresponds to
|
|
210
210
|
* the <code>Final-Recipient</code> in the DSN. If not specified,
|
|
211
|
-
* <code>FinalRecipient</code>
|
|
212
|
-
*
|
|
211
|
+
* <code>FinalRecipient</code> is set to the <code>Recipient</code> specified in the
|
|
212
|
+
* <code>BouncedRecipientInfo</code> structure. Either <code>FinalRecipient</code> or
|
|
213
213
|
* the recipient in <code>BouncedRecipientInfo</code> must be a recipient of the original
|
|
214
214
|
* bounced message.</p>
|
|
215
|
-
*
|
|
215
|
+
* <note>
|
|
216
216
|
* <p>Do not prepend the <code>FinalRecipient</code> email address with <code>rfc
|
|
217
217
|
* 822;</code>, as described in <a href="https://tools.ietf.org/html/rfc3798">RFC 3798</a>.</p>
|
|
218
|
-
*
|
|
218
|
+
* </note>
|
|
219
219
|
*/
|
|
220
220
|
FinalRecipient?: string;
|
|
221
221
|
/**
|
|
@@ -259,8 +259,8 @@ export interface RecipientDsnFields {
|
|
|
259
259
|
* @public
|
|
260
260
|
* <p>Recipient-related information to include in the Delivery Status Notification (DSN)
|
|
261
261
|
* when an email that Amazon SES receives on your behalf bounces.</p>
|
|
262
|
-
*
|
|
263
|
-
*
|
|
262
|
+
* <p>For information about receiving email through Amazon SES, see the <a href="https://docs.aws.amazon.com/ses/latest/dg/receiving-email.html">Amazon SES Developer
|
|
263
|
+
* Guide</a>.</p>
|
|
264
264
|
*/
|
|
265
265
|
export interface BouncedRecipientInfo {
|
|
266
266
|
/**
|
|
@@ -273,8 +273,7 @@ export interface BouncedRecipientInfo {
|
|
|
273
273
|
* <p>This parameter is used only for sending authorization. It is the ARN of the identity
|
|
274
274
|
* that is associated with the sending authorization policy that permits you to receive
|
|
275
275
|
* email for the recipient of the bounced email. For more information about sending
|
|
276
|
-
* authorization, see the <a href="https://docs.aws.amazon.com/ses/latest/
|
|
277
|
-
* Guide</a>.</p>
|
|
276
|
+
* authorization, see the <a href="https://docs.aws.amazon.com/ses/latest/dg/sending-authorization.html">Amazon SES Developer Guide</a>.</p>
|
|
278
277
|
*/
|
|
279
278
|
RecipientArn?: string;
|
|
280
279
|
/**
|
|
@@ -295,14 +294,16 @@ export interface BouncedRecipientInfo {
|
|
|
295
294
|
* @public
|
|
296
295
|
* <p>Represents the destination of the message, consisting of To:, CC:, and BCC:
|
|
297
296
|
* fields.</p>
|
|
298
|
-
*
|
|
297
|
+
* <note>
|
|
299
298
|
* <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
|
|
300
|
-
*
|
|
301
|
-
*
|
|
302
|
-
*
|
|
303
|
-
* part
|
|
304
|
-
*
|
|
305
|
-
*
|
|
299
|
+
* email address string must be 7-bit ASCII. If you want to send to or from email
|
|
300
|
+
* addresses that contain Unicode characters in the domain part of an address, you must
|
|
301
|
+
* encode the domain using Punycode. Punycode is not permitted in the local part of the
|
|
302
|
+
* email address (the part before the @ sign) nor in the "friendly from" name. If you
|
|
303
|
+
* want to use Unicode characters in the "friendly from" name, you must encode the
|
|
304
|
+
* "friendly from" name using MIME encoded-word syntax, as described in <a href="https://docs.aws.amazon.com/ses/latest/dg/send-email-raw.html">Sending raw email
|
|
305
|
+
* using the Amazon SES API</a>. For more information about Punycode, see <a href="http://tools.ietf.org/html/rfc3492">RFC 3492</a>.</p>
|
|
306
|
+
* </note>
|
|
306
307
|
*/
|
|
307
308
|
export interface Destination {
|
|
308
309
|
/**
|
|
@@ -325,34 +326,35 @@ export interface Destination {
|
|
|
325
326
|
* @public
|
|
326
327
|
* <p>Contains the name and value of a tag that you can provide to <code>SendEmail</code> or
|
|
327
328
|
* <code>SendRawEmail</code> to apply to an email.</p>
|
|
328
|
-
*
|
|
329
|
-
* sending events. For information about using configuration sets, see the <a href="https://docs.aws.amazon.com/ses/latest/
|
|
329
|
+
* <p>Message tags, which you use with configuration sets, enable you to publish email
|
|
330
|
+
* sending events. For information about using configuration sets, see the <a href="https://docs.aws.amazon.com/ses/latest/dg/monitor-sending-activity.html">Amazon SES
|
|
331
|
+
* Developer Guide</a>.</p>
|
|
330
332
|
*/
|
|
331
333
|
export interface MessageTag {
|
|
332
334
|
/**
|
|
333
335
|
* @public
|
|
334
|
-
* <p>The name of the tag. The name must:</p>
|
|
335
|
-
*
|
|
336
|
+
* <p>The name of the tag. The name must meet the following requirements:</p>
|
|
337
|
+
* <ul>
|
|
336
338
|
* <li>
|
|
337
|
-
*
|
|
338
|
-
*
|
|
339
|
+
* <p>Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or
|
|
340
|
+
* dashes (-).</p>
|
|
339
341
|
* </li>
|
|
340
342
|
* <li>
|
|
341
|
-
*
|
|
343
|
+
* <p>Contain 256 characters or fewer.</p>
|
|
342
344
|
* </li>
|
|
343
345
|
* </ul>
|
|
344
346
|
*/
|
|
345
347
|
Name: string | undefined;
|
|
346
348
|
/**
|
|
347
349
|
* @public
|
|
348
|
-
* <p>The value of the tag. The value must:</p>
|
|
349
|
-
*
|
|
350
|
+
* <p>The value of the tag. The value must meet the following requirements:</p>
|
|
351
|
+
* <ul>
|
|
350
352
|
* <li>
|
|
351
|
-
*
|
|
352
|
-
*
|
|
353
|
+
* <p>Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or
|
|
354
|
+
* dashes (-).</p>
|
|
353
355
|
* </li>
|
|
354
356
|
* <li>
|
|
355
|
-
*
|
|
357
|
+
* <p>Contain 256 characters or fewer.</p>
|
|
356
358
|
* </li>
|
|
357
359
|
* </ul>
|
|
358
360
|
*/
|
|
@@ -368,14 +370,16 @@ export interface BulkEmailDestination {
|
|
|
368
370
|
* @public
|
|
369
371
|
* <p>Represents the destination of the message, consisting of To:, CC:, and BCC:
|
|
370
372
|
* fields.</p>
|
|
371
|
-
*
|
|
373
|
+
* <note>
|
|
372
374
|
* <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
|
|
373
|
-
*
|
|
374
|
-
*
|
|
375
|
-
*
|
|
376
|
-
* part
|
|
377
|
-
*
|
|
378
|
-
*
|
|
375
|
+
* email address string must be 7-bit ASCII. If you want to send to or from email
|
|
376
|
+
* addresses that contain Unicode characters in the domain part of an address, you must
|
|
377
|
+
* encode the domain using Punycode. Punycode is not permitted in the local part of the
|
|
378
|
+
* email address (the part before the @ sign) nor in the "friendly from" name. If you
|
|
379
|
+
* want to use Unicode characters in the "friendly from" name, you must encode the
|
|
380
|
+
* "friendly from" name using MIME encoded-word syntax, as described in <a href="https://docs.aws.amazon.com/ses/latest/dg/send-email-raw.html">Sending raw email
|
|
381
|
+
* using the Amazon SES API</a>. For more information about Punycode, see <a href="http://tools.ietf.org/html/rfc3492">RFC 3492</a>.</p>
|
|
382
|
+
* </note>
|
|
379
383
|
*/
|
|
380
384
|
Destination: Destination | undefined;
|
|
381
385
|
/**
|
|
@@ -427,78 +431,78 @@ export interface BulkEmailDestinationStatus {
|
|
|
427
431
|
* @public
|
|
428
432
|
* <p>The status of a message sent using the <code>SendBulkTemplatedEmail</code>
|
|
429
433
|
* operation.</p>
|
|
430
|
-
*
|
|
431
|
-
*
|
|
434
|
+
* <p>Possible values for this parameter include:</p>
|
|
435
|
+
* <ul>
|
|
432
436
|
* <li>
|
|
433
|
-
*
|
|
434
|
-
* <code>Success</code>: Amazon SES accepted the message, and
|
|
435
|
-
*
|
|
437
|
+
* <p>
|
|
438
|
+
* <code>Success</code>: Amazon SES accepted the message, and attempts to deliver it
|
|
439
|
+
* to the recipients.</p>
|
|
436
440
|
* </li>
|
|
437
441
|
* <li>
|
|
438
|
-
*
|
|
442
|
+
* <p>
|
|
439
443
|
* <code>MessageRejected</code>: The message was rejected because it contained a
|
|
440
444
|
* virus.</p>
|
|
441
445
|
* </li>
|
|
442
446
|
* <li>
|
|
443
|
-
*
|
|
447
|
+
* <p>
|
|
444
448
|
* <code>MailFromDomainNotVerified</code>: The sender's email address or domain
|
|
445
449
|
* was not verified.</p>
|
|
446
450
|
* </li>
|
|
447
451
|
* <li>
|
|
448
|
-
*
|
|
452
|
+
* <p>
|
|
449
453
|
* <code>ConfigurationSetDoesNotExist</code>: The configuration set you specified
|
|
450
454
|
* does not exist.</p>
|
|
451
455
|
* </li>
|
|
452
456
|
* <li>
|
|
453
|
-
*
|
|
457
|
+
* <p>
|
|
454
458
|
* <code>TemplateDoesNotExist</code>: The template you specified does not
|
|
455
459
|
* exist.</p>
|
|
456
460
|
* </li>
|
|
457
461
|
* <li>
|
|
458
|
-
*
|
|
462
|
+
* <p>
|
|
459
463
|
* <code>AccountSuspended</code>: Your account has been shut down because of
|
|
460
464
|
* issues related to your email sending practices.</p>
|
|
461
465
|
* </li>
|
|
462
466
|
* <li>
|
|
463
|
-
*
|
|
467
|
+
* <p>
|
|
464
468
|
* <code>AccountThrottled</code>: The number of emails you can send has been
|
|
465
469
|
* reduced because your account has exceeded its allocated sending limit.</p>
|
|
466
470
|
* </li>
|
|
467
471
|
* <li>
|
|
468
|
-
*
|
|
472
|
+
* <p>
|
|
469
473
|
* <code>AccountDailyQuotaExceeded</code>: You have reached or exceeded the
|
|
470
474
|
* maximum number of emails you can send from your account in a 24-hour
|
|
471
475
|
* period.</p>
|
|
472
476
|
* </li>
|
|
473
477
|
* <li>
|
|
474
|
-
*
|
|
478
|
+
* <p>
|
|
475
479
|
* <code>InvalidSendingPoolName</code>: The configuration set you specified
|
|
476
480
|
* refers to an IP pool that does not exist.</p>
|
|
477
481
|
* </li>
|
|
478
482
|
* <li>
|
|
479
|
-
*
|
|
483
|
+
* <p>
|
|
480
484
|
* <code>AccountSendingPaused</code>: Email sending for the Amazon SES account was
|
|
481
485
|
* disabled using the <a>UpdateAccountSendingEnabled</a>
|
|
482
486
|
* operation.</p>
|
|
483
487
|
* </li>
|
|
484
488
|
* <li>
|
|
485
|
-
*
|
|
489
|
+
* <p>
|
|
486
490
|
* <code>ConfigurationSetSendingPaused</code>: Email sending for this
|
|
487
491
|
* configuration set was disabled using the <a>UpdateConfigurationSetSendingEnabled</a> operation.</p>
|
|
488
492
|
* </li>
|
|
489
493
|
* <li>
|
|
490
|
-
*
|
|
494
|
+
* <p>
|
|
491
495
|
* <code>InvalidParameterValue</code>: One or more of the parameters you
|
|
492
496
|
* specified when calling this operation was invalid. See the error message for
|
|
493
497
|
* additional information.</p>
|
|
494
498
|
* </li>
|
|
495
499
|
* <li>
|
|
496
|
-
*
|
|
500
|
+
* <p>
|
|
497
501
|
* <code>TransientFailure</code>: Amazon SES was unable to process your request
|
|
498
502
|
* because of a temporary issue.</p>
|
|
499
503
|
* </li>
|
|
500
504
|
* <li>
|
|
501
|
-
*
|
|
505
|
+
* <p>
|
|
502
506
|
* <code>Failed</code>: Amazon SES was unable to process your request. See the error
|
|
503
507
|
* message for additional information.</p>
|
|
504
508
|
* </li>
|
|
@@ -539,22 +543,24 @@ export declare class CannotDeleteException extends __BaseException {
|
|
|
539
543
|
/**
|
|
540
544
|
* @public
|
|
541
545
|
* <p>Represents a request to create a receipt rule set by cloning an existing one. You use
|
|
542
|
-
* receipt rule sets to receive email with Amazon SES. For more information, see the <a href="https://docs.aws.amazon.com/ses/latest/
|
|
546
|
+
* receipt rule sets to receive email with Amazon SES. For more information, see the <a href="https://docs.aws.amazon.com/ses/latest/dg/receiving-email-concepts.html">Amazon SES
|
|
547
|
+
* Developer Guide</a>.</p>
|
|
543
548
|
*/
|
|
544
549
|
export interface CloneReceiptRuleSetRequest {
|
|
545
550
|
/**
|
|
546
551
|
* @public
|
|
547
|
-
* <p>The name of the rule set to create. The name must
|
|
548
|
-
*
|
|
552
|
+
* <p>The name of the rule set to create. The name must meet the following
|
|
553
|
+
* requirements:</p>
|
|
554
|
+
* <ul>
|
|
549
555
|
* <li>
|
|
550
|
-
*
|
|
551
|
-
*
|
|
556
|
+
* <p>Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or
|
|
557
|
+
* dashes (-).</p>
|
|
552
558
|
* </li>
|
|
553
559
|
* <li>
|
|
554
|
-
*
|
|
560
|
+
* <p>Start and end with a letter or number.</p>
|
|
555
561
|
* </li>
|
|
556
562
|
* <li>
|
|
557
|
-
*
|
|
563
|
+
* <p>Contain 64 characters or fewer.</p>
|
|
558
564
|
* </li>
|
|
559
565
|
* </ul>
|
|
560
566
|
*/
|
|
@@ -619,45 +625,47 @@ export type DimensionValueSource = (typeof DimensionValueSource)[keyof typeof Di
|
|
|
619
625
|
* @public
|
|
620
626
|
* <p>Contains the dimension configuration to use when you publish email sending events to
|
|
621
627
|
* Amazon CloudWatch.</p>
|
|
622
|
-
*
|
|
628
|
+
* <p>For information about publishing email sending events to Amazon CloudWatch, see the <a href="https://docs.aws.amazon.com/ses/latest/dg/monitor-sending-activity.html">Amazon SES
|
|
629
|
+
* Developer Guide</a>.</p>
|
|
623
630
|
*/
|
|
624
631
|
export interface CloudWatchDimensionConfiguration {
|
|
625
632
|
/**
|
|
626
633
|
* @public
|
|
627
634
|
* <p>The name of an Amazon CloudWatch dimension associated with an email sending metric. The name
|
|
628
|
-
* must:</p>
|
|
629
|
-
*
|
|
635
|
+
* must meet the following requirements:</p>
|
|
636
|
+
* <ul>
|
|
630
637
|
* <li>
|
|
631
|
-
*
|
|
632
|
-
*
|
|
638
|
+
* <p>Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), dashes
|
|
639
|
+
* (-), or colons (:).</p>
|
|
633
640
|
* </li>
|
|
634
641
|
* <li>
|
|
635
|
-
*
|
|
642
|
+
* <p>Contain 256 characters or fewer.</p>
|
|
636
643
|
* </li>
|
|
637
644
|
* </ul>
|
|
638
645
|
*/
|
|
639
646
|
DimensionName: string | undefined;
|
|
640
647
|
/**
|
|
641
648
|
* @public
|
|
642
|
-
* <p>The place where Amazon SES finds the value of a dimension to publish to Amazon CloudWatch.
|
|
643
|
-
*
|
|
644
|
-
*
|
|
645
|
-
* <code>
|
|
646
|
-
*
|
|
647
|
-
*
|
|
649
|
+
* <p>The place where Amazon SES finds the value of a dimension to publish to Amazon CloudWatch. To use
|
|
650
|
+
* the message tags that you specify using an <code>X-SES-MESSAGE-TAGS</code> header or a
|
|
651
|
+
* parameter to the <code>SendEmail</code>/<code>SendRawEmail</code> API, specify
|
|
652
|
+
* <code>messageTag</code>. To use your own email headers, specify
|
|
653
|
+
* <code>emailHeader</code>. To put a custom tag on any link included in your email,
|
|
654
|
+
* specify <code>linkTag</code>.</p>
|
|
648
655
|
*/
|
|
649
656
|
DimensionValueSource: DimensionValueSource | string | undefined;
|
|
650
657
|
/**
|
|
651
658
|
* @public
|
|
652
659
|
* <p>The default value of the dimension that is published to Amazon CloudWatch if you do not provide
|
|
653
|
-
* the value of the dimension when you send an email. The default value must
|
|
654
|
-
*
|
|
660
|
+
* the value of the dimension when you send an email. The default value must meet the
|
|
661
|
+
* following requirements:</p>
|
|
662
|
+
* <ul>
|
|
655
663
|
* <li>
|
|
656
|
-
*
|
|
657
|
-
*
|
|
664
|
+
* <p>Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), dashes
|
|
665
|
+
* (-), at signs (@), or periods (.).</p>
|
|
658
666
|
* </li>
|
|
659
667
|
* <li>
|
|
660
|
-
*
|
|
668
|
+
* <p>Contain 256 characters or fewer.</p>
|
|
661
669
|
* </li>
|
|
662
670
|
* </ul>
|
|
663
671
|
*/
|
|
@@ -667,10 +675,10 @@ export interface CloudWatchDimensionConfiguration {
|
|
|
667
675
|
* @public
|
|
668
676
|
* <p>Contains information associated with an Amazon CloudWatch event destination to which email
|
|
669
677
|
* sending events are published.</p>
|
|
670
|
-
*
|
|
678
|
+
* <p>Event destinations, such as Amazon CloudWatch, are associated with configuration sets, which
|
|
671
679
|
* enable you to publish email sending events. For information about using configuration
|
|
672
|
-
* sets, see the <a href="https://docs.aws.amazon.com/ses/latest/
|
|
673
|
-
*
|
|
680
|
+
* sets, see the <a href="https://docs.aws.amazon.com/ses/latest/dg/monitor-sending-activity.html">Amazon SES Developer
|
|
681
|
+
* Guide</a>.</p>
|
|
674
682
|
*/
|
|
675
683
|
export interface CloudWatchDestination {
|
|
676
684
|
/**
|
|
@@ -683,21 +691,22 @@ export interface CloudWatchDestination {
|
|
|
683
691
|
/**
|
|
684
692
|
* @public
|
|
685
693
|
* <p>The name of the configuration set.</p>
|
|
686
|
-
*
|
|
687
|
-
* send using Amazon SES. For more information about using configuration sets, see <a href="https://docs.aws.amazon.com/ses/latest/
|
|
694
|
+
* <p>Configuration sets let you create groups of rules that you can apply to the emails you
|
|
695
|
+
* send using Amazon SES. For more information about using configuration sets, see <a href="https://docs.aws.amazon.com/ses/latest/dg/using-configuration-sets.html">Using Amazon SES
|
|
696
|
+
* Configuration Sets</a> in the <a href="https://docs.aws.amazon.com/ses/latest/dg/">Amazon SES Developer Guide</a>.</p>
|
|
688
697
|
*/
|
|
689
698
|
export interface ConfigurationSet {
|
|
690
699
|
/**
|
|
691
700
|
* @public
|
|
692
701
|
* <p>The name of the configuration set. The name must meet the following
|
|
693
702
|
* requirements:</p>
|
|
694
|
-
*
|
|
703
|
+
* <ul>
|
|
695
704
|
* <li>
|
|
696
|
-
*
|
|
705
|
+
* <p>Contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes
|
|
697
706
|
* (-).</p>
|
|
698
707
|
* </li>
|
|
699
708
|
* <li>
|
|
700
|
-
*
|
|
709
|
+
* <p>Contain 64 characters or fewer.</p>
|
|
701
710
|
* </li>
|
|
702
711
|
* </ul>
|
|
703
712
|
*/
|
|
@@ -755,7 +764,7 @@ export declare class ConfigurationSetDoesNotExistException extends __BaseExcepti
|
|
|
755
764
|
/**
|
|
756
765
|
* @public
|
|
757
766
|
* <p>Indicates that email sending is disabled for the configuration set.</p>
|
|
758
|
-
*
|
|
767
|
+
* <p>You can enable or disable email sending for a configuration set using <a>UpdateConfigurationSetSendingEnabled</a>.</p>
|
|
759
768
|
*/
|
|
760
769
|
export declare class ConfigurationSetSendingPausedException extends __BaseException {
|
|
761
770
|
readonly name: "ConfigurationSetSendingPausedException";
|
|
@@ -774,8 +783,8 @@ export declare class ConfigurationSetSendingPausedException extends __BaseExcept
|
|
|
774
783
|
* @public
|
|
775
784
|
* <p>Represents a request to create a configuration set. Configuration sets enable you to
|
|
776
785
|
* publish email sending events. For information about using configuration sets, see the
|
|
777
|
-
* <a href="https://docs.aws.amazon.com/ses/latest/
|
|
778
|
-
* Guide</a>.</p>
|
|
786
|
+
* <a href="https://docs.aws.amazon.com/ses/latest/dg/monitor-sending-activity.html">Amazon SES
|
|
787
|
+
* Developer Guide</a>.</p>
|
|
779
788
|
*/
|
|
780
789
|
export interface CreateConfigurationSetRequest {
|
|
781
790
|
/**
|
|
@@ -807,10 +816,10 @@ export declare class InvalidConfigurationSetException extends __BaseException {
|
|
|
807
816
|
* @public
|
|
808
817
|
* <p>Contains the delivery stream ARN and the IAM role ARN associated with an Amazon Kinesis Firehose event
|
|
809
818
|
* destination.</p>
|
|
810
|
-
*
|
|
819
|
+
* <p>Event destinations, such as Amazon Kinesis Firehose, are associated with configuration sets, which enable
|
|
811
820
|
* you to publish email sending events. For information about using configuration sets, see
|
|
812
|
-
* the <a href="https://docs.aws.amazon.com/ses/latest/
|
|
813
|
-
* Guide</a>.</p>
|
|
821
|
+
* the <a href="https://docs.aws.amazon.com/ses/latest/dg/monitor-sending-activity.html">Amazon SES
|
|
822
|
+
* Developer Guide</a>.</p>
|
|
814
823
|
*/
|
|
815
824
|
export interface KinesisFirehoseDestination {
|
|
816
825
|
/**
|
|
@@ -846,44 +855,44 @@ export type EventType = (typeof EventType)[keyof typeof EventType];
|
|
|
846
855
|
/**
|
|
847
856
|
* @public
|
|
848
857
|
* <p>Contains the topic ARN associated with an Amazon Simple Notification Service (Amazon SNS) event destination.</p>
|
|
849
|
-
*
|
|
858
|
+
* <p>Event destinations, such as Amazon SNS, are associated with configuration sets, which
|
|
850
859
|
* enable you to publish email sending events. For information about using configuration
|
|
851
|
-
* sets, see the <a href="https://docs.aws.amazon.com/ses/latest/
|
|
852
|
-
*
|
|
860
|
+
* sets, see the <a href="https://docs.aws.amazon.com/ses/latest/dg/monitor-sending-activity.html">Amazon SES Developer
|
|
861
|
+
* Guide</a>.</p>
|
|
853
862
|
*/
|
|
854
863
|
export interface SNSDestination {
|
|
855
864
|
/**
|
|
856
865
|
* @public
|
|
857
|
-
* <p>The ARN of the Amazon SNS topic
|
|
858
|
-
*
|
|
859
|
-
*
|
|
866
|
+
* <p>The ARN of the Amazon SNS topic for email sending events. You can find the ARN of a topic
|
|
867
|
+
* by using the <a href="https://docs.aws.amazon.com/sns/latest/api/API_ListTopics.html">ListTopics</a> Amazon SNS operation.</p>
|
|
868
|
+
* <p>For 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>
|
|
860
869
|
*/
|
|
861
870
|
TopicARN: string | undefined;
|
|
862
871
|
}
|
|
863
872
|
/**
|
|
864
873
|
* @public
|
|
865
|
-
* <p>Contains information about
|
|
866
|
-
*
|
|
867
|
-
* <note>
|
|
874
|
+
* <p>Contains information about an event destination.</p>
|
|
875
|
+
* <note>
|
|
868
876
|
* <p>When you create or update an event destination, you must provide one, and only
|
|
869
877
|
* one, destination. The destination can be Amazon CloudWatch, Amazon Kinesis Firehose or Amazon Simple Notification Service (Amazon SNS).</p>
|
|
870
|
-
*
|
|
871
|
-
*
|
|
878
|
+
* </note>
|
|
879
|
+
* <p>Event destinations are associated with configuration sets, which enable you to publish
|
|
872
880
|
* email sending events to Amazon CloudWatch, Amazon Kinesis Firehose, or Amazon Simple Notification Service (Amazon SNS). For information about
|
|
873
|
-
* using configuration sets, see the <a href="https://docs.aws.amazon.com/ses/latest/
|
|
874
|
-
*
|
|
881
|
+
* using configuration sets, see the <a href="https://docs.aws.amazon.com/ses/latest/dg/monitor-sending-activity.html">Amazon SES Developer
|
|
882
|
+
* Guide</a>.</p>
|
|
875
883
|
*/
|
|
876
884
|
export interface EventDestination {
|
|
877
885
|
/**
|
|
878
886
|
* @public
|
|
879
|
-
* <p>The name of the event destination. The name must
|
|
880
|
-
*
|
|
887
|
+
* <p>The name of the event destination. The name must meet the following
|
|
888
|
+
* requirements:</p>
|
|
889
|
+
* <ul>
|
|
881
890
|
* <li>
|
|
882
|
-
*
|
|
883
|
-
*
|
|
891
|
+
* <p>Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or
|
|
892
|
+
* dashes (-).</p>
|
|
884
893
|
* </li>
|
|
885
894
|
* <li>
|
|
886
|
-
*
|
|
895
|
+
* <p>Contain 64 characters or fewer.</p>
|
|
887
896
|
* </li>
|
|
888
897
|
* </ul>
|
|
889
898
|
*/
|
|
@@ -899,6 +908,47 @@ export interface EventDestination {
|
|
|
899
908
|
/**
|
|
900
909
|
* @public
|
|
901
910
|
* <p>The type of email sending events to publish to the event destination.</p>
|
|
911
|
+
* <ul>
|
|
912
|
+
* <li>
|
|
913
|
+
* <p>
|
|
914
|
+
* <code>send</code> - The call was successful and Amazon SES is attempting to deliver
|
|
915
|
+
* the email.</p>
|
|
916
|
+
* </li>
|
|
917
|
+
* <li>
|
|
918
|
+
* <p>
|
|
919
|
+
* <code>reject</code> - Amazon SES determined that the email contained a virus and
|
|
920
|
+
* rejected it.</p>
|
|
921
|
+
* </li>
|
|
922
|
+
* <li>
|
|
923
|
+
* <p>
|
|
924
|
+
* <code>bounce</code> - The recipient's mail server permanently rejected the
|
|
925
|
+
* email. This corresponds to a hard bounce.</p>
|
|
926
|
+
* </li>
|
|
927
|
+
* <li>
|
|
928
|
+
* <p>
|
|
929
|
+
* <code>complaint</code> - The recipient marked the email as spam.</p>
|
|
930
|
+
* </li>
|
|
931
|
+
* <li>
|
|
932
|
+
* <p>
|
|
933
|
+
* <code>delivery</code> - Amazon SES successfully delivered the email to the
|
|
934
|
+
* recipient's mail server.</p>
|
|
935
|
+
* </li>
|
|
936
|
+
* <li>
|
|
937
|
+
* <p>
|
|
938
|
+
* <code>open</code> - The recipient received the email and opened it in their
|
|
939
|
+
* email client.</p>
|
|
940
|
+
* </li>
|
|
941
|
+
* <li>
|
|
942
|
+
* <p>
|
|
943
|
+
* <code>click</code> - The recipient clicked one or more links in the
|
|
944
|
+
* email.</p>
|
|
945
|
+
* </li>
|
|
946
|
+
* <li>
|
|
947
|
+
* <p>
|
|
948
|
+
* <code>renderingFailure</code> - Amazon SES did not send the email because of a
|
|
949
|
+
* template rendering issue.</p>
|
|
950
|
+
* </li>
|
|
951
|
+
* </ul>
|
|
902
952
|
*/
|
|
903
953
|
MatchingEventTypes: (EventType | string)[] | undefined;
|
|
904
954
|
/**
|
|
@@ -923,10 +973,10 @@ export interface EventDestination {
|
|
|
923
973
|
/**
|
|
924
974
|
* @public
|
|
925
975
|
* <p>Represents a request to create a configuration set event destination. A configuration
|
|
926
|
-
* set event destination, which can be either Amazon CloudWatch or Amazon Kinesis Firehose, describes an
|
|
976
|
+
* set event destination, which can be either Amazon CloudWatch or Amazon Kinesis Firehose, describes an Amazon Web Services service
|
|
927
977
|
* in which Amazon SES publishes the email sending events associated with a configuration set.
|
|
928
|
-
* For information about using configuration sets, see the <a href="https://docs.aws.amazon.com/ses/latest/
|
|
929
|
-
*
|
|
978
|
+
* For information about using configuration sets, see the <a href="https://docs.aws.amazon.com/ses/latest/dg/monitor-sending-activity.html">Amazon SES Developer
|
|
979
|
+
* Guide</a>.</p>
|
|
930
980
|
*/
|
|
931
981
|
export interface CreateConfigurationSetEventDestinationRequest {
|
|
932
982
|
/**
|
|
@@ -937,8 +987,8 @@ export interface CreateConfigurationSetEventDestinationRequest {
|
|
|
937
987
|
ConfigurationSetName: string | undefined;
|
|
938
988
|
/**
|
|
939
989
|
* @public
|
|
940
|
-
* <p>An object that describes the
|
|
941
|
-
*
|
|
990
|
+
* <p>An object that describes the Amazon Web Services service that email sending event where information
|
|
991
|
+
* is published.</p>
|
|
942
992
|
*/
|
|
943
993
|
EventDestination: EventDestination | undefined;
|
|
944
994
|
}
|
|
@@ -1044,15 +1094,15 @@ export declare class InvalidSNSDestinationException extends __BaseException {
|
|
|
1044
1094
|
* @public
|
|
1045
1095
|
* <p>A domain that is used to redirect email recipients to an Amazon SES-operated domain. This
|
|
1046
1096
|
* domain captures open and click events generated by Amazon SES emails.</p>
|
|
1047
|
-
*
|
|
1048
|
-
*
|
|
1049
|
-
*
|
|
1097
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/ses/latest/dg/configure-custom-open-click-domains.html">Configuring Custom
|
|
1098
|
+
* Domains to Handle Open and Click Tracking</a> in the <i>Amazon SES Developer
|
|
1099
|
+
* Guide</i>.</p>
|
|
1050
1100
|
*/
|
|
1051
1101
|
export interface TrackingOptions {
|
|
1052
1102
|
/**
|
|
1053
1103
|
* @public
|
|
1054
|
-
* <p>The custom subdomain that
|
|
1055
|
-
*
|
|
1104
|
+
* <p>The custom subdomain that is used to redirect email recipients to the Amazon SES event
|
|
1105
|
+
* tracking domain.</p>
|
|
1056
1106
|
*/
|
|
1057
1107
|
CustomRedirectDomain?: string;
|
|
1058
1108
|
}
|
|
@@ -1072,9 +1122,9 @@ export interface CreateConfigurationSetTrackingOptionsRequest {
|
|
|
1072
1122
|
* @public
|
|
1073
1123
|
* <p>A domain that is used to redirect email recipients to an Amazon SES-operated domain. This
|
|
1074
1124
|
* domain captures open and click events generated by Amazon SES emails.</p>
|
|
1075
|
-
*
|
|
1076
|
-
*
|
|
1077
|
-
*
|
|
1125
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/ses/latest/dg/configure-custom-open-click-domains.html">Configuring Custom
|
|
1126
|
+
* Domains to Handle Open and Click Tracking</a> in the <i>Amazon SES Developer
|
|
1127
|
+
* Guide</i>.</p>
|
|
1078
1128
|
*/
|
|
1079
1129
|
TrackingOptions: TrackingOptions | undefined;
|
|
1080
1130
|
}
|
|
@@ -1088,12 +1138,12 @@ export interface CreateConfigurationSetTrackingOptionsResponse {
|
|
|
1088
1138
|
* @public
|
|
1089
1139
|
* <p>Indicates that the custom domain to be used for open and click tracking redirects is
|
|
1090
1140
|
* invalid. This error appears most often in the following situations:</p>
|
|
1091
|
-
*
|
|
1141
|
+
* <ul>
|
|
1092
1142
|
* <li>
|
|
1093
|
-
*
|
|
1143
|
+
* <p>When the tracking domain you specified is not verified in Amazon SES.</p>
|
|
1094
1144
|
* </li>
|
|
1095
1145
|
* <li>
|
|
1096
|
-
*
|
|
1146
|
+
* <p>When the tracking domain you specified is not a valid domain or
|
|
1097
1147
|
* subdomain.</p>
|
|
1098
1148
|
* </li>
|
|
1099
1149
|
* </ul>
|
|
@@ -1149,7 +1199,8 @@ export interface CreateCustomVerificationEmailTemplateRequest {
|
|
|
1149
1199
|
* @public
|
|
1150
1200
|
* <p>The content of the custom verification email. The total size of the email must be less
|
|
1151
1201
|
* than 10 MB. The message body may contain HTML, with some limitations. For more
|
|
1152
|
-
* information, see <a href="https://docs.aws.amazon.com/ses/latest/
|
|
1202
|
+
* information, see <a href="https://docs.aws.amazon.com/ses/latest/dg/creating-identities.html#send-email-verify-address-custom">Custom
|
|
1203
|
+
* Verification Email Frequently Asked Questions</a> in the <i>Amazon SES
|
|
1153
1204
|
* Developer Guide</i>.</p>
|
|
1154
1205
|
*/
|
|
1155
1206
|
TemplateContent: string | undefined;
|
|
@@ -1232,7 +1283,8 @@ export type ReceiptFilterPolicy = (typeof ReceiptFilterPolicy)[keyof typeof Rece
|
|
|
1232
1283
|
* @public
|
|
1233
1284
|
* <p>A receipt IP address filter enables you to specify whether to accept or reject mail
|
|
1234
1285
|
* originating from an IP address or range of IP addresses.</p>
|
|
1235
|
-
*
|
|
1286
|
+
* <p>For information about setting up IP address filters, see the <a href="https://docs.aws.amazon.com/ses/latest/dg/receiving-email-ip-filtering-console-walkthrough.html">Amazon SES
|
|
1287
|
+
* Developer Guide</a>.</p>
|
|
1236
1288
|
*/
|
|
1237
1289
|
export interface ReceiptIpFilter {
|
|
1238
1290
|
/**
|
|
@@ -1243,10 +1295,11 @@ export interface ReceiptIpFilter {
|
|
|
1243
1295
|
Policy: ReceiptFilterPolicy | string | undefined;
|
|
1244
1296
|
/**
|
|
1245
1297
|
* @public
|
|
1246
|
-
* <p>A single IP address or a range of IP addresses
|
|
1247
|
-
*
|
|
1248
|
-
*
|
|
1249
|
-
*
|
|
1298
|
+
* <p>A single IP address or a range of IP addresses to block or allow, specified in
|
|
1299
|
+
* Classless Inter-Domain Routing (CIDR) notation. An example of a single email address is
|
|
1300
|
+
* 10.0.0.1. An example of a range of IP addresses is 10.0.0.1/24. For more information
|
|
1301
|
+
* about CIDR notation, see <a href="https://tools.ietf.org/html/rfc2317">RFC
|
|
1302
|
+
* 2317</a>.</p>
|
|
1250
1303
|
*/
|
|
1251
1304
|
Cidr: string | undefined;
|
|
1252
1305
|
}
|
|
@@ -1254,22 +1307,24 @@ export interface ReceiptIpFilter {
|
|
|
1254
1307
|
* @public
|
|
1255
1308
|
* <p>A receipt IP address filter enables you to specify whether to accept or reject mail
|
|
1256
1309
|
* originating from an IP address or range of IP addresses.</p>
|
|
1257
|
-
*
|
|
1310
|
+
* <p>For information about setting up IP address filters, see the <a href="https://docs.aws.amazon.com/ses/latest/dg/receiving-email-ip-filtering-console-walkthrough.html">Amazon SES
|
|
1311
|
+
* Developer Guide</a>.</p>
|
|
1258
1312
|
*/
|
|
1259
1313
|
export interface ReceiptFilter {
|
|
1260
1314
|
/**
|
|
1261
1315
|
* @public
|
|
1262
|
-
* <p>The name of the IP address filter. The name must
|
|
1263
|
-
*
|
|
1316
|
+
* <p>The name of the IP address filter. The name must meet the following
|
|
1317
|
+
* requirements:</p>
|
|
1318
|
+
* <ul>
|
|
1264
1319
|
* <li>
|
|
1265
|
-
*
|
|
1266
|
-
*
|
|
1320
|
+
* <p>Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or
|
|
1321
|
+
* dashes (-).</p>
|
|
1267
1322
|
* </li>
|
|
1268
1323
|
* <li>
|
|
1269
|
-
*
|
|
1324
|
+
* <p>Start and end with a letter or number.</p>
|
|
1270
1325
|
* </li>
|
|
1271
1326
|
* <li>
|
|
1272
|
-
*
|
|
1327
|
+
* <p>Contain 64 characters or fewer.</p>
|
|
1273
1328
|
* </li>
|
|
1274
1329
|
* </ul>
|
|
1275
1330
|
*/
|
|
@@ -1284,7 +1339,8 @@ export interface ReceiptFilter {
|
|
|
1284
1339
|
/**
|
|
1285
1340
|
* @public
|
|
1286
1341
|
* <p>Represents a request to create a new IP address filter. You use IP address filters
|
|
1287
|
-
* when you receive email with Amazon SES. For more information, see the <a href="https://docs.aws.amazon.com/ses/latest/
|
|
1342
|
+
* when you receive email with Amazon SES. For more information, see the <a href="https://docs.aws.amazon.com/ses/latest/dg/receiving-email-concepts.html">Amazon SES
|
|
1343
|
+
* Developer Guide</a>.</p>
|
|
1288
1344
|
*/
|
|
1289
1345
|
export interface CreateReceiptFilterRequest {
|
|
1290
1346
|
/**
|
|
@@ -1300,50 +1356,58 @@ export interface CreateReceiptFilterRequest {
|
|
|
1300
1356
|
*/
|
|
1301
1357
|
export interface CreateReceiptFilterResponse {
|
|
1302
1358
|
}
|
|
1359
|
+
/**
|
|
1360
|
+
* @public
|
|
1361
|
+
* @enum
|
|
1362
|
+
*/
|
|
1363
|
+
export declare const InvocationType: {
|
|
1364
|
+
readonly Event: "Event";
|
|
1365
|
+
readonly RequestResponse: "RequestResponse";
|
|
1366
|
+
};
|
|
1303
1367
|
/**
|
|
1304
1368
|
* @public
|
|
1305
1369
|
*/
|
|
1306
|
-
export type InvocationType =
|
|
1370
|
+
export type InvocationType = (typeof InvocationType)[keyof typeof InvocationType];
|
|
1307
1371
|
/**
|
|
1308
1372
|
* @public
|
|
1309
|
-
* <p>When included in a receipt rule, this action calls an
|
|
1373
|
+
* <p>When included in a receipt rule, this action calls an Amazon Web Services Lambda function and,
|
|
1310
1374
|
* optionally, publishes a notification to Amazon Simple Notification Service (Amazon SNS).</p>
|
|
1311
|
-
*
|
|
1375
|
+
* <p>To enable Amazon SES to call your Amazon Web Services Lambda function or to publish to an Amazon SNS topic of
|
|
1312
1376
|
* another account, Amazon SES must have permission to access those resources. For information
|
|
1313
|
-
* about giving permissions, see the <a href="https://docs.aws.amazon.com/ses/latest/
|
|
1314
|
-
*
|
|
1315
|
-
*
|
|
1316
|
-
* Guide</a>.</p>
|
|
1377
|
+
* about giving permissions, see the <a href="https://docs.aws.amazon.com/ses/latest/dg/receiving-email-permissions.html">Amazon SES Developer
|
|
1378
|
+
* Guide</a>.</p>
|
|
1379
|
+
* <p>For information about using Amazon Web Services Lambda actions in receipt rules, see the <a href="https://docs.aws.amazon.com/ses/latest/dg/receiving-email-action-lambda.html">Amazon SES
|
|
1380
|
+
* Developer Guide</a>.</p>
|
|
1317
1381
|
*/
|
|
1318
1382
|
export interface LambdaAction {
|
|
1319
1383
|
/**
|
|
1320
1384
|
* @public
|
|
1321
1385
|
* <p>The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the Lambda action is
|
|
1322
|
-
*
|
|
1323
|
-
*
|
|
1324
|
-
*
|
|
1386
|
+
* executed. You can find the ARN of a topic by using the <a href="https://docs.aws.amazon.com/sns/latest/api/API_ListTopics.html">ListTopics</a> operation in
|
|
1387
|
+
* Amazon SNS.</p>
|
|
1388
|
+
* <p>For 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>
|
|
1325
1389
|
*/
|
|
1326
1390
|
TopicArn?: string;
|
|
1327
1391
|
/**
|
|
1328
1392
|
* @public
|
|
1329
|
-
* <p>The Amazon Resource Name (ARN) of the
|
|
1393
|
+
* <p>The Amazon Resource Name (ARN) of the Amazon Web Services Lambda function. An example of an Amazon Web Services Lambda
|
|
1330
1394
|
* function ARN is <code>arn:aws:lambda:us-west-2:account-id:function:MyFunction</code>.
|
|
1331
|
-
* For more information about
|
|
1395
|
+
* For more information about Amazon Web Services Lambda, see the <a href="https://docs.aws.amazon.com/lambda/latest/dg/welcome.html">Amazon Web Services Lambda Developer Guide</a>.</p>
|
|
1332
1396
|
*/
|
|
1333
1397
|
FunctionArn: string | undefined;
|
|
1334
1398
|
/**
|
|
1335
1399
|
* @public
|
|
1336
|
-
* <p>The invocation type of the
|
|
1337
|
-
* <code>RequestResponse</code> means that the execution of the function
|
|
1338
|
-
*
|
|
1339
|
-
*
|
|
1340
|
-
*
|
|
1341
|
-
*
|
|
1400
|
+
* <p>The invocation type of the Amazon Web Services Lambda function. An invocation type of
|
|
1401
|
+
* <code>RequestResponse</code> means that the execution of the function immediately
|
|
1402
|
+
* results in a response, and a value of <code>Event</code> means that the function is
|
|
1403
|
+
* invoked asynchronously. The default value is <code>Event</code>. For information about
|
|
1404
|
+
* Amazon Web Services Lambda invocation types, see the <a href="https://docs.aws.amazon.com/lambda/latest/dg/API_Invoke.html">Amazon Web Services Lambda Developer Guide</a>.</p>
|
|
1405
|
+
* <important>
|
|
1342
1406
|
* <p>There is a 30-second timeout on <code>RequestResponse</code> invocations. You
|
|
1343
1407
|
* should use <code>Event</code> invocation in most cases. Use
|
|
1344
|
-
* <code>RequestResponse</code> only
|
|
1345
|
-
*
|
|
1346
|
-
*
|
|
1408
|
+
* <code>RequestResponse</code> only to make a mail flow decision, such as whether
|
|
1409
|
+
* to stop the receipt rule or the receipt rule set.</p>
|
|
1410
|
+
* </important>
|
|
1347
1411
|
*/
|
|
1348
1412
|
InvocationType?: InvocationType | string;
|
|
1349
1413
|
}
|
|
@@ -1351,28 +1415,29 @@ export interface LambdaAction {
|
|
|
1351
1415
|
* @public
|
|
1352
1416
|
* <p>When included in a receipt rule, this action saves the received message to an Amazon Simple Storage Service
|
|
1353
1417
|
* (Amazon S3) bucket and, optionally, publishes a notification to Amazon Simple Notification Service (Amazon SNS).</p>
|
|
1354
|
-
*
|
|
1418
|
+
* <p>To enable Amazon SES to write emails to your Amazon S3 bucket, use an Amazon Web Services KMS key to encrypt
|
|
1355
1419
|
* your emails, or publish to an Amazon SNS topic of another account, Amazon SES must have permission
|
|
1356
|
-
* to access those resources. For information about
|
|
1357
|
-
* Guide</a>.</p>
|
|
1358
|
-
*
|
|
1420
|
+
* to access those resources. For information about granting permissions, see the <a href="https://docs.aws.amazon.com/ses/latest/dg/receiving-email-permissions.html">Amazon SES
|
|
1421
|
+
* Developer Guide</a>.</p>
|
|
1422
|
+
* <note>
|
|
1359
1423
|
* <p>When you save your emails to an Amazon S3 bucket, the maximum email size (including
|
|
1360
|
-
* headers) is
|
|
1361
|
-
*
|
|
1362
|
-
*
|
|
1424
|
+
* headers) is 40 MB. Emails larger than that bounces.</p>
|
|
1425
|
+
* </note>
|
|
1426
|
+
* <p>For information about specifying Amazon S3 actions in receipt rules, see the <a href="https://docs.aws.amazon.com/ses/latest/dg/receiving-email-action-s3.html">Amazon SES
|
|
1427
|
+
* Developer Guide</a>.</p>
|
|
1363
1428
|
*/
|
|
1364
1429
|
export interface S3Action {
|
|
1365
1430
|
/**
|
|
1366
1431
|
* @public
|
|
1367
|
-
* <p>The ARN of the Amazon SNS topic to notify when the message is saved to the Amazon S3 bucket.
|
|
1368
|
-
*
|
|
1369
|
-
*
|
|
1370
|
-
*
|
|
1432
|
+
* <p>The ARN of the Amazon SNS topic to notify when the message is saved to the Amazon S3 bucket. You
|
|
1433
|
+
* can find the ARN of a topic by using the <a href="https://docs.aws.amazon.com/sns/latest/api/API_ListTopics.html">ListTopics</a> operation in
|
|
1434
|
+
* Amazon SNS.</p>
|
|
1435
|
+
* <p>For 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>
|
|
1371
1436
|
*/
|
|
1372
1437
|
TopicArn?: string;
|
|
1373
1438
|
/**
|
|
1374
1439
|
* @public
|
|
1375
|
-
* <p>The name of the Amazon S3 bucket
|
|
1440
|
+
* <p>The name of the Amazon S3 bucket for incoming email.</p>
|
|
1376
1441
|
*/
|
|
1377
1442
|
BucketName: string | undefined;
|
|
1378
1443
|
/**
|
|
@@ -1384,37 +1449,39 @@ export interface S3Action {
|
|
|
1384
1449
|
/**
|
|
1385
1450
|
* @public
|
|
1386
1451
|
* <p>The customer master key that Amazon SES should use to encrypt your emails before saving
|
|
1387
|
-
* them to the Amazon S3 bucket. You can use the default master key or a custom master key
|
|
1388
|
-
* created in
|
|
1389
|
-
*
|
|
1452
|
+
* them to the Amazon S3 bucket. You can use the default master key or a custom master key that
|
|
1453
|
+
* you created in Amazon Web Services KMS as follows:</p>
|
|
1454
|
+
* <ul>
|
|
1390
1455
|
* <li>
|
|
1391
|
-
*
|
|
1456
|
+
* <p>To use the default master key, provide an ARN in the form of
|
|
1392
1457
|
* <code>arn:aws:kms:REGION:ACCOUNT-ID-WITHOUT-HYPHENS:alias/aws/ses</code>.
|
|
1393
|
-
* For example, if your
|
|
1394
|
-
* default master key in the US West (Oregon)
|
|
1458
|
+
* For example, if your Amazon Web Services account ID is 123456789012 and you want to use the
|
|
1459
|
+
* default master key in the US West (Oregon) Region, the ARN of the default master
|
|
1395
1460
|
* key would be <code>arn:aws:kms:us-west-2:123456789012:alias/aws/ses</code>. If
|
|
1396
1461
|
* you use the default master key, you don't need to perform any extra steps to
|
|
1397
1462
|
* give Amazon SES permission to use the key.</p>
|
|
1398
1463
|
* </li>
|
|
1399
1464
|
* <li>
|
|
1400
|
-
*
|
|
1401
|
-
* master key and ensure that you add a statement to your key's policy to give
|
|
1465
|
+
* <p>To use a custom master key that you created in Amazon Web Services KMS, provide the ARN of
|
|
1466
|
+
* the master key and ensure that you add a statement to your key's policy to give
|
|
1402
1467
|
* Amazon SES permission to use it. For more information about giving permissions, see
|
|
1403
|
-
* the <a href="https://docs.aws.amazon.com/ses/latest/
|
|
1404
|
-
*
|
|
1468
|
+
* the <a href="https://docs.aws.amazon.com/ses/latest/dg/receiving-email-permissions.html">Amazon SES Developer
|
|
1469
|
+
* Guide</a>.</p>
|
|
1405
1470
|
* </li>
|
|
1406
1471
|
* </ul>
|
|
1407
|
-
*
|
|
1408
|
-
* you do not specify a master key, Amazon SES
|
|
1409
|
-
*
|
|
1472
|
+
* <p>For more information about key policies, see the <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html">Amazon Web Services KMS Developer Guide</a>. If
|
|
1473
|
+
* you do not specify a master key, Amazon SES does not encrypt your emails.</p>
|
|
1474
|
+
* <important>
|
|
1410
1475
|
* <p>Your mail is encrypted by Amazon SES using the Amazon S3 encryption client before the mail
|
|
1411
1476
|
* is submitted to Amazon S3 for storage. It is not encrypted using Amazon S3 server-side
|
|
1412
1477
|
* encryption. This means that you must use the Amazon S3 encryption client to decrypt the
|
|
1413
|
-
* email after retrieving it from Amazon S3, as the service has no access to use your
|
|
1414
|
-
* KMS keys for decryption. This encryption client is currently available with
|
|
1415
|
-
*
|
|
1416
|
-
*
|
|
1417
|
-
*
|
|
1478
|
+
* email after retrieving it from Amazon S3, as the service has no access to use your
|
|
1479
|
+
* Amazon Web Services KMS keys for decryption. This encryption client is currently available with
|
|
1480
|
+
* the <a href="http://aws.amazon.com/sdk-for-java/">Amazon Web Services SDK for Java</a> and
|
|
1481
|
+
* <a href="http://aws.amazon.com/sdk-for-ruby/">Amazon Web Services SDK for Ruby</a> only. For
|
|
1482
|
+
* more information about client-side encryption using Amazon Web Services KMS master keys, see the
|
|
1483
|
+
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingClientSideEncryption.html">Amazon S3 Developer Guide</a>.</p>
|
|
1484
|
+
* </important>
|
|
1418
1485
|
*/
|
|
1419
1486
|
KmsKeyArn?: string;
|
|
1420
1487
|
}
|
|
@@ -1436,26 +1503,25 @@ export type SNSActionEncoding = (typeof SNSActionEncoding)[keyof typeof SNSActio
|
|
|
1436
1503
|
* (Amazon SNS). This action includes a complete copy of the email content in the Amazon SNS
|
|
1437
1504
|
* notifications. Amazon SNS notifications for all other actions simply provide information
|
|
1438
1505
|
* about the email. They do not include the email content itself.</p>
|
|
1439
|
-
*
|
|
1506
|
+
* <p>If you own the Amazon SNS topic, you don't need to do anything to give Amazon SES permission to
|
|
1440
1507
|
* publish emails to it. However, if you don't own the Amazon SNS topic, you need to attach a
|
|
1441
1508
|
* policy to the topic to give Amazon SES permissions to access it. For information about giving
|
|
1442
|
-
* permissions, see the <a href="https://docs.aws.amazon.com/ses/latest/
|
|
1443
|
-
*
|
|
1444
|
-
*
|
|
1509
|
+
* permissions, see the <a href="https://docs.aws.amazon.com/ses/latest/dg/receiving-email-permissions.html">Amazon SES Developer
|
|
1510
|
+
* Guide</a>.</p>
|
|
1511
|
+
* <important>
|
|
1445
1512
|
* <p>You can only publish emails that are 150 KB or less (including the header) to
|
|
1446
|
-
* Amazon SNS. Larger emails
|
|
1447
|
-
*
|
|
1448
|
-
*
|
|
1449
|
-
*
|
|
1450
|
-
* <a href="https://docs.aws.amazon.com/ses/latest/
|
|
1451
|
-
* Guide</a>.</p>
|
|
1513
|
+
* Amazon SNS. Larger emails bounce. If you anticipate emails larger than 150 KB, use the S3
|
|
1514
|
+
* action instead.</p>
|
|
1515
|
+
* </important>
|
|
1516
|
+
* <p>For information about using a receipt rule to publish an Amazon SNS notification, see the
|
|
1517
|
+
* <a href="https://docs.aws.amazon.com/ses/latest/dg/receiving-email-action-sns.html">Amazon SES Developer Guide</a>.</p>
|
|
1452
1518
|
*/
|
|
1453
1519
|
export interface SNSAction {
|
|
1454
1520
|
/**
|
|
1455
1521
|
* @public
|
|
1456
|
-
* <p>The Amazon Resource Name (ARN) of the Amazon SNS topic to notify.
|
|
1457
|
-
* topic
|
|
1458
|
-
*
|
|
1522
|
+
* <p>The Amazon Resource Name (ARN) of the Amazon SNS topic to notify. You can find the ARN of a
|
|
1523
|
+
* topic by using the <a href="https://docs.aws.amazon.com/sns/latest/api/API_ListTopics.html">ListTopics</a> operation in Amazon SNS.</p>
|
|
1524
|
+
* <p>For 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>
|
|
1459
1525
|
*/
|
|
1460
1526
|
TopicArn: string | undefined;
|
|
1461
1527
|
/**
|
|
@@ -1482,8 +1548,8 @@ export type StopScope = (typeof StopScope)[keyof typeof StopScope];
|
|
|
1482
1548
|
* @public
|
|
1483
1549
|
* <p>When included in a receipt rule, this action terminates the evaluation of the receipt
|
|
1484
1550
|
* rule set and, optionally, publishes a notification to Amazon Simple Notification Service (Amazon SNS).</p>
|
|
1485
|
-
*
|
|
1486
|
-
* Guide</a>.</p>
|
|
1551
|
+
* <p>For information about setting a stop action in a receipt rule, see the <a href="https://docs.aws.amazon.com/ses/latest/dg/receiving-email-action-stop.html">Amazon SES
|
|
1552
|
+
* Developer Guide</a>.</p>
|
|
1487
1553
|
*/
|
|
1488
1554
|
export interface StopAction {
|
|
1489
1555
|
/**
|
|
@@ -1494,37 +1560,40 @@ export interface StopAction {
|
|
|
1494
1560
|
/**
|
|
1495
1561
|
* @public
|
|
1496
1562
|
* <p>The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the stop action is
|
|
1497
|
-
* taken.
|
|
1498
|
-
*
|
|
1499
|
-
* Amazon SNS topics, see the <a href="https://docs.aws.amazon.com/sns/latest/dg/CreateTopic.html">Amazon SNS Developer Guide</a>.</p>
|
|
1563
|
+
* taken. You can find the ARN of a topic by using the <a href="https://docs.aws.amazon.com/sns/latest/api/API_ListTopics.html">ListTopics</a> Amazon SNS operation.</p>
|
|
1564
|
+
* <p>For 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>
|
|
1500
1565
|
*/
|
|
1501
1566
|
TopicArn?: string;
|
|
1502
1567
|
}
|
|
1503
1568
|
/**
|
|
1504
1569
|
* @public
|
|
1505
1570
|
* <p>When included in a receipt rule, this action calls Amazon WorkMail and, optionally,
|
|
1506
|
-
* publishes a notification to Amazon Simple Notification Service (Amazon SNS).
|
|
1507
|
-
*
|
|
1571
|
+
* publishes a notification to Amazon Simple Notification Service (Amazon SNS). It usually isn't necessary to set this up
|
|
1572
|
+
* manually, because Amazon WorkMail adds the rule automatically during its setup
|
|
1508
1573
|
* procedure.</p>
|
|
1509
|
-
*
|
|
1510
|
-
* Guide</a>.</p>
|
|
1574
|
+
* <p>For information using a receipt rule to call Amazon WorkMail, see the <a href="https://docs.aws.amazon.com/ses/latest/dg/receiving-email-action-workmail.html">Amazon SES
|
|
1575
|
+
* Developer Guide</a>.</p>
|
|
1511
1576
|
*/
|
|
1512
1577
|
export interface WorkmailAction {
|
|
1513
1578
|
/**
|
|
1514
1579
|
* @public
|
|
1515
1580
|
* <p>The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the WorkMail action
|
|
1516
|
-
* is called.
|
|
1517
|
-
*
|
|
1518
|
-
*
|
|
1581
|
+
* is called. You can find the ARN of a topic by using the <a href="https://docs.aws.amazon.com/sns/latest/api/API_ListTopics.html">ListTopics</a> operation in
|
|
1582
|
+
* Amazon SNS.</p>
|
|
1583
|
+
* <p>For 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>
|
|
1519
1584
|
*/
|
|
1520
1585
|
TopicArn?: string;
|
|
1521
1586
|
/**
|
|
1522
1587
|
* @public
|
|
1523
|
-
* <p>The ARN of the Amazon WorkMail organization.
|
|
1524
|
-
*
|
|
1525
|
-
*
|
|
1526
|
-
*
|
|
1527
|
-
*
|
|
1588
|
+
* <p>The Amazon Resource Name (ARN) of the Amazon WorkMail organization. Amazon WorkMail
|
|
1589
|
+
* ARNs use the following format:</p>
|
|
1590
|
+
* <p>
|
|
1591
|
+
* <code>arn:aws:workmail:<region>:<awsAccountId>:organization/<workmailOrganizationId></code>
|
|
1592
|
+
* </p>
|
|
1593
|
+
* <p>You can find the ID of your organization by using the <a href="https://docs.aws.amazon.com/workmail/latest/APIReference/API_ListOrganizations.html">ListOrganizations</a> operation in Amazon WorkMail. Amazon WorkMail
|
|
1594
|
+
* organization IDs begin with "<code>m-</code>", followed by a string of alphanumeric
|
|
1595
|
+
* characters.</p>
|
|
1596
|
+
* <p>For information about Amazon WorkMail organizations, see the <a href="https://docs.aws.amazon.com/workmail/latest/adminguide/organizations_overview.html">Amazon WorkMail Administrator Guide</a>.</p>
|
|
1528
1597
|
*/
|
|
1529
1598
|
OrganizationArn: string | undefined;
|
|
1530
1599
|
}
|
|
@@ -1533,8 +1602,8 @@ export interface WorkmailAction {
|
|
|
1533
1602
|
* <p>An action that Amazon SES can take when it receives an email on behalf of one or more email
|
|
1534
1603
|
* addresses or domains that you own. An instance of this data type can represent only one
|
|
1535
1604
|
* action.</p>
|
|
1536
|
-
*
|
|
1537
|
-
* Guide</a>.</p>
|
|
1605
|
+
* <p>For information about setting up receipt rules, see the <a href="https://docs.aws.amazon.com/ses/latest/dg/receiving-email-receipt-rules-console-walkthrough.html">Amazon SES
|
|
1606
|
+
* Developer Guide</a>.</p>
|
|
1538
1607
|
*/
|
|
1539
1608
|
export interface ReceiptAction {
|
|
1540
1609
|
/**
|
|
@@ -1557,7 +1626,7 @@ export interface ReceiptAction {
|
|
|
1557
1626
|
WorkmailAction?: WorkmailAction;
|
|
1558
1627
|
/**
|
|
1559
1628
|
* @public
|
|
1560
|
-
* <p>Calls an
|
|
1629
|
+
* <p>Calls an Amazon Web Services Lambda function, and optionally, publishes a notification to Amazon SNS.</p>
|
|
1561
1630
|
*/
|
|
1562
1631
|
LambdaAction?: LambdaAction;
|
|
1563
1632
|
/**
|
|
@@ -1593,26 +1662,26 @@ export type TlsPolicy = (typeof TlsPolicy)[keyof typeof TlsPolicy];
|
|
|
1593
1662
|
* @public
|
|
1594
1663
|
* <p>Receipt rules enable you to specify which actions Amazon SES should take when it receives
|
|
1595
1664
|
* mail on behalf of one or more email addresses or domains that you own.</p>
|
|
1596
|
-
*
|
|
1665
|
+
* <p>Each receipt rule defines a set of email addresses or domains that it applies to. If
|
|
1597
1666
|
* the email addresses or domains match at least one recipient address of the message,
|
|
1598
1667
|
* Amazon SES executes all of the receipt rule's actions on the message.</p>
|
|
1599
|
-
*
|
|
1600
|
-
* Guide</a>.</p>
|
|
1668
|
+
* <p>For information about setting up receipt rules, see the <a href="https://docs.aws.amazon.com/ses/latest/dg/receiving-email-receipt-rules-console-walkthrough.html">Amazon SES
|
|
1669
|
+
* Developer Guide</a>.</p>
|
|
1601
1670
|
*/
|
|
1602
1671
|
export interface ReceiptRule {
|
|
1603
1672
|
/**
|
|
1604
1673
|
* @public
|
|
1605
|
-
* <p>The name of the receipt rule. The name must:</p>
|
|
1606
|
-
*
|
|
1674
|
+
* <p>The name of the receipt rule. The name must meet the following requirements:</p>
|
|
1675
|
+
* <ul>
|
|
1607
1676
|
* <li>
|
|
1608
|
-
*
|
|
1609
|
-
*
|
|
1677
|
+
* <p>Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), dashes
|
|
1678
|
+
* (-), or periods (.). </p>
|
|
1610
1679
|
* </li>
|
|
1611
1680
|
* <li>
|
|
1612
|
-
*
|
|
1681
|
+
* <p>Start and end with a letter or number.</p>
|
|
1613
1682
|
* </li>
|
|
1614
1683
|
* <li>
|
|
1615
|
-
*
|
|
1684
|
+
* <p>Contain 64 characters or fewer.</p>
|
|
1616
1685
|
* </li>
|
|
1617
1686
|
* </ul>
|
|
1618
1687
|
*/
|
|
@@ -1627,15 +1696,14 @@ export interface ReceiptRule {
|
|
|
1627
1696
|
* @public
|
|
1628
1697
|
* <p>Specifies whether Amazon SES should require that incoming email is delivered over a
|
|
1629
1698
|
* connection encrypted with Transport Layer Security (TLS). If this parameter is set to
|
|
1630
|
-
* <code>Require</code>, Amazon SES
|
|
1699
|
+
* <code>Require</code>, Amazon SES bounces emails that are not received over TLS. The
|
|
1631
1700
|
* default is <code>Optional</code>.</p>
|
|
1632
1701
|
*/
|
|
1633
1702
|
TlsPolicy?: TlsPolicy | string;
|
|
1634
1703
|
/**
|
|
1635
1704
|
* @public
|
|
1636
1705
|
* <p>The recipient domains and email addresses that the receipt rule applies to. If this
|
|
1637
|
-
* field is not specified, this rule
|
|
1638
|
-
* domains.</p>
|
|
1706
|
+
* field is not specified, this rule matches all recipients on all verified domains.</p>
|
|
1639
1707
|
*/
|
|
1640
1708
|
Recipients?: string[];
|
|
1641
1709
|
/**
|
|
@@ -1654,20 +1722,19 @@ export interface ReceiptRule {
|
|
|
1654
1722
|
/**
|
|
1655
1723
|
* @public
|
|
1656
1724
|
* <p>Represents a request to create a receipt rule. You use receipt rules to receive email
|
|
1657
|
-
* with Amazon SES. For more information, see the <a href="https://docs.aws.amazon.com/ses/latest/
|
|
1658
|
-
*
|
|
1725
|
+
* with Amazon SES. For more information, see the <a href="https://docs.aws.amazon.com/ses/latest/dg/receiving-email-concepts.html">Amazon SES Developer
|
|
1726
|
+
* Guide</a>.</p>
|
|
1659
1727
|
*/
|
|
1660
1728
|
export interface CreateReceiptRuleRequest {
|
|
1661
1729
|
/**
|
|
1662
1730
|
* @public
|
|
1663
|
-
* <p>The name of the rule set
|
|
1731
|
+
* <p>The name of the rule set where the receipt rule is added.</p>
|
|
1664
1732
|
*/
|
|
1665
1733
|
RuleSetName: string | undefined;
|
|
1666
1734
|
/**
|
|
1667
1735
|
* @public
|
|
1668
|
-
* <p>The name of an existing rule after which the new rule
|
|
1669
|
-
*
|
|
1670
|
-
* list.</p>
|
|
1736
|
+
* <p>The name of an existing rule after which the new rule is placed. If this parameter is
|
|
1737
|
+
* null, the new rule is inserted at the beginning of the rule list.</p>
|
|
1671
1738
|
*/
|
|
1672
1739
|
After?: string;
|
|
1673
1740
|
/**
|
|
@@ -1685,7 +1752,7 @@ export interface CreateReceiptRuleResponse {
|
|
|
1685
1752
|
}
|
|
1686
1753
|
/**
|
|
1687
1754
|
* @public
|
|
1688
|
-
* <p>Indicates that the provided
|
|
1755
|
+
* <p>Indicates that the provided Amazon Web Services Lambda function is invalid, or that Amazon SES could
|
|
1689
1756
|
* not execute the provided function, possibly due to permissions issues. For information
|
|
1690
1757
|
* about giving permissions, see the <a href="https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-permissions.html">Amazon SES
|
|
1691
1758
|
* Developer Guide</a>.</p>
|
|
@@ -1705,9 +1772,9 @@ export declare class InvalidLambdaFunctionException extends __BaseException {
|
|
|
1705
1772
|
}
|
|
1706
1773
|
/**
|
|
1707
1774
|
* @public
|
|
1708
|
-
* <p>Indicates that the provided Amazon S3 bucket or
|
|
1709
|
-
* that Amazon SES could not publish to the bucket, possibly due to permissions issues.
|
|
1710
|
-
* information about giving permissions, see the <a href="https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-permissions.html">Amazon SES
|
|
1775
|
+
* <p>Indicates that the provided Amazon S3 bucket or Amazon Web Services KMS encryption key is invalid,
|
|
1776
|
+
* or that Amazon SES could not publish to the bucket, possibly due to permissions issues.
|
|
1777
|
+
* For information about giving permissions, see the <a href="https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-permissions.html">Amazon SES
|
|
1711
1778
|
* Developer Guide</a>.</p>
|
|
1712
1779
|
*/
|
|
1713
1780
|
export declare class InvalidS3ConfigurationException extends __BaseException {
|
|
@@ -1763,23 +1830,24 @@ export declare class RuleDoesNotExistException extends __BaseException {
|
|
|
1763
1830
|
/**
|
|
1764
1831
|
* @public
|
|
1765
1832
|
* <p>Represents a request to create an empty receipt rule set. You use receipt rule sets to
|
|
1766
|
-
* receive email with Amazon SES. For more information, see the <a href="https://docs.aws.amazon.com/ses/latest/
|
|
1767
|
-
*
|
|
1833
|
+
* receive email with Amazon SES. For more information, see the <a href="https://docs.aws.amazon.com/ses/latest/dg/receiving-email-concepts.html">Amazon SES Developer
|
|
1834
|
+
* Guide</a>.</p>
|
|
1768
1835
|
*/
|
|
1769
1836
|
export interface CreateReceiptRuleSetRequest {
|
|
1770
1837
|
/**
|
|
1771
1838
|
* @public
|
|
1772
|
-
* <p>The name of the rule set to create. The name must
|
|
1773
|
-
*
|
|
1839
|
+
* <p>The name of the rule set to create. The name must meet the following
|
|
1840
|
+
* requirements:</p>
|
|
1841
|
+
* <ul>
|
|
1774
1842
|
* <li>
|
|
1775
|
-
*
|
|
1776
|
-
*
|
|
1843
|
+
* <p>Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or
|
|
1844
|
+
* dashes (-).</p>
|
|
1777
1845
|
* </li>
|
|
1778
1846
|
* <li>
|
|
1779
|
-
*
|
|
1847
|
+
* <p>Start and end with a letter or number.</p>
|
|
1780
1848
|
* </li>
|
|
1781
1849
|
* <li>
|
|
1782
|
-
*
|
|
1850
|
+
* <p>Contain 64 characters or fewer.</p>
|
|
1783
1851
|
* </li>
|
|
1784
1852
|
* </ul>
|
|
1785
1853
|
*/
|
|
@@ -1793,13 +1861,13 @@ export interface CreateReceiptRuleSetResponse {
|
|
|
1793
1861
|
}
|
|
1794
1862
|
/**
|
|
1795
1863
|
* @public
|
|
1796
|
-
* <p>The content of the email, composed of a subject line
|
|
1797
|
-
* part.</p>
|
|
1864
|
+
* <p>The content of the email, composed of a subject line and either an HTML part or a
|
|
1865
|
+
* text-only part.</p>
|
|
1798
1866
|
*/
|
|
1799
1867
|
export interface Template {
|
|
1800
1868
|
/**
|
|
1801
1869
|
* @public
|
|
1802
|
-
* <p>The name of the template. You
|
|
1870
|
+
* <p>The name of the template. You use this name when you send email using the
|
|
1803
1871
|
* <code>SendTemplatedEmail</code> or <code>SendBulkTemplatedEmail</code>
|
|
1804
1872
|
* operations.</p>
|
|
1805
1873
|
*/
|
|
@@ -1811,8 +1879,8 @@ export interface Template {
|
|
|
1811
1879
|
SubjectPart?: string;
|
|
1812
1880
|
/**
|
|
1813
1881
|
* @public
|
|
1814
|
-
* <p>The email body that
|
|
1815
|
-
*
|
|
1882
|
+
* <p>The email body that is visible to recipients whose email clients do not display HTML
|
|
1883
|
+
* content.</p>
|
|
1816
1884
|
*/
|
|
1817
1885
|
TextPart?: string;
|
|
1818
1886
|
/**
|
|
@@ -1823,14 +1891,14 @@ export interface Template {
|
|
|
1823
1891
|
}
|
|
1824
1892
|
/**
|
|
1825
1893
|
* @public
|
|
1826
|
-
* <p>Represents a request to create an email template. For more information, see the <a href="https://docs.aws.amazon.com/ses/latest/
|
|
1827
|
-
* Guide</a>.</p>
|
|
1894
|
+
* <p>Represents a request to create an email template. For more information, see the <a href="https://docs.aws.amazon.com/ses/latest/dg/send-personalized-email-api.html">Amazon SES
|
|
1895
|
+
* Developer Guide</a>.</p>
|
|
1828
1896
|
*/
|
|
1829
1897
|
export interface CreateTemplateRequest {
|
|
1830
1898
|
/**
|
|
1831
1899
|
* @public
|
|
1832
|
-
* <p>The content of the email, composed of a subject line
|
|
1833
|
-
* part.</p>
|
|
1900
|
+
* <p>The content of the email, composed of a subject line and either an HTML part or a
|
|
1901
|
+
* text-only part.</p>
|
|
1834
1902
|
*/
|
|
1835
1903
|
Template: Template | undefined;
|
|
1836
1904
|
}
|
|
@@ -1922,8 +1990,8 @@ export declare class CustomVerificationEmailTemplateDoesNotExistException extend
|
|
|
1922
1990
|
* @public
|
|
1923
1991
|
* <p>Represents a request to delete a configuration set. Configuration sets enable you to
|
|
1924
1992
|
* publish email sending events. For information about using configuration sets, see the
|
|
1925
|
-
* <a href="https://docs.aws.amazon.com/ses/latest/
|
|
1926
|
-
* Guide</a>.</p>
|
|
1993
|
+
* <a href="https://docs.aws.amazon.com/ses/latest/dg/monitor-sending-activity.html">Amazon SES
|
|
1994
|
+
* Developer Guide</a>.</p>
|
|
1927
1995
|
*/
|
|
1928
1996
|
export interface DeleteConfigurationSetRequest {
|
|
1929
1997
|
/**
|
|
@@ -1943,8 +2011,8 @@ export interface DeleteConfigurationSetResponse {
|
|
|
1943
2011
|
* <p>Represents a request to delete a configuration set event destination. Configuration
|
|
1944
2012
|
* set event destinations are associated with configuration sets, which enable you to
|
|
1945
2013
|
* publish email sending events. For information about using configuration sets, see the
|
|
1946
|
-
* <a href="https://docs.aws.amazon.com/ses/latest/
|
|
1947
|
-
* Guide</a>.</p>
|
|
2014
|
+
* <a href="https://docs.aws.amazon.com/ses/latest/dg/monitor-sending-activity.html">Amazon SES
|
|
2015
|
+
* Developer Guide</a>.</p>
|
|
1948
2016
|
*/
|
|
1949
2017
|
export interface DeleteConfigurationSetEventDestinationRequest {
|
|
1950
2018
|
/**
|
|
@@ -1994,8 +2062,7 @@ export declare class EventDestinationDoesNotExistException extends __BaseExcepti
|
|
|
1994
2062
|
export interface DeleteConfigurationSetTrackingOptionsRequest {
|
|
1995
2063
|
/**
|
|
1996
2064
|
* @public
|
|
1997
|
-
* <p>The name of the configuration set
|
|
1998
|
-
* options.</p>
|
|
2065
|
+
* <p>The name of the configuration set.</p>
|
|
1999
2066
|
*/
|
|
2000
2067
|
ConfigurationSetName: string | undefined;
|
|
2001
2068
|
}
|
|
@@ -2030,7 +2097,7 @@ export declare class TrackingOptionsDoesNotExistException extends __BaseExceptio
|
|
|
2030
2097
|
export interface DeleteCustomVerificationEmailTemplateRequest {
|
|
2031
2098
|
/**
|
|
2032
2099
|
* @public
|
|
2033
|
-
* <p>The name of the custom verification email template
|
|
2100
|
+
* <p>The name of the custom verification email template to delete.</p>
|
|
2034
2101
|
*/
|
|
2035
2102
|
TemplateName: string | undefined;
|
|
2036
2103
|
}
|
|
@@ -2042,7 +2109,7 @@ export interface DeleteCustomVerificationEmailTemplateRequest {
|
|
|
2042
2109
|
export interface DeleteIdentityRequest {
|
|
2043
2110
|
/**
|
|
2044
2111
|
* @public
|
|
2045
|
-
* <p>The identity to be removed from the list of identities for the
|
|
2112
|
+
* <p>The identity to be removed from the list of identities for the Amazon Web Services account.</p>
|
|
2046
2113
|
*/
|
|
2047
2114
|
Identity: string | undefined;
|
|
2048
2115
|
}
|
|
@@ -2056,17 +2123,16 @@ export interface DeleteIdentityResponse {
|
|
|
2056
2123
|
* @public
|
|
2057
2124
|
* <p>Represents a request to delete a sending authorization policy for an identity. Sending
|
|
2058
2125
|
* authorization is an Amazon SES feature that enables you to authorize other senders to use
|
|
2059
|
-
* your identities. For information, see the <a href="https://docs.aws.amazon.com/ses/latest/
|
|
2060
|
-
* Guide</a>.</p>
|
|
2126
|
+
* your identities. For information, see the <a href="https://docs.aws.amazon.com/ses/latest/dg/sending-authorization.html">Amazon SES Developer Guide</a>.</p>
|
|
2061
2127
|
*/
|
|
2062
2128
|
export interface DeleteIdentityPolicyRequest {
|
|
2063
2129
|
/**
|
|
2064
2130
|
* @public
|
|
2065
|
-
* <p>The identity that is associated with the policy
|
|
2066
|
-
*
|
|
2067
|
-
*
|
|
2131
|
+
* <p>The identity that is associated with the policy to delete. You can specify the
|
|
2132
|
+
* identity by using its name or by using its Amazon Resource Name (ARN). Examples:
|
|
2133
|
+
* <code>user@example.com</code>, <code>example.com</code>,
|
|
2068
2134
|
* <code>arn:aws:ses:us-east-1:123456789012:identity/example.com</code>.</p>
|
|
2069
|
-
*
|
|
2135
|
+
* <p>To successfully call this operation, you must own the identity.</p>
|
|
2070
2136
|
*/
|
|
2071
2137
|
Identity: string | undefined;
|
|
2072
2138
|
/**
|
|
@@ -2084,8 +2150,8 @@ export interface DeleteIdentityPolicyResponse {
|
|
|
2084
2150
|
/**
|
|
2085
2151
|
* @public
|
|
2086
2152
|
* <p>Represents a request to delete an IP address filter. You use IP address filters when
|
|
2087
|
-
* you receive email with Amazon SES. For more information, see the <a href="https://docs.aws.amazon.com/ses/latest/
|
|
2088
|
-
*
|
|
2153
|
+
* you receive email with Amazon SES. For more information, see the <a href="https://docs.aws.amazon.com/ses/latest/dg/receiving-email-concepts.html">Amazon SES Developer
|
|
2154
|
+
* Guide</a>.</p>
|
|
2089
2155
|
*/
|
|
2090
2156
|
export interface DeleteReceiptFilterRequest {
|
|
2091
2157
|
/**
|
|
@@ -2103,8 +2169,8 @@ export interface DeleteReceiptFilterResponse {
|
|
|
2103
2169
|
/**
|
|
2104
2170
|
* @public
|
|
2105
2171
|
* <p>Represents a request to delete a receipt rule. You use receipt rules to receive email
|
|
2106
|
-
* with Amazon SES. For more information, see the <a href="https://docs.aws.amazon.com/ses/latest/
|
|
2107
|
-
*
|
|
2172
|
+
* with Amazon SES. For more information, see the <a href="https://docs.aws.amazon.com/ses/latest/dg/receiving-email-concepts.html">Amazon SES Developer
|
|
2173
|
+
* Guide</a>.</p>
|
|
2108
2174
|
*/
|
|
2109
2175
|
export interface DeleteReceiptRuleRequest {
|
|
2110
2176
|
/**
|
|
@@ -2128,8 +2194,7 @@ export interface DeleteReceiptRuleResponse {
|
|
|
2128
2194
|
* @public
|
|
2129
2195
|
* <p>Represents a request to delete a receipt rule set and all of the receipt rules it
|
|
2130
2196
|
* contains. You use receipt rule sets to receive email with Amazon SES. For more information,
|
|
2131
|
-
* see the <a href="https://docs.aws.amazon.com/ses/latest/
|
|
2132
|
-
* Guide</a>.</p>
|
|
2197
|
+
* see the <a href="https://docs.aws.amazon.com/ses/latest/dg/receiving-email-concepts.html">Amazon SES Developer Guide</a>.</p>
|
|
2133
2198
|
*/
|
|
2134
2199
|
export interface DeleteReceiptRuleSetRequest {
|
|
2135
2200
|
/**
|
|
@@ -2146,8 +2211,8 @@ export interface DeleteReceiptRuleSetResponse {
|
|
|
2146
2211
|
}
|
|
2147
2212
|
/**
|
|
2148
2213
|
* @public
|
|
2149
|
-
* <p>Represents a request to delete an email template. For more information, see the <a href="https://docs.aws.amazon.com/ses/latest/
|
|
2150
|
-
* Guide</a>.</p>
|
|
2214
|
+
* <p>Represents a request to delete an email template. For more information, see the <a href="https://docs.aws.amazon.com/ses/latest/dg/send-personalized-email-api.html">Amazon SES
|
|
2215
|
+
* Developer Guide</a>.</p>
|
|
2151
2216
|
*/
|
|
2152
2217
|
export interface DeleteTemplateRequest {
|
|
2153
2218
|
/**
|
|
@@ -2164,7 +2229,7 @@ export interface DeleteTemplateResponse {
|
|
|
2164
2229
|
/**
|
|
2165
2230
|
* @public
|
|
2166
2231
|
* <p>Represents a request to delete an email address from the list of email addresses you
|
|
2167
|
-
* have attempted to verify under your
|
|
2232
|
+
* have attempted to verify under your Amazon Web Services account.</p>
|
|
2168
2233
|
*/
|
|
2169
2234
|
export interface DeleteVerifiedEmailAddressRequest {
|
|
2170
2235
|
/**
|
|
@@ -2192,33 +2257,33 @@ export interface DeliveryOptions {
|
|
|
2192
2257
|
* @public
|
|
2193
2258
|
* <p>Represents a request to return the metadata and receipt rules for the receipt rule set
|
|
2194
2259
|
* that is currently active. You use receipt rule sets to receive email with Amazon SES. For
|
|
2195
|
-
* more information, see the <a href="https://docs.aws.amazon.com/ses/latest/
|
|
2196
|
-
*
|
|
2260
|
+
* more information, see the <a href="https://docs.aws.amazon.com/ses/latest/dg/receiving-email-concepts.html">Amazon SES Developer
|
|
2261
|
+
* Guide</a>.</p>
|
|
2197
2262
|
*/
|
|
2198
2263
|
export interface DescribeActiveReceiptRuleSetRequest {
|
|
2199
2264
|
}
|
|
2200
2265
|
/**
|
|
2201
2266
|
* @public
|
|
2202
2267
|
* <p>Information about a receipt rule set.</p>
|
|
2203
|
-
*
|
|
2268
|
+
* <p>A receipt rule set is a collection of rules that specify what Amazon SES should do with
|
|
2204
2269
|
* mail it receives on behalf of your account's verified domains.</p>
|
|
2205
|
-
*
|
|
2206
|
-
* Developer Guide</a>.</p>
|
|
2270
|
+
* <p>For information about setting up receipt rule sets, see the <a href="https://docs.aws.amazon.com/ses/latest/dg/receiving-email-concepts.html#receiving-email-concepts-rules">Amazon SES Developer Guide</a>.</p>
|
|
2207
2271
|
*/
|
|
2208
2272
|
export interface ReceiptRuleSetMetadata {
|
|
2209
2273
|
/**
|
|
2210
2274
|
* @public
|
|
2211
|
-
* <p>The name of the receipt rule set. The name must
|
|
2212
|
-
*
|
|
2275
|
+
* <p>The name of the receipt rule set. The name must meet the following
|
|
2276
|
+
* requirements:</p>
|
|
2277
|
+
* <ul>
|
|
2213
2278
|
* <li>
|
|
2214
|
-
*
|
|
2215
|
-
*
|
|
2279
|
+
* <p>Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or
|
|
2280
|
+
* dashes (-).</p>
|
|
2216
2281
|
* </li>
|
|
2217
2282
|
* <li>
|
|
2218
|
-
*
|
|
2283
|
+
* <p>Start and end with a letter or number.</p>
|
|
2219
2284
|
* </li>
|
|
2220
2285
|
* <li>
|
|
2221
|
-
*
|
|
2286
|
+
* <p>Contain 64 characters or fewer.</p>
|
|
2222
2287
|
* </li>
|
|
2223
2288
|
* </ul>
|
|
2224
2289
|
*/
|
|
@@ -2251,8 +2316,8 @@ export interface DescribeActiveReceiptRuleSetResponse {
|
|
|
2251
2316
|
* @public
|
|
2252
2317
|
* <p>Represents a request to return the details of a configuration set. Configuration sets
|
|
2253
2318
|
* enable you to publish email sending events. For information about using configuration
|
|
2254
|
-
* sets, see the <a href="https://docs.aws.amazon.com/ses/latest/
|
|
2255
|
-
*
|
|
2319
|
+
* sets, see the <a href="https://docs.aws.amazon.com/ses/latest/dg/monitor-sending-activity.html">Amazon SES Developer
|
|
2320
|
+
* Guide</a>.</p>
|
|
2256
2321
|
*/
|
|
2257
2322
|
export interface DescribeConfigurationSetRequest {
|
|
2258
2323
|
/**
|
|
@@ -2274,8 +2339,8 @@ export interface ReputationOptions {
|
|
|
2274
2339
|
/**
|
|
2275
2340
|
* @public
|
|
2276
2341
|
* <p>Describes whether email sending is enabled or disabled for the configuration set. If
|
|
2277
|
-
* the value is <code>true</code>, then Amazon SES
|
|
2278
|
-
*
|
|
2342
|
+
* the value is <code>true</code>, then Amazon SES sends emails that use the configuration set.
|
|
2343
|
+
* If the value is <code>false</code>, Amazon SES does not send emails that use the
|
|
2279
2344
|
* configuration set. The default value is <code>true</code>. You can change this setting
|
|
2280
2345
|
* using <a>UpdateConfigurationSetSendingEnabled</a>.</p>
|
|
2281
2346
|
*/
|
|
@@ -2284,7 +2349,7 @@ export interface ReputationOptions {
|
|
|
2284
2349
|
* @public
|
|
2285
2350
|
* <p>Describes whether or not Amazon SES publishes reputation metrics for the configuration set,
|
|
2286
2351
|
* such as bounce and complaint rates, to Amazon CloudWatch.</p>
|
|
2287
|
-
*
|
|
2352
|
+
* <p>If the value is <code>true</code>, reputation metrics are published. If the value is
|
|
2288
2353
|
* <code>false</code>, reputation metrics are not published. The default value is
|
|
2289
2354
|
* <code>false</code>.</p>
|
|
2290
2355
|
*/
|
|
@@ -2293,10 +2358,10 @@ export interface ReputationOptions {
|
|
|
2293
2358
|
* @public
|
|
2294
2359
|
* <p>The date and time at which the reputation metrics for the configuration set were last
|
|
2295
2360
|
* reset. Resetting these metrics is known as a <i>fresh start</i>.</p>
|
|
2296
|
-
*
|
|
2361
|
+
* <p>When you disable email sending for a configuration set using <a>UpdateConfigurationSetSendingEnabled</a> and later re-enable it, the
|
|
2297
2362
|
* reputation metrics for the configuration set (but not for the entire Amazon SES account) are
|
|
2298
2363
|
* reset.</p>
|
|
2299
|
-
*
|
|
2364
|
+
* <p>If email sending for the configuration set has never been disabled and later
|
|
2300
2365
|
* re-enabled, the value of this attribute is <code>null</code>.</p>
|
|
2301
2366
|
*/
|
|
2302
2367
|
LastFreshStart?: Date;
|
|
@@ -2305,8 +2370,8 @@ export interface ReputationOptions {
|
|
|
2305
2370
|
* @public
|
|
2306
2371
|
* <p>Represents the details of a configuration set. Configuration sets enable you to
|
|
2307
2372
|
* publish email sending events. For information about using configuration sets, see the
|
|
2308
|
-
* <a href="https://docs.aws.amazon.com/ses/latest/
|
|
2309
|
-
* Guide</a>.</p>
|
|
2373
|
+
* <a href="https://docs.aws.amazon.com/ses/latest/dg/monitor-sending-activity.html">Amazon SES
|
|
2374
|
+
* Developer Guide</a>.</p>
|
|
2310
2375
|
*/
|
|
2311
2376
|
export interface DescribeConfigurationSetResponse {
|
|
2312
2377
|
/**
|
|
@@ -2340,8 +2405,8 @@ export interface DescribeConfigurationSetResponse {
|
|
|
2340
2405
|
/**
|
|
2341
2406
|
* @public
|
|
2342
2407
|
* <p>Represents a request to return the details of a receipt rule. You use receipt rules to
|
|
2343
|
-
* receive email with Amazon SES. For more information, see the <a href="https://docs.aws.amazon.com/ses/latest/
|
|
2344
|
-
*
|
|
2408
|
+
* receive email with Amazon SES. For more information, see the <a href="https://docs.aws.amazon.com/ses/latest/dg/receiving-email-concepts.html">Amazon SES Developer
|
|
2409
|
+
* Guide</a>.</p>
|
|
2345
2410
|
*/
|
|
2346
2411
|
export interface DescribeReceiptRuleRequest {
|
|
2347
2412
|
/**
|
|
@@ -2370,7 +2435,8 @@ export interface DescribeReceiptRuleResponse {
|
|
|
2370
2435
|
/**
|
|
2371
2436
|
* @public
|
|
2372
2437
|
* <p>Represents a request to return the details of a receipt rule set. You use receipt rule
|
|
2373
|
-
* sets to receive email with Amazon SES. For more information, see the <a href="https://docs.aws.amazon.com/ses/latest/
|
|
2438
|
+
* sets to receive email with Amazon SES. For more information, see the <a href="https://docs.aws.amazon.com/ses/latest/dg/receiving-email-concepts.html">Amazon SES
|
|
2439
|
+
* Developer Guide</a>.</p>
|
|
2374
2440
|
*/
|
|
2375
2441
|
export interface DescribeReceiptRuleSetRequest {
|
|
2376
2442
|
/**
|
|
@@ -2398,8 +2464,19 @@ export interface DescribeReceiptRuleSetResponse {
|
|
|
2398
2464
|
}
|
|
2399
2465
|
/**
|
|
2400
2466
|
* @public
|
|
2467
|
+
* @enum
|
|
2401
2468
|
*/
|
|
2402
|
-
export
|
|
2469
|
+
export declare const VerificationStatus: {
|
|
2470
|
+
readonly Failed: "Failed";
|
|
2471
|
+
readonly NotStarted: "NotStarted";
|
|
2472
|
+
readonly Pending: "Pending";
|
|
2473
|
+
readonly Success: "Success";
|
|
2474
|
+
readonly TemporaryFailure: "TemporaryFailure";
|
|
2475
|
+
};
|
|
2476
|
+
/**
|
|
2477
|
+
* @public
|
|
2478
|
+
*/
|
|
2479
|
+
export type VerificationStatus = (typeof VerificationStatus)[keyof typeof VerificationStatus];
|
|
2403
2480
|
/**
|
|
2404
2481
|
* @public
|
|
2405
2482
|
* <p>Represents the DKIM attributes of a verified email address or a domain.</p>
|
|
@@ -2426,21 +2503,20 @@ export interface IdentityDkimAttributes {
|
|
|
2426
2503
|
* process might take up to 72 hours. After successful detection, Amazon SES is able to
|
|
2427
2504
|
* DKIM-sign email originating from that domain. (This only applies to domain identities,
|
|
2428
2505
|
* not email address identities.)</p>
|
|
2429
|
-
*
|
|
2430
|
-
* Guide</a>.</p>
|
|
2506
|
+
* <p>For more information about creating DNS records using DKIM tokens, see the <a href="https://docs.aws.amazon.com/ses/latest/dg/send-email-authentication-dkim-easy.html">Amazon SES Developer Guide</a>.</p>
|
|
2431
2507
|
*/
|
|
2432
2508
|
DkimTokens?: string[];
|
|
2433
2509
|
}
|
|
2434
2510
|
/**
|
|
2435
2511
|
* @public
|
|
2436
2512
|
* <p>Represents a request to return the email sending status for your Amazon SES account in the
|
|
2437
|
-
* current
|
|
2513
|
+
* current Amazon Web Services Region.</p>
|
|
2438
2514
|
*/
|
|
2439
2515
|
export interface GetAccountSendingEnabledResponse {
|
|
2440
2516
|
/**
|
|
2441
2517
|
* @public
|
|
2442
2518
|
* <p>Describes whether email sending is enabled or disabled for your Amazon SES account in the
|
|
2443
|
-
* current
|
|
2519
|
+
* current Amazon Web Services Region.</p>
|
|
2444
2520
|
*/
|
|
2445
2521
|
Enabled?: boolean;
|
|
2446
2522
|
}
|
|
@@ -2452,7 +2528,7 @@ export interface GetAccountSendingEnabledResponse {
|
|
|
2452
2528
|
export interface GetCustomVerificationEmailTemplateRequest {
|
|
2453
2529
|
/**
|
|
2454
2530
|
* @public
|
|
2455
|
-
* <p>The name of the custom verification email template
|
|
2531
|
+
* <p>The name of the custom verification email template to retrieve.</p>
|
|
2456
2532
|
*/
|
|
2457
2533
|
TemplateName: string | undefined;
|
|
2458
2534
|
}
|
|
@@ -2499,7 +2575,8 @@ export interface GetCustomVerificationEmailTemplateResponse {
|
|
|
2499
2575
|
* <p>Represents a request for the status of Amazon SES Easy DKIM signing for an identity. For
|
|
2500
2576
|
* domain identities, this request also returns the DKIM tokens that are required for Easy
|
|
2501
2577
|
* DKIM signing, and whether Amazon SES successfully verified that these tokens were published.
|
|
2502
|
-
* For more information about Easy DKIM, see the <a href="https://docs.aws.amazon.com/ses/latest/
|
|
2578
|
+
* For more information about Easy DKIM, see the <a href="https://docs.aws.amazon.com/ses/latest/dg/send-email-authentication-dkim-easy.html">Amazon SES Developer
|
|
2579
|
+
* Guide</a>.</p>
|
|
2503
2580
|
*/
|
|
2504
2581
|
export interface GetIdentityDkimAttributesRequest {
|
|
2505
2582
|
/**
|
|
@@ -2525,7 +2602,7 @@ export interface GetIdentityDkimAttributesResponse {
|
|
|
2525
2602
|
/**
|
|
2526
2603
|
* @public
|
|
2527
2604
|
* <p>Represents a request to return the Amazon SES custom MAIL FROM attributes for a list of
|
|
2528
|
-
* identities. For information about using a custom MAIL FROM domain, see the <a href="https://docs.aws.amazon.com/ses/latest/
|
|
2605
|
+
* identities. For information about using a custom MAIL FROM domain, see the <a href="https://docs.aws.amazon.com/ses/latest/dg/mail-from.html">Amazon SES Developer
|
|
2529
2606
|
* Guide</a>.</p>
|
|
2530
2607
|
*/
|
|
2531
2608
|
export interface GetIdentityMailFromDomainAttributesRequest {
|
|
@@ -2563,7 +2640,7 @@ export interface IdentityMailFromDomainAttributes {
|
|
|
2563
2640
|
* the MAIL FROM domain. A value of <code>RejectMessage</code> indicates that if Amazon SES
|
|
2564
2641
|
* cannot read the required MX record, Amazon SES returns a
|
|
2565
2642
|
* <code>MailFromDomainNotVerified</code> error and does not send the email.</p>
|
|
2566
|
-
*
|
|
2643
|
+
* <p>The custom MAIL FROM setup states that result in this behavior are
|
|
2567
2644
|
* <code>Pending</code>, <code>Failed</code>, and <code>TemporaryFailure</code>.</p>
|
|
2568
2645
|
*/
|
|
2569
2646
|
BehaviorOnMXFailure: BehaviorOnMXFailure | string | undefined;
|
|
@@ -2582,7 +2659,7 @@ export interface GetIdentityMailFromDomainAttributesResponse {
|
|
|
2582
2659
|
/**
|
|
2583
2660
|
* @public
|
|
2584
2661
|
* <p>Represents a request to return the notification attributes for a list of identities
|
|
2585
|
-
* you verified with Amazon SES. For information about Amazon SES notifications, see the <a href="https://docs.aws.amazon.com/ses/latest/
|
|
2662
|
+
* you verified with Amazon SES. For information about Amazon SES notifications, see the <a href="https://docs.aws.amazon.com/ses/latest/dg/monitor-sending-activity-using-notifications.html">Amazon SES
|
|
2586
2663
|
* Developer Guide</a>.</p>
|
|
2587
2664
|
*/
|
|
2588
2665
|
export interface GetIdentityNotificationAttributesRequest {
|
|
@@ -2605,53 +2682,52 @@ export interface GetIdentityNotificationAttributesRequest {
|
|
|
2605
2682
|
export interface IdentityNotificationAttributes {
|
|
2606
2683
|
/**
|
|
2607
2684
|
* @public
|
|
2608
|
-
* <p>The Amazon Resource Name (ARN) of the Amazon SNS topic where Amazon SES
|
|
2685
|
+
* <p>The Amazon Resource Name (ARN) of the Amazon SNS topic where Amazon SES publishes bounce
|
|
2609
2686
|
* notifications.</p>
|
|
2610
2687
|
*/
|
|
2611
2688
|
BounceTopic: string | undefined;
|
|
2612
2689
|
/**
|
|
2613
2690
|
* @public
|
|
2614
|
-
* <p>The Amazon Resource Name (ARN) of the Amazon SNS topic where Amazon SES
|
|
2691
|
+
* <p>The Amazon Resource Name (ARN) of the Amazon SNS topic where Amazon SES publishes complaint
|
|
2615
2692
|
* notifications.</p>
|
|
2616
2693
|
*/
|
|
2617
2694
|
ComplaintTopic: string | undefined;
|
|
2618
2695
|
/**
|
|
2619
2696
|
* @public
|
|
2620
|
-
* <p>The Amazon Resource Name (ARN) of the Amazon SNS topic where Amazon SES
|
|
2697
|
+
* <p>The Amazon Resource Name (ARN) of the Amazon SNS topic where Amazon SES publishes delivery
|
|
2621
2698
|
* notifications.</p>
|
|
2622
2699
|
*/
|
|
2623
2700
|
DeliveryTopic: string | undefined;
|
|
2624
2701
|
/**
|
|
2625
2702
|
* @public
|
|
2626
|
-
* <p>Describes whether Amazon SES
|
|
2627
|
-
* <code>true</code> indicates that Amazon SES
|
|
2628
|
-
*
|
|
2629
|
-
*
|
|
2630
|
-
* topics.</p>
|
|
2703
|
+
* <p>Describes whether Amazon SES forwards bounce and complaint notifications as email.
|
|
2704
|
+
* <code>true</code> indicates that Amazon SES forwards bounce and complaint notifications
|
|
2705
|
+
* as email, while <code>false</code> indicates that bounce and complaint notifications are
|
|
2706
|
+
* published only to the specified bounce and complaint Amazon SNS topics.</p>
|
|
2631
2707
|
*/
|
|
2632
2708
|
ForwardingEnabled: boolean | undefined;
|
|
2633
2709
|
/**
|
|
2634
2710
|
* @public
|
|
2635
2711
|
* <p>Describes whether Amazon SES includes the original email headers in Amazon SNS notifications of
|
|
2636
|
-
* type <code>Bounce</code>. A value of <code>true</code> specifies that Amazon SES
|
|
2712
|
+
* type <code>Bounce</code>. A value of <code>true</code> specifies that Amazon SES includes
|
|
2637
2713
|
* headers in bounce notifications, and a value of <code>false</code> specifies that Amazon SES
|
|
2638
|
-
*
|
|
2714
|
+
* does not include headers in bounce notifications.</p>
|
|
2639
2715
|
*/
|
|
2640
2716
|
HeadersInBounceNotificationsEnabled?: boolean;
|
|
2641
2717
|
/**
|
|
2642
2718
|
* @public
|
|
2643
2719
|
* <p>Describes whether Amazon SES includes the original email headers in Amazon SNS notifications of
|
|
2644
|
-
* type <code>Complaint</code>. A value of <code>true</code> specifies that Amazon SES
|
|
2645
|
-
*
|
|
2646
|
-
*
|
|
2720
|
+
* type <code>Complaint</code>. A value of <code>true</code> specifies that Amazon SES includes
|
|
2721
|
+
* headers in complaint notifications, and a value of <code>false</code> specifies that
|
|
2722
|
+
* Amazon SES does not include headers in complaint notifications.</p>
|
|
2647
2723
|
*/
|
|
2648
2724
|
HeadersInComplaintNotificationsEnabled?: boolean;
|
|
2649
2725
|
/**
|
|
2650
2726
|
* @public
|
|
2651
2727
|
* <p>Describes whether Amazon SES includes the original email headers in Amazon SNS notifications of
|
|
2652
|
-
* type <code>Delivery</code>. A value of <code>true</code> specifies that Amazon SES
|
|
2653
|
-
*
|
|
2654
|
-
*
|
|
2728
|
+
* type <code>Delivery</code>. A value of <code>true</code> specifies that Amazon SES includes
|
|
2729
|
+
* headers in delivery notifications, and a value of <code>false</code> specifies that
|
|
2730
|
+
* Amazon SES does not include headers in delivery notifications.</p>
|
|
2655
2731
|
*/
|
|
2656
2732
|
HeadersInDeliveryNotificationsEnabled?: boolean;
|
|
2657
2733
|
}
|
|
@@ -2670,17 +2746,16 @@ export interface GetIdentityNotificationAttributesResponse {
|
|
|
2670
2746
|
* @public
|
|
2671
2747
|
* <p>Represents a request to return the requested sending authorization policies for an
|
|
2672
2748
|
* identity. Sending authorization is an Amazon SES feature that enables you to authorize other
|
|
2673
|
-
* senders to use your identities. For information, see the <a href="https://docs.aws.amazon.com/ses/latest/
|
|
2674
|
-
* Guide</a>.</p>
|
|
2749
|
+
* senders to use your identities. For information, see the <a href="https://docs.aws.amazon.com/ses/latest/dg/sending-authorization.html">Amazon SES Developer Guide</a>.</p>
|
|
2675
2750
|
*/
|
|
2676
2751
|
export interface GetIdentityPoliciesRequest {
|
|
2677
2752
|
/**
|
|
2678
2753
|
* @public
|
|
2679
|
-
* <p>The identity for which the policies
|
|
2754
|
+
* <p>The identity for which the policies are retrieved. You can specify an identity by
|
|
2680
2755
|
* using its name or by using its Amazon Resource Name (ARN). Examples:
|
|
2681
2756
|
* <code>user@example.com</code>, <code>example.com</code>,
|
|
2682
2757
|
* <code>arn:aws:ses:us-east-1:123456789012:identity/example.com</code>.</p>
|
|
2683
|
-
*
|
|
2758
|
+
* <p>To successfully call this operation, you must own the identity.</p>
|
|
2684
2759
|
*/
|
|
2685
2760
|
Identity: string | undefined;
|
|
2686
2761
|
/**
|
|
@@ -2706,8 +2781,7 @@ export interface GetIdentityPoliciesResponse {
|
|
|
2706
2781
|
* @public
|
|
2707
2782
|
* <p>Represents a request to return the Amazon SES verification status of a list of identities.
|
|
2708
2783
|
* For domain identities, this request also returns the verification token. For information
|
|
2709
|
-
* about verifying identities with Amazon SES, see the <a href="https://docs.aws.amazon.com/ses/latest/
|
|
2710
|
-
* Guide</a>.</p>
|
|
2784
|
+
* about verifying identities with Amazon SES, see the <a href="https://docs.aws.amazon.com/ses/latest/dg/creating-identities.html">Amazon SES Developer Guide</a>.</p>
|
|
2711
2785
|
*/
|
|
2712
2786
|
export interface GetIdentityVerificationAttributesRequest {
|
|
2713
2787
|
/**
|
|
@@ -2762,10 +2836,10 @@ export interface GetSendQuotaResponse {
|
|
|
2762
2836
|
* @public
|
|
2763
2837
|
* <p>The maximum number of emails that Amazon SES can accept from the user's account per
|
|
2764
2838
|
* second.</p>
|
|
2765
|
-
*
|
|
2839
|
+
* <note>
|
|
2766
2840
|
* <p>The rate at which Amazon SES accepts the user's messages might be less than the maximum
|
|
2767
2841
|
* send rate.</p>
|
|
2768
|
-
*
|
|
2842
|
+
* </note>
|
|
2769
2843
|
*/
|
|
2770
2844
|
MaxSendRate?: number;
|
|
2771
2845
|
/**
|
|
@@ -2824,7 +2898,7 @@ export interface GetSendStatisticsResponse {
|
|
|
2824
2898
|
export interface GetTemplateRequest {
|
|
2825
2899
|
/**
|
|
2826
2900
|
* @public
|
|
2827
|
-
* <p>The name of the template
|
|
2901
|
+
* <p>The name of the template to retrieve.</p>
|
|
2828
2902
|
*/
|
|
2829
2903
|
TemplateName: string | undefined;
|
|
2830
2904
|
}
|
|
@@ -2834,8 +2908,8 @@ export interface GetTemplateRequest {
|
|
|
2834
2908
|
export interface GetTemplateResponse {
|
|
2835
2909
|
/**
|
|
2836
2910
|
* @public
|
|
2837
|
-
* <p>The content of the email, composed of a subject line
|
|
2838
|
-
* part.</p>
|
|
2911
|
+
* <p>The content of the email, composed of a subject line and either an HTML part or a
|
|
2912
|
+
* text-only part.</p>
|
|
2839
2913
|
*/
|
|
2840
2914
|
Template?: Template;
|
|
2841
2915
|
}
|
|
@@ -2853,10 +2927,18 @@ export declare class TemplateDoesNotExistException extends __BaseException {
|
|
|
2853
2927
|
*/
|
|
2854
2928
|
constructor(opts: __ExceptionOptionType<TemplateDoesNotExistException, __BaseException>);
|
|
2855
2929
|
}
|
|
2930
|
+
/**
|
|
2931
|
+
* @public
|
|
2932
|
+
* @enum
|
|
2933
|
+
*/
|
|
2934
|
+
export declare const IdentityType: {
|
|
2935
|
+
readonly Domain: "Domain";
|
|
2936
|
+
readonly EmailAddress: "EmailAddress";
|
|
2937
|
+
};
|
|
2856
2938
|
/**
|
|
2857
2939
|
* @public
|
|
2858
2940
|
*/
|
|
2859
|
-
export type IdentityType =
|
|
2941
|
+
export type IdentityType = (typeof IdentityType)[keyof typeof IdentityType];
|
|
2860
2942
|
/**
|
|
2861
2943
|
* @public
|
|
2862
2944
|
* <p>Indicates that provided delivery option is invalid.</p>
|
|
@@ -2898,10 +2980,10 @@ export declare class InvalidRenderingParameterException extends __BaseException
|
|
|
2898
2980
|
}
|
|
2899
2981
|
/**
|
|
2900
2982
|
* @public
|
|
2901
|
-
* <p>Represents a request to list the configuration sets associated with your
|
|
2902
|
-
* Configuration sets enable you to publish email sending events. For
|
|
2903
|
-
* using configuration sets, see the <a href="https://docs.aws.amazon.com/ses/latest/
|
|
2904
|
-
*
|
|
2983
|
+
* <p>Represents a request to list the configuration sets associated with your
|
|
2984
|
+
* Amazon Web Services account. Configuration sets enable you to publish email sending events. For
|
|
2985
|
+
* information about using configuration sets, see the <a href="https://docs.aws.amazon.com/ses/latest/dg/monitor-sending-activity.html">Amazon SES Developer
|
|
2986
|
+
* Guide</a>.</p>
|
|
2905
2987
|
*/
|
|
2906
2988
|
export interface ListConfigurationSetsRequest {
|
|
2907
2989
|
/**
|
|
@@ -2918,10 +3000,10 @@ export interface ListConfigurationSetsRequest {
|
|
|
2918
3000
|
}
|
|
2919
3001
|
/**
|
|
2920
3002
|
* @public
|
|
2921
|
-
* <p>A list of configuration sets associated with your
|
|
3003
|
+
* <p>A list of configuration sets associated with your Amazon Web Services account. Configuration sets
|
|
2922
3004
|
* enable you to publish email sending events. For information about using configuration
|
|
2923
|
-
* sets, see the <a href="https://docs.aws.amazon.com/ses/latest/
|
|
2924
|
-
*
|
|
3005
|
+
* sets, see the <a href="https://docs.aws.amazon.com/ses/latest/dg/monitor-sending-activity.html">Amazon SES Developer
|
|
3006
|
+
* Guide</a>.</p>
|
|
2925
3007
|
*/
|
|
2926
3008
|
export interface ListConfigurationSetsResponse {
|
|
2927
3009
|
/**
|
|
@@ -2941,8 +3023,8 @@ export interface ListConfigurationSetsResponse {
|
|
|
2941
3023
|
* @public
|
|
2942
3024
|
* <p>Represents a request to list the existing custom verification email templates for your
|
|
2943
3025
|
* account.</p>
|
|
2944
|
-
*
|
|
2945
|
-
* Verification Email Templates</a> in the <i>Amazon SES Developer
|
|
3026
|
+
* <p>For more information about custom verification email templates, see <a href="https://docs.aws.amazon.com/ses/latest/dg/creating-identities.html#send-email-verify-address-custom">Using
|
|
3027
|
+
* Custom Verification Email Templates</a> in the <i>Amazon SES Developer
|
|
2946
3028
|
* Guide</i>.</p>
|
|
2947
3029
|
*/
|
|
2948
3030
|
export interface ListCustomVerificationEmailTemplatesRequest {
|
|
@@ -2956,7 +3038,7 @@ export interface ListCustomVerificationEmailTemplatesRequest {
|
|
|
2956
3038
|
* @public
|
|
2957
3039
|
* <p>The maximum number of custom verification email templates to return. This value must
|
|
2958
3040
|
* be at least 1 and less than or equal to 50. If you do not specify a value, or if you
|
|
2959
|
-
* specify a value less than 1 or greater than 50, the operation
|
|
3041
|
+
* specify a value less than 1 or greater than 50, the operation returns up to 50
|
|
2960
3042
|
* results.</p>
|
|
2961
3043
|
*/
|
|
2962
3044
|
MaxResults?: number;
|
|
@@ -2983,14 +3065,14 @@ export interface ListCustomVerificationEmailTemplatesResponse {
|
|
|
2983
3065
|
/**
|
|
2984
3066
|
* @public
|
|
2985
3067
|
* <p>Represents a request to return a list of all identities (email addresses and domains)
|
|
2986
|
-
* that you have attempted to verify under your
|
|
3068
|
+
* that you have attempted to verify under your Amazon Web Services account, regardless of verification
|
|
2987
3069
|
* status.</p>
|
|
2988
3070
|
*/
|
|
2989
3071
|
export interface ListIdentitiesRequest {
|
|
2990
3072
|
/**
|
|
2991
3073
|
* @public
|
|
2992
3074
|
* <p>The type of the identities to list. Possible values are "EmailAddress" and "Domain".
|
|
2993
|
-
* If this parameter is omitted, then all identities
|
|
3075
|
+
* If this parameter is omitted, then all identities are listed.</p>
|
|
2994
3076
|
*/
|
|
2995
3077
|
IdentityType?: IdentityType | string;
|
|
2996
3078
|
/**
|
|
@@ -3007,7 +3089,7 @@ export interface ListIdentitiesRequest {
|
|
|
3007
3089
|
}
|
|
3008
3090
|
/**
|
|
3009
3091
|
* @public
|
|
3010
|
-
* <p>A list of all identities that you have attempted to verify under your
|
|
3092
|
+
* <p>A list of all identities that you have attempted to verify under your Amazon Web Services account,
|
|
3011
3093
|
* regardless of verification status.</p>
|
|
3012
3094
|
*/
|
|
3013
3095
|
export interface ListIdentitiesResponse {
|
|
@@ -3026,16 +3108,17 @@ export interface ListIdentitiesResponse {
|
|
|
3026
3108
|
* @public
|
|
3027
3109
|
* <p>Represents a request to return a list of sending authorization policies that are
|
|
3028
3110
|
* attached to an identity. Sending authorization is an Amazon SES feature that enables you to
|
|
3029
|
-
* authorize other senders to use your identities. For information, see the <a href="https://docs.aws.amazon.com/ses/latest/
|
|
3111
|
+
* authorize other senders to use your identities. For information, see the <a href="https://docs.aws.amazon.com/ses/latest/dg/sending-authorization.html">Amazon SES Developer
|
|
3112
|
+
* Guide</a>.</p>
|
|
3030
3113
|
*/
|
|
3031
3114
|
export interface ListIdentityPoliciesRequest {
|
|
3032
3115
|
/**
|
|
3033
3116
|
* @public
|
|
3034
|
-
* <p>The identity that is associated with the policy for which the policies
|
|
3035
|
-
*
|
|
3036
|
-
*
|
|
3117
|
+
* <p>The identity that is associated with the policy for which the policies are listed. You
|
|
3118
|
+
* can specify an identity by using its name or by using its Amazon Resource Name (ARN).
|
|
3119
|
+
* Examples: <code>user@example.com</code>, <code>example.com</code>,
|
|
3037
3120
|
* <code>arn:aws:ses:us-east-1:123456789012:identity/example.com</code>.</p>
|
|
3038
|
-
*
|
|
3121
|
+
* <p>To successfully call this operation, you must own the identity.</p>
|
|
3039
3122
|
*/
|
|
3040
3123
|
Identity: string | undefined;
|
|
3041
3124
|
}
|
|
@@ -3052,16 +3135,16 @@ export interface ListIdentityPoliciesResponse {
|
|
|
3052
3135
|
}
|
|
3053
3136
|
/**
|
|
3054
3137
|
* @public
|
|
3055
|
-
* <p>Represents a request to list the IP address filters that exist under your
|
|
3056
|
-
* You use IP address filters when you receive email with Amazon SES. For more
|
|
3057
|
-
* the <a href="https://docs.aws.amazon.com/ses/latest/
|
|
3058
|
-
*
|
|
3138
|
+
* <p>Represents a request to list the IP address filters that exist under your
|
|
3139
|
+
* Amazon Web Services account. You use IP address filters when you receive email with Amazon SES. For more
|
|
3140
|
+
* information, see the <a href="https://docs.aws.amazon.com/ses/latest/dg/receiving-email-concepts.html">Amazon SES Developer
|
|
3141
|
+
* Guide</a>.</p>
|
|
3059
3142
|
*/
|
|
3060
3143
|
export interface ListReceiptFiltersRequest {
|
|
3061
3144
|
}
|
|
3062
3145
|
/**
|
|
3063
3146
|
* @public
|
|
3064
|
-
* <p>A list of IP address filters that exist under your
|
|
3147
|
+
* <p>A list of IP address filters that exist under your Amazon Web Services account.</p>
|
|
3065
3148
|
*/
|
|
3066
3149
|
export interface ListReceiptFiltersResponse {
|
|
3067
3150
|
/**
|
|
@@ -3073,10 +3156,10 @@ export interface ListReceiptFiltersResponse {
|
|
|
3073
3156
|
}
|
|
3074
3157
|
/**
|
|
3075
3158
|
* @public
|
|
3076
|
-
* <p>Represents a request to list the receipt rule sets that exist under your
|
|
3077
|
-
* You use receipt rule sets to receive email with Amazon SES. For more
|
|
3078
|
-
*
|
|
3079
|
-
*
|
|
3159
|
+
* <p>Represents a request to list the receipt rule sets that exist under your
|
|
3160
|
+
* Amazon Web Services account. You use receipt rule sets to receive email with Amazon SES. For more
|
|
3161
|
+
* information, see the <a href="https://docs.aws.amazon.com/ses/latest/dg/receiving-email-concepts.html">Amazon SES Developer
|
|
3162
|
+
* Guide</a>.</p>
|
|
3080
3163
|
*/
|
|
3081
3164
|
export interface ListReceiptRuleSetsRequest {
|
|
3082
3165
|
/**
|
|
@@ -3088,7 +3171,7 @@ export interface ListReceiptRuleSetsRequest {
|
|
|
3088
3171
|
}
|
|
3089
3172
|
/**
|
|
3090
3173
|
* @public
|
|
3091
|
-
* <p>A list of receipt rule sets that exist under your
|
|
3174
|
+
* <p>A list of receipt rule sets that exist under your Amazon Web Services account.</p>
|
|
3092
3175
|
*/
|
|
3093
3176
|
export interface ListReceiptRuleSetsResponse {
|
|
3094
3177
|
/**
|
|
@@ -3118,8 +3201,8 @@ export interface ListTemplatesRequest {
|
|
|
3118
3201
|
/**
|
|
3119
3202
|
* @public
|
|
3120
3203
|
* <p>The maximum number of templates to return. This value must be at least 1 and less than
|
|
3121
|
-
* or equal to
|
|
3122
|
-
*
|
|
3204
|
+
* or equal to 100. If more than 100 items are requested, the page size will automatically
|
|
3205
|
+
* set to 100. If you do not specify a value, 10 is the default page size. </p>
|
|
3123
3206
|
*/
|
|
3124
3207
|
MaxItems?: number;
|
|
3125
3208
|
}
|
|
@@ -3153,14 +3236,14 @@ export interface ListTemplatesResponse {
|
|
|
3153
3236
|
* @public
|
|
3154
3237
|
* <p>A token indicating that there are additional email templates available to be listed.
|
|
3155
3238
|
* Pass this token to a subsequent call to <code>ListTemplates</code> to retrieve the next
|
|
3156
|
-
*
|
|
3239
|
+
* set of email templates within your page size.</p>
|
|
3157
3240
|
*/
|
|
3158
3241
|
NextToken?: string;
|
|
3159
3242
|
}
|
|
3160
3243
|
/**
|
|
3161
3244
|
* @public
|
|
3162
|
-
* <p>A list of email addresses that you have verified with Amazon SES under your
|
|
3163
|
-
* account.</p>
|
|
3245
|
+
* <p>A list of email addresses that you have verified with Amazon SES under your
|
|
3246
|
+
* Amazon Web Services account.</p>
|
|
3164
3247
|
*/
|
|
3165
3248
|
export interface ListVerifiedEmailAddressesResponse {
|
|
3166
3249
|
/**
|
|
@@ -3191,7 +3274,7 @@ export declare class MailFromDomainNotVerifiedException extends __BaseException
|
|
|
3191
3274
|
export interface Message {
|
|
3192
3275
|
/**
|
|
3193
3276
|
* @public
|
|
3194
|
-
* <p>The subject of the message: A short summary of the content, which
|
|
3277
|
+
* <p>The subject of the message: A short summary of the content, which appears in the
|
|
3195
3278
|
* recipient's inbox.</p>
|
|
3196
3279
|
*/
|
|
3197
3280
|
Subject: Content | undefined;
|
|
@@ -3205,8 +3288,8 @@ export interface Message {
|
|
|
3205
3288
|
* @public
|
|
3206
3289
|
* <p>Message-related information to include in the Delivery Status Notification (DSN) when
|
|
3207
3290
|
* an email that Amazon SES receives on your behalf bounces.</p>
|
|
3208
|
-
*
|
|
3209
|
-
*
|
|
3291
|
+
* <p>For information about receiving email through Amazon SES, see the <a href="https://docs.aws.amazon.com/ses/latest/dg/receiving-email.html">Amazon SES Developer
|
|
3292
|
+
* Guide</a>.</p>
|
|
3210
3293
|
*/
|
|
3211
3294
|
export interface MessageDsn {
|
|
3212
3295
|
/**
|
|
@@ -3256,10 +3339,19 @@ export declare class MissingRenderingAttributeException extends __BaseException
|
|
|
3256
3339
|
*/
|
|
3257
3340
|
constructor(opts: __ExceptionOptionType<MissingRenderingAttributeException, __BaseException>);
|
|
3258
3341
|
}
|
|
3342
|
+
/**
|
|
3343
|
+
* @public
|
|
3344
|
+
* @enum
|
|
3345
|
+
*/
|
|
3346
|
+
export declare const NotificationType: {
|
|
3347
|
+
readonly Bounce: "Bounce";
|
|
3348
|
+
readonly Complaint: "Complaint";
|
|
3349
|
+
readonly Delivery: "Delivery";
|
|
3350
|
+
};
|
|
3259
3351
|
/**
|
|
3260
3352
|
* @public
|
|
3261
3353
|
*/
|
|
3262
|
-
export type NotificationType =
|
|
3354
|
+
export type NotificationType = (typeof NotificationType)[keyof typeof NotificationType];
|
|
3263
3355
|
/**
|
|
3264
3356
|
* @public
|
|
3265
3357
|
* <p>Indicates that the account has not been granted production access.</p>
|
|
@@ -3279,8 +3371,7 @@ export declare class ProductionAccessNotGrantedException extends __BaseException
|
|
|
3279
3371
|
export interface PutConfigurationSetDeliveryOptionsRequest {
|
|
3280
3372
|
/**
|
|
3281
3373
|
* @public
|
|
3282
|
-
* <p>The name of the configuration set
|
|
3283
|
-
* for.</p>
|
|
3374
|
+
* <p>The name of the configuration set.</p>
|
|
3284
3375
|
*/
|
|
3285
3376
|
ConfigurationSetName: string | undefined;
|
|
3286
3377
|
/**
|
|
@@ -3301,31 +3392,30 @@ export interface PutConfigurationSetDeliveryOptionsResponse {
|
|
|
3301
3392
|
* @public
|
|
3302
3393
|
* <p>Represents a request to add or update a sending authorization policy for an identity.
|
|
3303
3394
|
* Sending authorization is an Amazon SES feature that enables you to authorize other senders to
|
|
3304
|
-
* use your identities. For information, see the <a href="https://docs.aws.amazon.com/ses/latest/
|
|
3305
|
-
* Guide</a>.</p>
|
|
3395
|
+
* use your identities. For information, see the <a href="https://docs.aws.amazon.com/ses/latest/dg/sending-authorization.html">Amazon SES Developer Guide</a>.</p>
|
|
3306
3396
|
*/
|
|
3307
3397
|
export interface PutIdentityPolicyRequest {
|
|
3308
3398
|
/**
|
|
3309
3399
|
* @public
|
|
3310
|
-
* <p>The identity that the policy
|
|
3311
|
-
* name or by using its Amazon Resource Name (ARN). Examples:
|
|
3312
|
-
*
|
|
3400
|
+
* <p>The identity to which that the policy applies. You can specify an identity by using
|
|
3401
|
+
* its name or by using its Amazon Resource Name (ARN). Examples:
|
|
3402
|
+
* <code>user@example.com</code>, <code>example.com</code>,
|
|
3313
3403
|
* <code>arn:aws:ses:us-east-1:123456789012:identity/example.com</code>.</p>
|
|
3314
|
-
*
|
|
3404
|
+
* <p>To successfully call this operation, you must own the identity.</p>
|
|
3315
3405
|
*/
|
|
3316
3406
|
Identity: string | undefined;
|
|
3317
3407
|
/**
|
|
3318
3408
|
* @public
|
|
3319
3409
|
* <p>The name of the policy.</p>
|
|
3320
|
-
*
|
|
3410
|
+
* <p>The policy name cannot exceed 64 characters and can only include alphanumeric
|
|
3321
3411
|
* characters, dashes, and underscores.</p>
|
|
3322
3412
|
*/
|
|
3323
3413
|
PolicyName: string | undefined;
|
|
3324
3414
|
/**
|
|
3325
3415
|
* @public
|
|
3326
3416
|
* <p>The text of the policy in JSON format. The policy cannot exceed 4 KB.</p>
|
|
3327
|
-
*
|
|
3328
|
-
* Guide</a>. </p>
|
|
3417
|
+
* <p>For information about the syntax of sending authorization policies, see the <a href="https://docs.aws.amazon.com/ses/latest/dg/sending-authorization-policies.html">Amazon SES
|
|
3418
|
+
* Developer Guide</a>. </p>
|
|
3329
3419
|
*/
|
|
3330
3420
|
Policy: string | undefined;
|
|
3331
3421
|
}
|
|
@@ -3343,27 +3433,27 @@ export interface RawMessage {
|
|
|
3343
3433
|
/**
|
|
3344
3434
|
* @public
|
|
3345
3435
|
* <p>The raw data of the message. This data needs to base64-encoded if you are accessing
|
|
3346
|
-
* Amazon SES directly through the HTTPS interface. If you are accessing Amazon SES using an
|
|
3436
|
+
* Amazon SES directly through the HTTPS interface. If you are accessing Amazon SES using an Amazon Web Services
|
|
3347
3437
|
* SDK, the SDK takes care of the base 64-encoding for you. In all cases, the client must
|
|
3348
3438
|
* ensure that the message format complies with Internet email standards regarding email
|
|
3349
3439
|
* header fields, MIME types, and MIME encoding.</p>
|
|
3350
|
-
*
|
|
3351
|
-
*
|
|
3440
|
+
* <p>The To:, CC:, and BCC: headers in the raw message can contain a group list.</p>
|
|
3441
|
+
* <p>If you are using <code>SendRawEmail</code> with sending authorization, you can include
|
|
3352
3442
|
* X-headers in the raw message to specify the "Source," "From," and "Return-Path"
|
|
3353
3443
|
* addresses. For more information, see the documentation for <code>SendRawEmail</code>. </p>
|
|
3354
|
-
*
|
|
3444
|
+
* <important>
|
|
3355
3445
|
* <p>Do not include these X-headers in the DKIM signature, because they are removed by
|
|
3356
3446
|
* Amazon SES before sending the email.</p>
|
|
3357
|
-
*
|
|
3358
|
-
*
|
|
3359
|
-
* Guide</a>.</p>
|
|
3447
|
+
* </important>
|
|
3448
|
+
* <p>For more information, go to the <a href="https://docs.aws.amazon.com/ses/latest/dg/send-email-raw.html">Amazon SES Developer Guide</a>.</p>
|
|
3360
3449
|
*/
|
|
3361
3450
|
Data: Uint8Array | undefined;
|
|
3362
3451
|
}
|
|
3363
3452
|
/**
|
|
3364
3453
|
* @public
|
|
3365
3454
|
* <p>Represents a request to reorder the receipt rules within a receipt rule set. You use
|
|
3366
|
-
* receipt rule sets to receive email with Amazon SES. For more information, see the <a href="https://docs.aws.amazon.com/ses/latest/
|
|
3455
|
+
* receipt rule sets to receive email with Amazon SES. For more information, see the <a href="https://docs.aws.amazon.com/ses/latest/dg/receiving-email-concepts.html">Amazon SES
|
|
3456
|
+
* Developer Guide</a>.</p>
|
|
3367
3457
|
*/
|
|
3368
3458
|
export interface ReorderReceiptRuleSetRequest {
|
|
3369
3459
|
/**
|
|
@@ -3373,8 +3463,7 @@ export interface ReorderReceiptRuleSetRequest {
|
|
|
3373
3463
|
RuleSetName: string | undefined;
|
|
3374
3464
|
/**
|
|
3375
3465
|
* @public
|
|
3376
|
-
* <p>
|
|
3377
|
-
* put them.</p>
|
|
3466
|
+
* <p>The specified receipt rule set's receipt rules, in order.</p>
|
|
3378
3467
|
*/
|
|
3379
3468
|
RuleNames: string[] | undefined;
|
|
3380
3469
|
}
|
|
@@ -3404,12 +3493,12 @@ export interface SendBounceRequest {
|
|
|
3404
3493
|
/**
|
|
3405
3494
|
* @public
|
|
3406
3495
|
* <p>Human-readable text for the bounce message to explain the failure. If not specified,
|
|
3407
|
-
* the text
|
|
3496
|
+
* the text is auto-generated based on the bounced recipient information.</p>
|
|
3408
3497
|
*/
|
|
3409
3498
|
Explanation?: string;
|
|
3410
3499
|
/**
|
|
3411
3500
|
* @public
|
|
3412
|
-
* <p>Message-related DSN fields. If not specified, Amazon SES
|
|
3501
|
+
* <p>Message-related DSN fields. If not specified, Amazon SES chooses the values.</p>
|
|
3413
3502
|
*/
|
|
3414
3503
|
MessageDsn?: MessageDsn;
|
|
3415
3504
|
/**
|
|
@@ -3424,8 +3513,7 @@ export interface SendBounceRequest {
|
|
|
3424
3513
|
* <p>This parameter is used only for sending authorization. It is the ARN of the identity
|
|
3425
3514
|
* that is associated with the sending authorization policy that permits you to use the
|
|
3426
3515
|
* address in the "From" header of the bounce. For more information about sending
|
|
3427
|
-
* authorization, see the <a href="https://docs.aws.amazon.com/ses/latest/
|
|
3428
|
-
* Guide</a>.</p>
|
|
3516
|
+
* authorization, see the <a href="https://docs.aws.amazon.com/ses/latest/dg/sending-authorization.html">Amazon SES Developer Guide</a>.</p>
|
|
3429
3517
|
*/
|
|
3430
3518
|
BounceSenderArn?: string;
|
|
3431
3519
|
}
|
|
@@ -3443,31 +3531,29 @@ export interface SendBounceResponse {
|
|
|
3443
3531
|
/**
|
|
3444
3532
|
* @public
|
|
3445
3533
|
* <p>Represents a request to send a templated email to multiple destinations using Amazon SES.
|
|
3446
|
-
* For more information, see the <a href="https://docs.aws.amazon.com/ses/latest/
|
|
3447
|
-
*
|
|
3534
|
+
* For more information, see the <a href="https://docs.aws.amazon.com/ses/latest/dg/send-personalized-email-api.html">Amazon SES Developer
|
|
3535
|
+
* Guide</a>.</p>
|
|
3448
3536
|
*/
|
|
3449
3537
|
export interface SendBulkTemplatedEmailRequest {
|
|
3450
3538
|
/**
|
|
3451
3539
|
* @public
|
|
3452
3540
|
* <p>The email address that is sending the email. This email address must be either
|
|
3453
3541
|
* individually verified with Amazon SES, or from a domain that has been verified with Amazon SES.
|
|
3454
|
-
* For information about verifying identities, see the <a href="https://docs.aws.amazon.com/ses/latest/
|
|
3455
|
-
*
|
|
3456
|
-
* <p>If you are sending on behalf of another user and have been permitted to do so by a
|
|
3542
|
+
* For information about verifying identities, see the <a href="https://docs.aws.amazon.com/ses/latest/dg/creating-identities.html">Amazon SES Developer Guide</a>.</p>
|
|
3543
|
+
* <p>If you are sending on behalf of another user and have been permitted to do so by a
|
|
3457
3544
|
* sending authorization policy, then you must also specify the <code>SourceArn</code>
|
|
3458
|
-
* parameter. For more information about sending authorization, see the <a href="https://docs.aws.amazon.com/ses/latest/
|
|
3459
|
-
*
|
|
3545
|
+
* parameter. For more information about sending authorization, see the <a href="https://docs.aws.amazon.com/ses/latest/dg/sending-authorization.html">Amazon SES Developer
|
|
3546
|
+
* Guide</a>.</p>
|
|
3547
|
+
* <note>
|
|
3460
3548
|
* <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
|
|
3461
|
-
*
|
|
3462
|
-
*
|
|
3463
|
-
*
|
|
3464
|
-
* part
|
|
3465
|
-
*
|
|
3466
|
-
*
|
|
3467
|
-
*
|
|
3468
|
-
*
|
|
3469
|
-
* <code>=?charset?encoding?encoded-text?=</code>.</p>
|
|
3470
|
-
* </note>
|
|
3549
|
+
* email address string must be 7-bit ASCII. If you want to send to or from email
|
|
3550
|
+
* addresses that contain Unicode characters in the domain part of an address, you must
|
|
3551
|
+
* encode the domain using Punycode. Punycode is not permitted in the local part of the
|
|
3552
|
+
* email address (the part before the @ sign) nor in the "friendly from" name. If you
|
|
3553
|
+
* want to use Unicode characters in the "friendly from" name, you must encode the
|
|
3554
|
+
* "friendly from" name using MIME encoded-word syntax, as described in <a href="https://docs.aws.amazon.com/ses/latest/dg/send-email-raw.html">Sending raw email
|
|
3555
|
+
* using the Amazon SES API</a>. For more information about Punycode, see <a href="http://tools.ietf.org/html/rfc3492">RFC 3492</a>.</p>
|
|
3556
|
+
* </note>
|
|
3471
3557
|
*/
|
|
3472
3558
|
Source: string | undefined;
|
|
3473
3559
|
/**
|
|
@@ -3475,28 +3561,27 @@ export interface SendBulkTemplatedEmailRequest {
|
|
|
3475
3561
|
* <p>This parameter is used only for sending authorization. It is the ARN of the identity
|
|
3476
3562
|
* that is associated with the sending authorization policy that permits you to send for
|
|
3477
3563
|
* the email address specified in the <code>Source</code> parameter.</p>
|
|
3478
|
-
*
|
|
3564
|
+
* <p>For example, if the owner of <code>example.com</code> (which has ARN
|
|
3479
3565
|
* <code>arn:aws:ses:us-east-1:123456789012:identity/example.com</code>) attaches a
|
|
3480
3566
|
* policy to it that authorizes you to send from <code>user@example.com</code>, then you
|
|
3481
3567
|
* would specify the <code>SourceArn</code> to be
|
|
3482
3568
|
* <code>arn:aws:ses:us-east-1:123456789012:identity/example.com</code>, and the
|
|
3483
3569
|
* <code>Source</code> to be <code>user@example.com</code>.</p>
|
|
3484
|
-
*
|
|
3485
|
-
* Guide</a>.</p>
|
|
3570
|
+
* <p>For more information about sending authorization, see the <a href="https://docs.aws.amazon.com/ses/latest/dg/sending-authorization.html">Amazon SES Developer Guide</a>.</p>
|
|
3486
3571
|
*/
|
|
3487
3572
|
SourceArn?: string;
|
|
3488
3573
|
/**
|
|
3489
3574
|
* @public
|
|
3490
3575
|
* <p>The reply-to email address(es) for the message. If the recipient replies to the
|
|
3491
|
-
* message, each reply-to address
|
|
3576
|
+
* message, each reply-to address receives the reply.</p>
|
|
3492
3577
|
*/
|
|
3493
3578
|
ReplyToAddresses?: string[];
|
|
3494
3579
|
/**
|
|
3495
3580
|
* @public
|
|
3496
|
-
* <p>The email address that bounces and complaints
|
|
3581
|
+
* <p>The email address that bounces and complaints are forwarded to when feedback
|
|
3497
3582
|
* forwarding is enabled. If the message cannot be delivered to the recipient, then an
|
|
3498
|
-
* error message
|
|
3499
|
-
*
|
|
3583
|
+
* error message is returned from the recipient's ISP; this message is forwarded to the
|
|
3584
|
+
* email address specified by the <code>ReturnPath</code> parameter. The
|
|
3500
3585
|
* <code>ReturnPath</code> parameter is never overwritten. This email address must be
|
|
3501
3586
|
* either individually verified with Amazon SES, or from a domain that has been verified with
|
|
3502
3587
|
* Amazon SES. </p>
|
|
@@ -3507,14 +3592,13 @@ export interface SendBulkTemplatedEmailRequest {
|
|
|
3507
3592
|
* <p>This parameter is used only for sending authorization. It is the ARN of the identity
|
|
3508
3593
|
* that is associated with the sending authorization policy that permits you to use the
|
|
3509
3594
|
* email address specified in the <code>ReturnPath</code> parameter.</p>
|
|
3510
|
-
*
|
|
3595
|
+
* <p>For example, if the owner of <code>example.com</code> (which has ARN
|
|
3511
3596
|
* <code>arn:aws:ses:us-east-1:123456789012:identity/example.com</code>) attaches a
|
|
3512
3597
|
* policy to it that authorizes you to use <code>feedback@example.com</code>, then you
|
|
3513
3598
|
* would specify the <code>ReturnPathArn</code> to be
|
|
3514
3599
|
* <code>arn:aws:ses:us-east-1:123456789012:identity/example.com</code>, and the
|
|
3515
3600
|
* <code>ReturnPath</code> to be <code>feedback@example.com</code>.</p>
|
|
3516
|
-
*
|
|
3517
|
-
* Guide</a>.</p>
|
|
3601
|
+
* <p>For more information about sending authorization, see the <a href="https://docs.aws.amazon.com/ses/latest/dg/sending-authorization.html">Amazon SES Developer Guide</a>.</p>
|
|
3518
3602
|
*/
|
|
3519
3603
|
ReturnPathArn?: string;
|
|
3520
3604
|
/**
|
|
@@ -3544,16 +3628,15 @@ export interface SendBulkTemplatedEmailRequest {
|
|
|
3544
3628
|
* <p>A list of replacement values to apply to the template when replacement data is not
|
|
3545
3629
|
* specified in a Destination object. These values act as a default or fallback option when
|
|
3546
3630
|
* no other data is available.</p>
|
|
3547
|
-
*
|
|
3631
|
+
* <p>The template data is a JSON object, typically consisting of key-value pairs in which
|
|
3548
3632
|
* the keys correspond to replacement tags in the email template.</p>
|
|
3549
3633
|
*/
|
|
3550
3634
|
DefaultTemplateData?: string;
|
|
3551
3635
|
/**
|
|
3552
3636
|
* @public
|
|
3553
3637
|
* <p>One or more <code>Destination</code> objects. All of the recipients in a
|
|
3554
|
-
* <code>Destination</code>
|
|
3555
|
-
*
|
|
3556
|
-
* array.</p>
|
|
3638
|
+
* <code>Destination</code> receive the same version of the email. You can specify up
|
|
3639
|
+
* to 50 <code>Destination</code> objects within a <code>Destinations</code> array.</p>
|
|
3557
3640
|
*/
|
|
3558
3641
|
Destinations: BulkEmailDestination[] | undefined;
|
|
3559
3642
|
}
|
|
@@ -3563,8 +3646,9 @@ export interface SendBulkTemplatedEmailRequest {
|
|
|
3563
3646
|
export interface SendBulkTemplatedEmailResponse {
|
|
3564
3647
|
/**
|
|
3565
3648
|
* @public
|
|
3566
|
-
* <p>
|
|
3567
|
-
*
|
|
3649
|
+
* <p>One object per intended recipient. Check each response object and retry any messages
|
|
3650
|
+
* with a failure status. (Note that order of responses will be respective to order of
|
|
3651
|
+
* destinations in the request.)Receipt rules enable you to specify which actions </p>
|
|
3568
3652
|
*/
|
|
3569
3653
|
Status: BulkEmailDestinationStatus[] | undefined;
|
|
3570
3654
|
}
|
|
@@ -3606,31 +3690,28 @@ export interface SendCustomVerificationEmailResponse {
|
|
|
3606
3690
|
/**
|
|
3607
3691
|
* @public
|
|
3608
3692
|
* <p>Represents a request to send a single formatted email using Amazon SES. For more
|
|
3609
|
-
* information, see the <a href="https://docs.aws.amazon.com/ses/latest/
|
|
3610
|
-
* Guide</a>.</p>
|
|
3693
|
+
* information, see the <a href="https://docs.aws.amazon.com/ses/latest/dg/send-email-formatted.html">Amazon SES Developer Guide</a>.</p>
|
|
3611
3694
|
*/
|
|
3612
3695
|
export interface SendEmailRequest {
|
|
3613
3696
|
/**
|
|
3614
3697
|
* @public
|
|
3615
3698
|
* <p>The email address that is sending the email. This email address must be either
|
|
3616
3699
|
* individually verified with Amazon SES, or from a domain that has been verified with Amazon SES.
|
|
3617
|
-
* For information about verifying identities, see the <a href="https://docs.aws.amazon.com/ses/latest/
|
|
3618
|
-
*
|
|
3619
|
-
* <p>If you are sending on behalf of another user and have been permitted to do so by a
|
|
3700
|
+
* For information about verifying identities, see the <a href="https://docs.aws.amazon.com/ses/latest/dg/creating-identities.html">Amazon SES Developer Guide</a>.</p>
|
|
3701
|
+
* <p>If you are sending on behalf of another user and have been permitted to do so by a
|
|
3620
3702
|
* sending authorization policy, then you must also specify the <code>SourceArn</code>
|
|
3621
|
-
* parameter. For more information about sending authorization, see the <a href="https://docs.aws.amazon.com/ses/latest/
|
|
3622
|
-
*
|
|
3703
|
+
* parameter. For more information about sending authorization, see the <a href="https://docs.aws.amazon.com/ses/latest/dg/sending-authorization.html">Amazon SES Developer
|
|
3704
|
+
* Guide</a>.</p>
|
|
3705
|
+
* <note>
|
|
3623
3706
|
* <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
|
|
3624
|
-
*
|
|
3625
|
-
*
|
|
3626
|
-
*
|
|
3627
|
-
* part
|
|
3628
|
-
*
|
|
3629
|
-
*
|
|
3630
|
-
*
|
|
3631
|
-
*
|
|
3632
|
-
* <code>=?charset?encoding?encoded-text?=</code>.</p>
|
|
3633
|
-
* </note>
|
|
3707
|
+
* email address string must be 7-bit ASCII. If you want to send to or from email
|
|
3708
|
+
* addresses that contain Unicode characters in the domain part of an address, you must
|
|
3709
|
+
* encode the domain using Punycode. Punycode is not permitted in the local part of the
|
|
3710
|
+
* email address (the part before the @ sign) nor in the "friendly from" name. If you
|
|
3711
|
+
* want to use Unicode characters in the "friendly from" name, you must encode the
|
|
3712
|
+
* "friendly from" name using MIME encoded-word syntax, as described in <a href="https://docs.aws.amazon.com/ses/latest/dg/send-email-raw.html">Sending raw email
|
|
3713
|
+
* using the Amazon SES API</a>. For more information about Punycode, see <a href="http://tools.ietf.org/html/rfc3492">RFC 3492</a>.</p>
|
|
3714
|
+
* </note>
|
|
3634
3715
|
*/
|
|
3635
3716
|
Source: string | undefined;
|
|
3636
3717
|
/**
|
|
@@ -3646,15 +3727,15 @@ export interface SendEmailRequest {
|
|
|
3646
3727
|
/**
|
|
3647
3728
|
* @public
|
|
3648
3729
|
* <p>The reply-to email address(es) for the message. If the recipient replies to the
|
|
3649
|
-
* message, each reply-to address
|
|
3730
|
+
* message, each reply-to address receives the reply.</p>
|
|
3650
3731
|
*/
|
|
3651
3732
|
ReplyToAddresses?: string[];
|
|
3652
3733
|
/**
|
|
3653
3734
|
* @public
|
|
3654
|
-
* <p>The email address that bounces and complaints
|
|
3735
|
+
* <p>The email address that bounces and complaints are forwarded to when feedback
|
|
3655
3736
|
* forwarding is enabled. If the message cannot be delivered to the recipient, then an
|
|
3656
|
-
* error message
|
|
3657
|
-
*
|
|
3737
|
+
* error message is returned from the recipient's ISP; this message is forwarded to the
|
|
3738
|
+
* email address specified by the <code>ReturnPath</code> parameter. The
|
|
3658
3739
|
* <code>ReturnPath</code> parameter is never overwritten. This email address must be
|
|
3659
3740
|
* either individually verified with Amazon SES, or from a domain that has been verified with
|
|
3660
3741
|
* Amazon SES. </p>
|
|
@@ -3665,14 +3746,13 @@ export interface SendEmailRequest {
|
|
|
3665
3746
|
* <p>This parameter is used only for sending authorization. It is the ARN of the identity
|
|
3666
3747
|
* that is associated with the sending authorization policy that permits you to send for
|
|
3667
3748
|
* the email address specified in the <code>Source</code> parameter.</p>
|
|
3668
|
-
*
|
|
3749
|
+
* <p>For example, if the owner of <code>example.com</code> (which has ARN
|
|
3669
3750
|
* <code>arn:aws:ses:us-east-1:123456789012:identity/example.com</code>) attaches a
|
|
3670
3751
|
* policy to it that authorizes you to send from <code>user@example.com</code>, then you
|
|
3671
3752
|
* would specify the <code>SourceArn</code> to be
|
|
3672
3753
|
* <code>arn:aws:ses:us-east-1:123456789012:identity/example.com</code>, and the
|
|
3673
3754
|
* <code>Source</code> to be <code>user@example.com</code>.</p>
|
|
3674
|
-
*
|
|
3675
|
-
* Guide</a>.</p>
|
|
3755
|
+
* <p>For more information about sending authorization, see the <a href="https://docs.aws.amazon.com/ses/latest/dg/sending-authorization.html">Amazon SES Developer Guide</a>.</p>
|
|
3676
3756
|
*/
|
|
3677
3757
|
SourceArn?: string;
|
|
3678
3758
|
/**
|
|
@@ -3680,14 +3760,13 @@ export interface SendEmailRequest {
|
|
|
3680
3760
|
* <p>This parameter is used only for sending authorization. It is the ARN of the identity
|
|
3681
3761
|
* that is associated with the sending authorization policy that permits you to use the
|
|
3682
3762
|
* email address specified in the <code>ReturnPath</code> parameter.</p>
|
|
3683
|
-
*
|
|
3763
|
+
* <p>For example, if the owner of <code>example.com</code> (which has ARN
|
|
3684
3764
|
* <code>arn:aws:ses:us-east-1:123456789012:identity/example.com</code>) attaches a
|
|
3685
3765
|
* policy to it that authorizes you to use <code>feedback@example.com</code>, then you
|
|
3686
3766
|
* would specify the <code>ReturnPathArn</code> to be
|
|
3687
3767
|
* <code>arn:aws:ses:us-east-1:123456789012:identity/example.com</code>, and the
|
|
3688
3768
|
* <code>ReturnPath</code> to be <code>feedback@example.com</code>.</p>
|
|
3689
|
-
*
|
|
3690
|
-
* Guide</a>.</p>
|
|
3769
|
+
* <p>For more information about sending authorization, see the <a href="https://docs.aws.amazon.com/ses/latest/dg/sending-authorization.html">Amazon SES Developer Guide</a>.</p>
|
|
3691
3770
|
*/
|
|
3692
3771
|
ReturnPathArn?: string;
|
|
3693
3772
|
/**
|
|
@@ -3718,7 +3797,8 @@ export interface SendEmailResponse {
|
|
|
3718
3797
|
/**
|
|
3719
3798
|
* @public
|
|
3720
3799
|
* <p>Represents a request to send a single raw email using Amazon SES. For more information, see
|
|
3721
|
-
* the <a href="https://docs.aws.amazon.com/ses/latest/
|
|
3800
|
+
* the <a href="https://docs.aws.amazon.com/ses/latest/dg/send-email-raw.html">Amazon SES Developer
|
|
3801
|
+
* Guide</a>.</p>
|
|
3722
3802
|
*/
|
|
3723
3803
|
export interface SendRawEmailRequest {
|
|
3724
3804
|
/**
|
|
@@ -3726,23 +3806,19 @@ export interface SendRawEmailRequest {
|
|
|
3726
3806
|
* <p>The identity's email address. If you do not provide a value for this parameter, you
|
|
3727
3807
|
* must specify a "From" address in the raw text of the message. (You can also specify
|
|
3728
3808
|
* both.)</p>
|
|
3729
|
-
*
|
|
3809
|
+
* <note>
|
|
3730
3810
|
* <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
|
|
3731
|
-
*
|
|
3732
|
-
*
|
|
3733
|
-
*
|
|
3734
|
-
* part
|
|
3735
|
-
*
|
|
3736
|
-
*
|
|
3737
|
-
*
|
|
3738
|
-
*
|
|
3739
|
-
*
|
|
3740
|
-
*
|
|
3741
|
-
*
|
|
3742
|
-
* <p>If you specify the <code>Source</code> parameter and have feedback forwarding enabled,
|
|
3743
|
-
* then bounces and complaints will be sent to this email address. This takes precedence
|
|
3744
|
-
* over any Return-Path header that you might include in the raw text of the
|
|
3745
|
-
* message.</p>
|
|
3811
|
+
* email address string must be 7-bit ASCII. If you want to send to or from email
|
|
3812
|
+
* addresses that contain Unicode characters in the domain part of an address, you must
|
|
3813
|
+
* encode the domain using Punycode. Punycode is not permitted in the local part of the
|
|
3814
|
+
* email address (the part before the @ sign) nor in the "friendly from" name. If you
|
|
3815
|
+
* want to use Unicode characters in the "friendly from" name, you must encode the
|
|
3816
|
+
* "friendly from" name using MIME encoded-word syntax, as described in <a href="https://docs.aws.amazon.com/ses/latest/dg/send-email-raw.html">Sending raw email
|
|
3817
|
+
* using the Amazon SES API</a>. For more information about Punycode, see <a href="http://tools.ietf.org/html/rfc3492">RFC 3492</a>.</p>
|
|
3818
|
+
* </note>
|
|
3819
|
+
* <p>If you specify the <code>Source</code> parameter and have feedback forwarding enabled,
|
|
3820
|
+
* then bounces and complaints are sent to this email address. This takes precedence over
|
|
3821
|
+
* any Return-Path header that you might include in the raw text of the message.</p>
|
|
3746
3822
|
*/
|
|
3747
3823
|
Source?: string;
|
|
3748
3824
|
/**
|
|
@@ -3754,33 +3830,33 @@ export interface SendRawEmailRequest {
|
|
|
3754
3830
|
/**
|
|
3755
3831
|
* @public
|
|
3756
3832
|
* <p>The raw email message itself. The message has to meet the following criteria:</p>
|
|
3757
|
-
*
|
|
3833
|
+
* <ul>
|
|
3758
3834
|
* <li>
|
|
3759
|
-
*
|
|
3835
|
+
* <p>The message has to contain a header and a body, separated by a blank
|
|
3760
3836
|
* line.</p>
|
|
3761
3837
|
* </li>
|
|
3762
3838
|
* <li>
|
|
3763
|
-
*
|
|
3839
|
+
* <p>All of the required header fields must be present in the message.</p>
|
|
3764
3840
|
* </li>
|
|
3765
3841
|
* <li>
|
|
3766
|
-
*
|
|
3842
|
+
* <p>Each part of a multipart MIME message must be formatted properly.</p>
|
|
3767
3843
|
* </li>
|
|
3768
3844
|
* <li>
|
|
3769
|
-
*
|
|
3770
|
-
* unsupported content types, see <a href="https://docs.aws.amazon.com/ses/latest/
|
|
3771
|
-
*
|
|
3845
|
+
* <p>Attachments must be of a content type that Amazon SES supports. For a list on
|
|
3846
|
+
* unsupported content types, see <a href="https://docs.aws.amazon.com/ses/latest/dg/mime-types.html">Unsupported Attachment Types</a> in
|
|
3847
|
+
* the <i>Amazon SES Developer Guide</i>.</p>
|
|
3772
3848
|
* </li>
|
|
3773
3849
|
* <li>
|
|
3774
|
-
*
|
|
3850
|
+
* <p>The entire message must be base64-encoded.</p>
|
|
3775
3851
|
* </li>
|
|
3776
3852
|
* <li>
|
|
3777
|
-
*
|
|
3853
|
+
* <p>If any of the MIME parts in your message contain content that is outside of
|
|
3778
3854
|
* the 7-bit ASCII character range, we highly recommend that you encode that
|
|
3779
|
-
* content. For more information, see <a href="https://docs.aws.amazon.com/ses/latest/
|
|
3780
|
-
*
|
|
3855
|
+
* content. For more information, see <a href="https://docs.aws.amazon.com/ses/latest/dg/send-email-raw.html">Sending Raw
|
|
3856
|
+
* Email</a> in the <i>Amazon SES Developer Guide</i>.</p>
|
|
3781
3857
|
* </li>
|
|
3782
3858
|
* <li>
|
|
3783
|
-
*
|
|
3859
|
+
* <p>Per <a href="https://tools.ietf.org/html/rfc5321#section-4.5.3.1.6">RFC
|
|
3784
3860
|
* 5321</a>, the maximum length of each line of text, including the
|
|
3785
3861
|
* <CRLF>, must not exceed 1,000 characters.</p>
|
|
3786
3862
|
* </li>
|
|
@@ -3792,14 +3868,15 @@ export interface SendRawEmailRequest {
|
|
|
3792
3868
|
* <p>This parameter is used only for sending authorization. It is the ARN of the identity
|
|
3793
3869
|
* that is associated with the sending authorization policy that permits you to specify a
|
|
3794
3870
|
* particular "From" address in the header of the raw email.</p>
|
|
3795
|
-
*
|
|
3871
|
+
* <p>Instead of using this parameter, you can use the X-header <code>X-SES-FROM-ARN</code>
|
|
3796
3872
|
* in the raw message of the email. If you use both the <code>FromArn</code> parameter and
|
|
3797
3873
|
* the corresponding X-header, Amazon SES uses the value of the <code>FromArn</code>
|
|
3798
3874
|
* parameter.</p>
|
|
3799
|
-
*
|
|
3875
|
+
* <note>
|
|
3800
3876
|
* <p>For information about when to use this parameter, see the description of
|
|
3801
|
-
* <code>SendRawEmail</code> in this guide, or see the <a href="https://docs.aws.amazon.com/ses/latest/
|
|
3802
|
-
*
|
|
3877
|
+
* <code>SendRawEmail</code> in this guide, or see the <a href="https://docs.aws.amazon.com/ses/latest/dg/sending-authorization-delegate-sender-tasks-email.html">Amazon SES
|
|
3878
|
+
* Developer Guide</a>.</p>
|
|
3879
|
+
* </note>
|
|
3803
3880
|
*/
|
|
3804
3881
|
FromArn?: string;
|
|
3805
3882
|
/**
|
|
@@ -3807,20 +3884,21 @@ export interface SendRawEmailRequest {
|
|
|
3807
3884
|
* <p>This parameter is used only for sending authorization. It is the ARN of the identity
|
|
3808
3885
|
* that is associated with the sending authorization policy that permits you to send for
|
|
3809
3886
|
* the email address specified in the <code>Source</code> parameter.</p>
|
|
3810
|
-
*
|
|
3887
|
+
* <p>For example, if the owner of <code>example.com</code> (which has ARN
|
|
3811
3888
|
* <code>arn:aws:ses:us-east-1:123456789012:identity/example.com</code>) attaches a
|
|
3812
3889
|
* policy to it that authorizes you to send from <code>user@example.com</code>, then you
|
|
3813
3890
|
* would specify the <code>SourceArn</code> to be
|
|
3814
3891
|
* <code>arn:aws:ses:us-east-1:123456789012:identity/example.com</code>, and the
|
|
3815
3892
|
* <code>Source</code> to be <code>user@example.com</code>.</p>
|
|
3816
|
-
*
|
|
3893
|
+
* <p>Instead of using this parameter, you can use the X-header
|
|
3817
3894
|
* <code>X-SES-SOURCE-ARN</code> in the raw message of the email. If you use both the
|
|
3818
3895
|
* <code>SourceArn</code> parameter and the corresponding X-header, Amazon SES uses the
|
|
3819
3896
|
* value of the <code>SourceArn</code> parameter.</p>
|
|
3820
|
-
*
|
|
3897
|
+
* <note>
|
|
3821
3898
|
* <p>For information about when to use this parameter, see the description of
|
|
3822
|
-
* <code>SendRawEmail</code> in this guide, or see the <a href="https://docs.aws.amazon.com/ses/latest/
|
|
3823
|
-
*
|
|
3899
|
+
* <code>SendRawEmail</code> in this guide, or see the <a href="https://docs.aws.amazon.com/ses/latest/dg/sending-authorization-delegate-sender-tasks-email.html">Amazon SES
|
|
3900
|
+
* Developer Guide</a>.</p>
|
|
3901
|
+
* </note>
|
|
3824
3902
|
*/
|
|
3825
3903
|
SourceArn?: string;
|
|
3826
3904
|
/**
|
|
@@ -3828,20 +3906,21 @@ export interface SendRawEmailRequest {
|
|
|
3828
3906
|
* <p>This parameter is used only for sending authorization. It is the ARN of the identity
|
|
3829
3907
|
* that is associated with the sending authorization policy that permits you to use the
|
|
3830
3908
|
* email address specified in the <code>ReturnPath</code> parameter.</p>
|
|
3831
|
-
*
|
|
3909
|
+
* <p>For example, if the owner of <code>example.com</code> (which has ARN
|
|
3832
3910
|
* <code>arn:aws:ses:us-east-1:123456789012:identity/example.com</code>) attaches a
|
|
3833
3911
|
* policy to it that authorizes you to use <code>feedback@example.com</code>, then you
|
|
3834
3912
|
* would specify the <code>ReturnPathArn</code> to be
|
|
3835
3913
|
* <code>arn:aws:ses:us-east-1:123456789012:identity/example.com</code>, and the
|
|
3836
3914
|
* <code>ReturnPath</code> to be <code>feedback@example.com</code>.</p>
|
|
3837
|
-
*
|
|
3915
|
+
* <p>Instead of using this parameter, you can use the X-header
|
|
3838
3916
|
* <code>X-SES-RETURN-PATH-ARN</code> in the raw message of the email. If you use both
|
|
3839
3917
|
* the <code>ReturnPathArn</code> parameter and the corresponding X-header, Amazon SES uses the
|
|
3840
3918
|
* value of the <code>ReturnPathArn</code> parameter.</p>
|
|
3841
|
-
*
|
|
3919
|
+
* <note>
|
|
3842
3920
|
* <p>For information about when to use this parameter, see the description of
|
|
3843
|
-
* <code>SendRawEmail</code> in this guide, or see the <a href="https://docs.aws.amazon.com/ses/latest/
|
|
3844
|
-
*
|
|
3921
|
+
* <code>SendRawEmail</code> in this guide, or see the <a href="https://docs.aws.amazon.com/ses/latest/dg/sending-authorization-delegate-sender-tasks-email.html">Amazon SES
|
|
3922
|
+
* Developer Guide</a>.</p>
|
|
3923
|
+
* </note>
|
|
3845
3924
|
*/
|
|
3846
3925
|
ReturnPathArn?: string;
|
|
3847
3926
|
/**
|
|
@@ -3873,31 +3952,28 @@ export interface SendRawEmailResponse {
|
|
|
3873
3952
|
/**
|
|
3874
3953
|
* @public
|
|
3875
3954
|
* <p>Represents a request to send a templated email using Amazon SES. For more information, see
|
|
3876
|
-
* the <a href="https://docs.aws.amazon.com/ses/latest/
|
|
3877
|
-
* Guide</a>.</p>
|
|
3955
|
+
* the <a href="https://docs.aws.amazon.com/ses/latest/dg/send-personalized-email-api.html">Amazon SES Developer Guide</a>.</p>
|
|
3878
3956
|
*/
|
|
3879
3957
|
export interface SendTemplatedEmailRequest {
|
|
3880
3958
|
/**
|
|
3881
3959
|
* @public
|
|
3882
3960
|
* <p>The email address that is sending the email. This email address must be either
|
|
3883
3961
|
* individually verified with Amazon SES, or from a domain that has been verified with Amazon SES.
|
|
3884
|
-
* For information about verifying identities, see the <a href="https://docs.aws.amazon.com/ses/latest/
|
|
3885
|
-
*
|
|
3886
|
-
* <p>If you are sending on behalf of another user and have been permitted to do so by a
|
|
3962
|
+
* For information about verifying identities, see the <a href="https://docs.aws.amazon.com/ses/latest/dg/creating-identities.html">Amazon SES Developer Guide</a>.</p>
|
|
3963
|
+
* <p>If you are sending on behalf of another user and have been permitted to do so by a
|
|
3887
3964
|
* sending authorization policy, then you must also specify the <code>SourceArn</code>
|
|
3888
|
-
* parameter. For more information about sending authorization, see the <a href="https://docs.aws.amazon.com/ses/latest/
|
|
3889
|
-
*
|
|
3890
|
-
*
|
|
3891
|
-
*
|
|
3892
|
-
* address
|
|
3893
|
-
*
|
|
3894
|
-
*
|
|
3895
|
-
*
|
|
3896
|
-
*
|
|
3897
|
-
*
|
|
3898
|
-
*
|
|
3899
|
-
*
|
|
3900
|
-
* </note>
|
|
3965
|
+
* parameter. For more information about sending authorization, see the <a href="https://docs.aws.amazon.com/ses/latest/dg/sending-authorization.html">Amazon SES Developer
|
|
3966
|
+
* Guide</a>.</p>
|
|
3967
|
+
* <note>
|
|
3968
|
+
* <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
|
|
3969
|
+
* email address string must be 7-bit ASCII. If you want to send to or from email
|
|
3970
|
+
* addresses that contain Unicode characters in the domain part of an address, you must
|
|
3971
|
+
* encode the domain using Punycode. Punycode is not permitted in the local part of the
|
|
3972
|
+
* email address (the part before the @ sign) nor in the "friendly from" name. If you
|
|
3973
|
+
* want to use Unicode characters in the "friendly from" name, you must encode the
|
|
3974
|
+
* "friendly from" name using MIME encoded-word syntax, as described in <a href="https://docs.aws.amazon.com/ses/latest/dg/send-email-raw.html">Sending raw email
|
|
3975
|
+
* using the Amazon SES API</a>. For more information about Punycode, see <a href="http://tools.ietf.org/html/rfc3492">RFC 3492</a>.</p>
|
|
3976
|
+
* </note>
|
|
3901
3977
|
*/
|
|
3902
3978
|
Source: string | undefined;
|
|
3903
3979
|
/**
|
|
@@ -3909,15 +3985,15 @@ export interface SendTemplatedEmailRequest {
|
|
|
3909
3985
|
/**
|
|
3910
3986
|
* @public
|
|
3911
3987
|
* <p>The reply-to email address(es) for the message. If the recipient replies to the
|
|
3912
|
-
* message, each reply-to address
|
|
3988
|
+
* message, each reply-to address receives the reply.</p>
|
|
3913
3989
|
*/
|
|
3914
3990
|
ReplyToAddresses?: string[];
|
|
3915
3991
|
/**
|
|
3916
3992
|
* @public
|
|
3917
|
-
* <p>The email address that bounces and complaints
|
|
3993
|
+
* <p>The email address that bounces and complaints are forwarded to when feedback
|
|
3918
3994
|
* forwarding is enabled. If the message cannot be delivered to the recipient, then an
|
|
3919
|
-
* error message
|
|
3920
|
-
*
|
|
3995
|
+
* error message is returned from the recipient's ISP; this message is forwarded to the
|
|
3996
|
+
* email address specified by the <code>ReturnPath</code> parameter. The
|
|
3921
3997
|
* <code>ReturnPath</code> parameter is never overwritten. This email address must be
|
|
3922
3998
|
* either individually verified with Amazon SES, or from a domain that has been verified with
|
|
3923
3999
|
* Amazon SES. </p>
|
|
@@ -3928,14 +4004,13 @@ export interface SendTemplatedEmailRequest {
|
|
|
3928
4004
|
* <p>This parameter is used only for sending authorization. It is the ARN of the identity
|
|
3929
4005
|
* that is associated with the sending authorization policy that permits you to send for
|
|
3930
4006
|
* the email address specified in the <code>Source</code> parameter.</p>
|
|
3931
|
-
*
|
|
4007
|
+
* <p>For example, if the owner of <code>example.com</code> (which has ARN
|
|
3932
4008
|
* <code>arn:aws:ses:us-east-1:123456789012:identity/example.com</code>) attaches a
|
|
3933
4009
|
* policy to it that authorizes you to send from <code>user@example.com</code>, then you
|
|
3934
4010
|
* would specify the <code>SourceArn</code> to be
|
|
3935
4011
|
* <code>arn:aws:ses:us-east-1:123456789012:identity/example.com</code>, and the
|
|
3936
4012
|
* <code>Source</code> to be <code>user@example.com</code>.</p>
|
|
3937
|
-
*
|
|
3938
|
-
* Guide</a>.</p>
|
|
4013
|
+
* <p>For more information about sending authorization, see the <a href="https://docs.aws.amazon.com/ses/latest/dg/sending-authorization.html">Amazon SES Developer Guide</a>.</p>
|
|
3939
4014
|
*/
|
|
3940
4015
|
SourceArn?: string;
|
|
3941
4016
|
/**
|
|
@@ -3943,14 +4018,13 @@ export interface SendTemplatedEmailRequest {
|
|
|
3943
4018
|
* <p>This parameter is used only for sending authorization. It is the ARN of the identity
|
|
3944
4019
|
* that is associated with the sending authorization policy that permits you to use the
|
|
3945
4020
|
* email address specified in the <code>ReturnPath</code> parameter.</p>
|
|
3946
|
-
*
|
|
4021
|
+
* <p>For example, if the owner of <code>example.com</code> (which has ARN
|
|
3947
4022
|
* <code>arn:aws:ses:us-east-1:123456789012:identity/example.com</code>) attaches a
|
|
3948
4023
|
* policy to it that authorizes you to use <code>feedback@example.com</code>, then you
|
|
3949
4024
|
* would specify the <code>ReturnPathArn</code> to be
|
|
3950
4025
|
* <code>arn:aws:ses:us-east-1:123456789012:identity/example.com</code>, and the
|
|
3951
4026
|
* <code>ReturnPath</code> to be <code>feedback@example.com</code>.</p>
|
|
3952
|
-
*
|
|
3953
|
-
* Guide</a>.</p>
|
|
4027
|
+
* <p>For more information about sending authorization, see the <a href="https://docs.aws.amazon.com/ses/latest/dg/sending-authorization.html">Amazon SES Developer Guide</a>.</p>
|
|
3954
4028
|
*/
|
|
3955
4029
|
ReturnPathArn?: string;
|
|
3956
4030
|
/**
|
|
@@ -3998,7 +4072,8 @@ export interface SendTemplatedEmailResponse {
|
|
|
3998
4072
|
/**
|
|
3999
4073
|
* @public
|
|
4000
4074
|
* <p>Represents a request to set a receipt rule set as the active receipt rule set. You use
|
|
4001
|
-
* receipt rule sets to receive email with Amazon SES. For more information, see the <a href="https://docs.aws.amazon.com/ses/latest/
|
|
4075
|
+
* receipt rule sets to receive email with Amazon SES. For more information, see the <a href="https://docs.aws.amazon.com/ses/latest/dg/receiving-email-concepts.html">Amazon SES
|
|
4076
|
+
* Developer Guide</a>.</p>
|
|
4002
4077
|
*/
|
|
4003
4078
|
export interface SetActiveReceiptRuleSetRequest {
|
|
4004
4079
|
/**
|
|
@@ -4017,7 +4092,8 @@ export interface SetActiveReceiptRuleSetResponse {
|
|
|
4017
4092
|
/**
|
|
4018
4093
|
* @public
|
|
4019
4094
|
* <p>Represents a request to enable or disable Amazon SES Easy DKIM signing for an identity. For
|
|
4020
|
-
* more information about setting up Easy DKIM, see the <a href="https://docs.aws.amazon.com/ses/latest/
|
|
4095
|
+
* more information about setting up Easy DKIM, see the <a href="https://docs.aws.amazon.com/ses/latest/dg/send-email-authentication-dkim-easy.html">Amazon SES Developer
|
|
4096
|
+
* Guide</a>.</p>
|
|
4021
4097
|
*/
|
|
4022
4098
|
export interface SetIdentityDkimEnabledRequest {
|
|
4023
4099
|
/**
|
|
@@ -4042,8 +4118,8 @@ export interface SetIdentityDkimEnabledResponse {
|
|
|
4042
4118
|
* @public
|
|
4043
4119
|
* <p>Represents a request to enable or disable whether Amazon SES forwards you bounce and
|
|
4044
4120
|
* complaint notifications through email. For information about email feedback forwarding,
|
|
4045
|
-
* see the <a href="https://docs.aws.amazon.com/ses/latest/
|
|
4046
|
-
* Guide</a>.</p>
|
|
4121
|
+
* see the <a href="https://docs.aws.amazon.com/ses/latest/dg/monitor-sending-activity-using-notifications-email.html">Amazon SES
|
|
4122
|
+
* Developer Guide</a>.</p>
|
|
4047
4123
|
*/
|
|
4048
4124
|
export interface SetIdentityFeedbackForwardingEnabledRequest {
|
|
4049
4125
|
/**
|
|
@@ -4054,13 +4130,13 @@ export interface SetIdentityFeedbackForwardingEnabledRequest {
|
|
|
4054
4130
|
Identity: string | undefined;
|
|
4055
4131
|
/**
|
|
4056
4132
|
* @public
|
|
4057
|
-
* <p>Sets whether Amazon SES
|
|
4058
|
-
* <code>true</code> specifies that Amazon SES
|
|
4059
|
-
*
|
|
4060
|
-
* <code>false</code> specifies that Amazon SES
|
|
4061
|
-
*
|
|
4062
|
-
*
|
|
4063
|
-
*
|
|
4133
|
+
* <p>Sets whether Amazon SES forwards bounce and complaint notifications as email.
|
|
4134
|
+
* <code>true</code> specifies that Amazon SES forwards bounce and complaint notifications
|
|
4135
|
+
* as email, in addition to any Amazon SNS topic publishing otherwise specified.
|
|
4136
|
+
* <code>false</code> specifies that Amazon SES publishes bounce and complaint notifications
|
|
4137
|
+
* only through Amazon SNS. This value can only be set to <code>false</code> when Amazon SNS topics
|
|
4138
|
+
* are set for both <code>Bounce</code> and <code>Complaint</code> notification
|
|
4139
|
+
* types.</p>
|
|
4064
4140
|
*/
|
|
4065
4141
|
ForwardingEnabled: boolean | undefined;
|
|
4066
4142
|
}
|
|
@@ -4074,8 +4150,8 @@ export interface SetIdentityFeedbackForwardingEnabledResponse {
|
|
|
4074
4150
|
* @public
|
|
4075
4151
|
* <p>Represents a request to set whether Amazon SES includes the original email headers in the
|
|
4076
4152
|
* Amazon SNS notifications of a specified type. For information about notifications, see the
|
|
4077
|
-
* <a href="https://docs.aws.amazon.com/ses/latest/
|
|
4078
|
-
* Guide</a>.</p>
|
|
4153
|
+
* <a href="https://docs.aws.amazon.com/ses/latest/dg/monitor-sending-activity-using-notifications-sns.html">Amazon SES
|
|
4154
|
+
* Developer Guide</a>.</p>
|
|
4079
4155
|
*/
|
|
4080
4156
|
export interface SetIdentityHeadersInNotificationsEnabledRequest {
|
|
4081
4157
|
/**
|
|
@@ -4092,10 +4168,10 @@ export interface SetIdentityHeadersInNotificationsEnabledRequest {
|
|
|
4092
4168
|
/**
|
|
4093
4169
|
* @public
|
|
4094
4170
|
* <p>Sets whether Amazon SES includes the original email headers in Amazon SNS notifications of the
|
|
4095
|
-
* specified notification type. A value of <code>true</code> specifies that Amazon SES
|
|
4096
|
-
*
|
|
4097
|
-
*
|
|
4098
|
-
*
|
|
4171
|
+
* specified notification type. A value of <code>true</code> specifies that Amazon SES includes
|
|
4172
|
+
* headers in notifications, and a value of <code>false</code> specifies that Amazon SES does
|
|
4173
|
+
* not include headers in notifications.</p>
|
|
4174
|
+
* <p>This value can only be set when <code>NotificationType</code> is already set to use a
|
|
4099
4175
|
* particular Amazon SNS topic.</p>
|
|
4100
4176
|
*/
|
|
4101
4177
|
Enabled: boolean | undefined;
|
|
@@ -4110,34 +4186,32 @@ export interface SetIdentityHeadersInNotificationsEnabledResponse {
|
|
|
4110
4186
|
* @public
|
|
4111
4187
|
* <p>Represents a request to enable or disable the Amazon SES custom MAIL FROM domain setup for
|
|
4112
4188
|
* a verified identity. For information about using a custom MAIL FROM domain, see the
|
|
4113
|
-
* <a href="https://docs.aws.amazon.com/ses/latest/
|
|
4114
|
-
*
|
|
4189
|
+
* <a href="https://docs.aws.amazon.com/ses/latest/dg/mail-from.html">Amazon SES Developer
|
|
4190
|
+
* Guide</a>.</p>
|
|
4115
4191
|
*/
|
|
4116
4192
|
export interface SetIdentityMailFromDomainRequest {
|
|
4117
4193
|
/**
|
|
4118
4194
|
* @public
|
|
4119
|
-
* <p>The verified identity
|
|
4120
|
-
* MAIL FROM domain.</p>
|
|
4195
|
+
* <p>The verified identity.</p>
|
|
4121
4196
|
*/
|
|
4122
4197
|
Identity: string | undefined;
|
|
4123
4198
|
/**
|
|
4124
4199
|
* @public
|
|
4125
|
-
* <p>The custom MAIL FROM domain
|
|
4126
|
-
*
|
|
4127
|
-
*
|
|
4128
|
-
*
|
|
4129
|
-
*
|
|
4130
|
-
* FROM setting for the identity.</p>
|
|
4200
|
+
* <p>The custom MAIL FROM domain for the verified identity to use. The MAIL FROM domain
|
|
4201
|
+
* must 1) be a subdomain of the verified identity, 2) not be used in a "From" address if
|
|
4202
|
+
* the MAIL FROM domain is the destination of email feedback forwarding (for more
|
|
4203
|
+
* information, see the <a href="https://docs.aws.amazon.com/ses/latest/dg/mail-from.html">Amazon SES Developer Guide</a>), and 3) not be used to receive emails. A value of
|
|
4204
|
+
* <code>null</code> disables the custom MAIL FROM setting for the identity.</p>
|
|
4131
4205
|
*/
|
|
4132
4206
|
MailFromDomain?: string;
|
|
4133
4207
|
/**
|
|
4134
4208
|
* @public
|
|
4135
|
-
* <p>The action
|
|
4136
|
-
*
|
|
4137
|
-
*
|
|
4138
|
-
* <code>RejectMessage</code>, Amazon SES
|
|
4139
|
-
*
|
|
4140
|
-
*
|
|
4209
|
+
* <p>The action for Amazon SES to take if it cannot successfully read the required MX record
|
|
4210
|
+
* when you send an email. If you choose <code>UseDefaultValue</code>, Amazon SES uses
|
|
4211
|
+
* amazonses.com (or a subdomain of that) as the MAIL FROM domain. If you choose
|
|
4212
|
+
* <code>RejectMessage</code>, Amazon SES returns a <code>MailFromDomainNotVerified</code>
|
|
4213
|
+
* error and not send the email.</p>
|
|
4214
|
+
* <p>The action specified in <code>BehaviorOnMXFailure</code> is taken when the custom MAIL
|
|
4141
4215
|
* FROM domain setup is in the <code>Pending</code>, <code>Failed</code>, and
|
|
4142
4216
|
* <code>TemporaryFailure</code> states.</p>
|
|
4143
4217
|
*/
|
|
@@ -4151,20 +4225,19 @@ export interface SetIdentityMailFromDomainResponse {
|
|
|
4151
4225
|
}
|
|
4152
4226
|
/**
|
|
4153
4227
|
* @public
|
|
4154
|
-
* <p>Represents a request to specify the Amazon SNS topic to which Amazon SES
|
|
4155
|
-
* complaint, or delivery notifications for emails sent with that identity as the
|
|
4156
|
-
* For information about Amazon SES notifications, see the <a href="https://docs.aws.amazon.com/ses/latest/
|
|
4157
|
-
* Guide</a>.</p>
|
|
4228
|
+
* <p>Represents a request to specify the Amazon SNS topic to which Amazon SES publishes bounce,
|
|
4229
|
+
* complaint, or delivery notifications for emails sent with that identity as the source.
|
|
4230
|
+
* For information about Amazon SES notifications, see the <a href="https://docs.aws.amazon.com/ses/latest/dg/monitor-sending-activity-using-notifications-sns.html">Amazon SES
|
|
4231
|
+
* Developer Guide</a>.</p>
|
|
4158
4232
|
*/
|
|
4159
4233
|
export interface SetIdentityNotificationTopicRequest {
|
|
4160
4234
|
/**
|
|
4161
4235
|
* @public
|
|
4162
|
-
* <p>The identity (email address or domain)
|
|
4163
|
-
*
|
|
4164
|
-
* <important>
|
|
4236
|
+
* <p>The identity (email address or domain) for the Amazon SNS topic.</p>
|
|
4237
|
+
* <important>
|
|
4165
4238
|
* <p>You can only specify a verified identity for this parameter.</p>
|
|
4166
|
-
*
|
|
4167
|
-
*
|
|
4239
|
+
* </important>
|
|
4240
|
+
* <p>You can specify an identity by using its name or by using its Amazon Resource Name
|
|
4168
4241
|
* (ARN). The following examples are all valid identities: <code>sender@example.com</code>,
|
|
4169
4242
|
* <code>example.com</code>,
|
|
4170
4243
|
* <code>arn:aws:ses:us-east-1:123456789012:identity/example.com</code>.</p>
|
|
@@ -4172,7 +4245,7 @@ export interface SetIdentityNotificationTopicRequest {
|
|
|
4172
4245
|
Identity: string | undefined;
|
|
4173
4246
|
/**
|
|
4174
4247
|
* @public
|
|
4175
|
-
* <p>The type of notifications that
|
|
4248
|
+
* <p>The type of notifications that are published to the specified Amazon SNS topic.</p>
|
|
4176
4249
|
*/
|
|
4177
4250
|
NotificationType: NotificationType | string | undefined;
|
|
4178
4251
|
/**
|
|
@@ -4192,7 +4265,8 @@ export interface SetIdentityNotificationTopicResponse {
|
|
|
4192
4265
|
/**
|
|
4193
4266
|
* @public
|
|
4194
4267
|
* <p>Represents a request to set the position of a receipt rule in a receipt rule set. You
|
|
4195
|
-
* use receipt rule sets to receive email with Amazon SES. For more information, see the <a href="https://docs.aws.amazon.com/ses/latest/
|
|
4268
|
+
* use receipt rule sets to receive email with Amazon SES. For more information, see the <a href="https://docs.aws.amazon.com/ses/latest/dg/receiving-email-concepts.html">Amazon SES
|
|
4269
|
+
* Developer Guide</a>.</p>
|
|
4196
4270
|
*/
|
|
4197
4271
|
export interface SetReceiptRulePositionRequest {
|
|
4198
4272
|
/**
|
|
@@ -4223,7 +4297,7 @@ export interface SetReceiptRulePositionResponse {
|
|
|
4223
4297
|
export interface TestRenderTemplateRequest {
|
|
4224
4298
|
/**
|
|
4225
4299
|
* @public
|
|
4226
|
-
* <p>The name of the template
|
|
4300
|
+
* <p>The name of the template to render.</p>
|
|
4227
4301
|
*/
|
|
4228
4302
|
TemplateName: string | undefined;
|
|
4229
4303
|
/**
|
|
@@ -4254,7 +4328,7 @@ export interface UpdateAccountSendingEnabledRequest {
|
|
|
4254
4328
|
/**
|
|
4255
4329
|
* @public
|
|
4256
4330
|
* <p>Describes whether email sending is enabled or disabled for your Amazon SES account in the
|
|
4257
|
-
* current
|
|
4331
|
+
* current Amazon Web Services Region.</p>
|
|
4258
4332
|
*/
|
|
4259
4333
|
Enabled?: boolean;
|
|
4260
4334
|
}
|
|
@@ -4262,20 +4336,18 @@ export interface UpdateAccountSendingEnabledRequest {
|
|
|
4262
4336
|
* @public
|
|
4263
4337
|
* <p>Represents a request to update the event destination of a configuration set.
|
|
4264
4338
|
* Configuration sets enable you to publish email sending events. For information about
|
|
4265
|
-
* using configuration sets, see the <a href="https://docs.aws.amazon.com/ses/latest/
|
|
4266
|
-
*
|
|
4339
|
+
* using configuration sets, see the <a href="https://docs.aws.amazon.com/ses/latest/dg/monitor-sending-activity.html">Amazon SES Developer
|
|
4340
|
+
* Guide</a>.</p>
|
|
4267
4341
|
*/
|
|
4268
4342
|
export interface UpdateConfigurationSetEventDestinationRequest {
|
|
4269
4343
|
/**
|
|
4270
4344
|
* @public
|
|
4271
|
-
* <p>The name of the configuration set that contains the event destination
|
|
4272
|
-
* update.</p>
|
|
4345
|
+
* <p>The name of the configuration set that contains the event destination.</p>
|
|
4273
4346
|
*/
|
|
4274
4347
|
ConfigurationSetName: string | undefined;
|
|
4275
4348
|
/**
|
|
4276
4349
|
* @public
|
|
4277
|
-
* <p>The event destination object
|
|
4278
|
-
* set.</p>
|
|
4350
|
+
* <p>The event destination object.</p>
|
|
4279
4351
|
*/
|
|
4280
4352
|
EventDestination: EventDestination | undefined;
|
|
4281
4353
|
}
|
|
@@ -4293,13 +4365,13 @@ export interface UpdateConfigurationSetEventDestinationResponse {
|
|
|
4293
4365
|
export interface UpdateConfigurationSetReputationMetricsEnabledRequest {
|
|
4294
4366
|
/**
|
|
4295
4367
|
* @public
|
|
4296
|
-
* <p>The name of the configuration set
|
|
4368
|
+
* <p>The name of the configuration set to update.</p>
|
|
4297
4369
|
*/
|
|
4298
4370
|
ConfigurationSetName: string | undefined;
|
|
4299
4371
|
/**
|
|
4300
4372
|
* @public
|
|
4301
|
-
* <p>Describes whether or not Amazon SES
|
|
4302
|
-
*
|
|
4373
|
+
* <p>Describes whether or not Amazon SES publishes reputation metrics for the configuration set,
|
|
4374
|
+
* such as bounce and complaint rates, to Amazon CloudWatch.</p>
|
|
4303
4375
|
*/
|
|
4304
4376
|
Enabled: boolean | undefined;
|
|
4305
4377
|
}
|
|
@@ -4311,7 +4383,7 @@ export interface UpdateConfigurationSetReputationMetricsEnabledRequest {
|
|
|
4311
4383
|
export interface UpdateConfigurationSetSendingEnabledRequest {
|
|
4312
4384
|
/**
|
|
4313
4385
|
* @public
|
|
4314
|
-
* <p>The name of the configuration set
|
|
4386
|
+
* <p>The name of the configuration set to update.</p>
|
|
4315
4387
|
*/
|
|
4316
4388
|
ConfigurationSetName: string | undefined;
|
|
4317
4389
|
/**
|
|
@@ -4328,17 +4400,16 @@ export interface UpdateConfigurationSetSendingEnabledRequest {
|
|
|
4328
4400
|
export interface UpdateConfigurationSetTrackingOptionsRequest {
|
|
4329
4401
|
/**
|
|
4330
4402
|
* @public
|
|
4331
|
-
* <p>The name of the configuration set
|
|
4332
|
-
* domain.</p>
|
|
4403
|
+
* <p>The name of the configuration set.</p>
|
|
4333
4404
|
*/
|
|
4334
4405
|
ConfigurationSetName: string | undefined;
|
|
4335
4406
|
/**
|
|
4336
4407
|
* @public
|
|
4337
4408
|
* <p>A domain that is used to redirect email recipients to an Amazon SES-operated domain. This
|
|
4338
4409
|
* domain captures open and click events generated by Amazon SES emails.</p>
|
|
4339
|
-
*
|
|
4340
|
-
*
|
|
4341
|
-
*
|
|
4410
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/ses/latest/dg/configure-custom-open-click-domains.html">Configuring Custom
|
|
4411
|
+
* Domains to Handle Open and Click Tracking</a> in the <i>Amazon SES Developer
|
|
4412
|
+
* Guide</i>.</p>
|
|
4342
4413
|
*/
|
|
4343
4414
|
TrackingOptions: TrackingOptions | undefined;
|
|
4344
4415
|
}
|
|
@@ -4355,7 +4426,7 @@ export interface UpdateConfigurationSetTrackingOptionsResponse {
|
|
|
4355
4426
|
export interface UpdateCustomVerificationEmailTemplateRequest {
|
|
4356
4427
|
/**
|
|
4357
4428
|
* @public
|
|
4358
|
-
* <p>The name of the custom verification email template
|
|
4429
|
+
* <p>The name of the custom verification email template to update.</p>
|
|
4359
4430
|
*/
|
|
4360
4431
|
TemplateName: string | undefined;
|
|
4361
4432
|
/**
|
|
@@ -4372,7 +4443,8 @@ export interface UpdateCustomVerificationEmailTemplateRequest {
|
|
|
4372
4443
|
* @public
|
|
4373
4444
|
* <p>The content of the custom verification email. The total size of the email must be less
|
|
4374
4445
|
* than 10 MB. The message body may contain HTML, with some limitations. For more
|
|
4375
|
-
* information, see <a href="https://docs.aws.amazon.com/ses/latest/
|
|
4446
|
+
* information, see <a href="https://docs.aws.amazon.com/ses/latest/dg/creating-identities.html#send-email-verify-address-custom">Custom
|
|
4447
|
+
* Verification Email Frequently Asked Questions</a> in the <i>Amazon SES
|
|
4376
4448
|
* Developer Guide</i>.</p>
|
|
4377
4449
|
*/
|
|
4378
4450
|
TemplateContent?: string;
|
|
@@ -4392,8 +4464,8 @@ export interface UpdateCustomVerificationEmailTemplateRequest {
|
|
|
4392
4464
|
/**
|
|
4393
4465
|
* @public
|
|
4394
4466
|
* <p>Represents a request to update a receipt rule. You use receipt rules to receive email
|
|
4395
|
-
* with Amazon SES. For more information, see the <a href="https://docs.aws.amazon.com/ses/latest/
|
|
4396
|
-
*
|
|
4467
|
+
* with Amazon SES. For more information, see the <a href="https://docs.aws.amazon.com/ses/latest/dg/receiving-email-concepts.html">Amazon SES Developer
|
|
4468
|
+
* Guide</a>.</p>
|
|
4397
4469
|
*/
|
|
4398
4470
|
export interface UpdateReceiptRuleRequest {
|
|
4399
4471
|
/**
|
|
@@ -4419,8 +4491,8 @@ export interface UpdateReceiptRuleResponse {
|
|
|
4419
4491
|
export interface UpdateTemplateRequest {
|
|
4420
4492
|
/**
|
|
4421
4493
|
* @public
|
|
4422
|
-
* <p>The content of the email, composed of a subject line
|
|
4423
|
-
* part.</p>
|
|
4494
|
+
* <p>The content of the email, composed of a subject line and either an HTML part or a
|
|
4495
|
+
* text-only part.</p>
|
|
4424
4496
|
*/
|
|
4425
4497
|
Template: Template | undefined;
|
|
4426
4498
|
}
|
|
@@ -4432,8 +4504,7 @@ export interface UpdateTemplateResponse {
|
|
|
4432
4504
|
/**
|
|
4433
4505
|
* @public
|
|
4434
4506
|
* <p>Represents a request to generate the CNAME records needed to set up Easy DKIM with
|
|
4435
|
-
* Amazon SES. For more information about setting up Easy DKIM, see the <a href="https://docs.aws.amazon.com/ses/latest/
|
|
4436
|
-
* Guide</a>.</p>
|
|
4507
|
+
* Amazon SES. For more information about setting up Easy DKIM, see the <a href="https://docs.aws.amazon.com/ses/latest/dg/send-email-authentication-dkim-easy.html">Amazon SES Developer Guide</a>.</p>
|
|
4437
4508
|
*/
|
|
4438
4509
|
export interface VerifyDomainDkimRequest {
|
|
4439
4510
|
/**
|
|
@@ -4452,13 +4523,12 @@ export interface VerifyDomainDkimResponse {
|
|
|
4452
4523
|
* @public
|
|
4453
4524
|
* <p>A set of character strings that represent the domain's identity. If the identity is an
|
|
4454
4525
|
* email address, the tokens represent the domain of that address.</p>
|
|
4455
|
-
*
|
|
4526
|
+
* <p>Using these tokens, you need to create DNS CNAME records that point to DKIM public
|
|
4456
4527
|
* keys that are hosted by Amazon SES. Amazon Web Services eventually detects that you've updated your DNS
|
|
4457
4528
|
* records. This detection process might take up to 72 hours. After successful detection,
|
|
4458
4529
|
* Amazon SES is able to DKIM-sign email originating from that domain. (This only applies to
|
|
4459
4530
|
* domain identities, not email address identities.)</p>
|
|
4460
|
-
*
|
|
4461
|
-
* Guide</a>.</p>
|
|
4531
|
+
* <p>For more information about creating DNS records using DKIM tokens, see the <a href="https://docs.aws.amazon.com/ses/latest/dg/send-email-authentication-dkim-easy.html">Amazon SES Developer Guide</a>.</p>
|
|
4462
4532
|
*/
|
|
4463
4533
|
DkimTokens: string[] | undefined;
|
|
4464
4534
|
}
|
|
@@ -4466,8 +4536,8 @@ export interface VerifyDomainDkimResponse {
|
|
|
4466
4536
|
* @public
|
|
4467
4537
|
* <p>Represents a request to begin Amazon SES domain verification and to generate the TXT
|
|
4468
4538
|
* records that you must publish to the DNS server of your domain to complete the
|
|
4469
|
-
* verification. For information about domain verification, see the <a href="https://docs.aws.amazon.com/ses/latest/
|
|
4470
|
-
*
|
|
4539
|
+
* verification. For information about domain verification, see the <a href="https://docs.aws.amazon.com/ses/latest/dg/creating-identities.html#verify-domain-procedure">Amazon SES Developer
|
|
4540
|
+
* Guide</a>.</p>
|
|
4471
4541
|
*/
|
|
4472
4542
|
export interface VerifyDomainIdentityRequest {
|
|
4473
4543
|
/**
|
|
@@ -4486,19 +4556,20 @@ export interface VerifyDomainIdentityResponse {
|
|
|
4486
4556
|
* @public
|
|
4487
4557
|
* <p>A TXT record that you must place in the DNS settings of the domain to complete domain
|
|
4488
4558
|
* verification with Amazon SES.</p>
|
|
4489
|
-
*
|
|
4559
|
+
* <p>As Amazon SES searches for the TXT record, the domain's verification status is "Pending".
|
|
4490
4560
|
* When Amazon SES detects the record, the domain's verification status changes to "Success". If
|
|
4491
4561
|
* Amazon SES is unable to detect the record within 72 hours, the domain's verification status
|
|
4492
|
-
* changes to "Failed." In that case,
|
|
4493
|
-
*
|
|
4562
|
+
* changes to "Failed." In that case, to verify the domain, you must restart the
|
|
4563
|
+
* verification process from the beginning. The domain's verification status also changes
|
|
4564
|
+
* to "Success" when it is DKIM verified.</p>
|
|
4494
4565
|
*/
|
|
4495
4566
|
VerificationToken: string | undefined;
|
|
4496
4567
|
}
|
|
4497
4568
|
/**
|
|
4498
4569
|
* @public
|
|
4499
4570
|
* <p>Represents a request to begin email address verification with Amazon SES. For information
|
|
4500
|
-
* about email address verification, see the <a href="https://docs.aws.amazon.com/ses/latest/
|
|
4501
|
-
* Guide</a>.</p>
|
|
4571
|
+
* about email address verification, see the <a href="https://docs.aws.amazon.com/ses/latest/dg/creating-identities.html#verify-email-addresses-procedure">Amazon SES
|
|
4572
|
+
* Developer Guide</a>.</p>
|
|
4502
4573
|
*/
|
|
4503
4574
|
export interface VerifyEmailAddressRequest {
|
|
4504
4575
|
/**
|
|
@@ -4510,8 +4581,8 @@ export interface VerifyEmailAddressRequest {
|
|
|
4510
4581
|
/**
|
|
4511
4582
|
* @public
|
|
4512
4583
|
* <p>Represents a request to begin email address verification with Amazon SES. For information
|
|
4513
|
-
* about email address verification, see the <a href="https://docs.aws.amazon.com/ses/latest/
|
|
4514
|
-
* Guide</a>.</p>
|
|
4584
|
+
* about email address verification, see the <a href="https://docs.aws.amazon.com/ses/latest/dg/creating-identities.html#verify-email-addresses-procedure">Amazon SES
|
|
4585
|
+
* Developer Guide</a>.</p>
|
|
4515
4586
|
*/
|
|
4516
4587
|
export interface VerifyEmailIdentityRequest {
|
|
4517
4588
|
/**
|