@aws-sdk/client-sesv2 3.933.0 → 3.935.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.
Files changed (79) hide show
  1. package/dist-cjs/index.js +305 -305
  2. package/dist-es/index.js +2 -1
  3. package/dist-es/models/enums.js +293 -0
  4. package/dist-es/models/errors.js +157 -0
  5. package/dist-es/models/models_0.js +1 -442
  6. package/dist-es/models/models_1.js +1 -8
  7. package/dist-es/schemas/schemas_0.js +1 -1
  8. package/dist-types/commands/ListSuppressedDestinationsCommand.d.ts +1 -1
  9. package/dist-types/commands/ListTagsForResourceCommand.d.ts +1 -1
  10. package/dist-types/commands/ListTenantResourcesCommand.d.ts +1 -1
  11. package/dist-types/commands/ListTenantsCommand.d.ts +1 -1
  12. package/dist-types/commands/PutAccountDedicatedIpWarmupAttributesCommand.d.ts +1 -1
  13. package/dist-types/commands/PutAccountDetailsCommand.d.ts +1 -1
  14. package/dist-types/commands/PutAccountSendingAttributesCommand.d.ts +1 -1
  15. package/dist-types/commands/PutAccountSuppressionAttributesCommand.d.ts +1 -1
  16. package/dist-types/commands/PutAccountVdmAttributesCommand.d.ts +1 -1
  17. package/dist-types/commands/PutConfigurationSetArchivingOptionsCommand.d.ts +1 -1
  18. package/dist-types/commands/PutConfigurationSetDeliveryOptionsCommand.d.ts +1 -1
  19. package/dist-types/commands/PutConfigurationSetReputationOptionsCommand.d.ts +1 -1
  20. package/dist-types/commands/PutConfigurationSetSendingOptionsCommand.d.ts +1 -1
  21. package/dist-types/commands/PutConfigurationSetSuppressionOptionsCommand.d.ts +1 -1
  22. package/dist-types/commands/PutConfigurationSetTrackingOptionsCommand.d.ts +1 -1
  23. package/dist-types/commands/PutConfigurationSetVdmOptionsCommand.d.ts +1 -1
  24. package/dist-types/commands/PutDedicatedIpInPoolCommand.d.ts +1 -1
  25. package/dist-types/commands/PutDedicatedIpPoolScalingAttributesCommand.d.ts +1 -1
  26. package/dist-types/commands/PutDedicatedIpWarmupAttributesCommand.d.ts +1 -1
  27. package/dist-types/commands/PutDeliverabilityDashboardOptionCommand.d.ts +1 -1
  28. package/dist-types/commands/PutEmailIdentityConfigurationSetAttributesCommand.d.ts +1 -1
  29. package/dist-types/commands/PutEmailIdentityDkimAttributesCommand.d.ts +1 -1
  30. package/dist-types/commands/PutEmailIdentityDkimSigningAttributesCommand.d.ts +1 -1
  31. package/dist-types/commands/PutEmailIdentityFeedbackAttributesCommand.d.ts +1 -1
  32. package/dist-types/commands/PutEmailIdentityMailFromAttributesCommand.d.ts +1 -1
  33. package/dist-types/commands/PutSuppressedDestinationCommand.d.ts +1 -1
  34. package/dist-types/commands/SendBulkEmailCommand.d.ts +1 -1
  35. package/dist-types/commands/SendCustomVerificationEmailCommand.d.ts +1 -1
  36. package/dist-types/commands/SendEmailCommand.d.ts +2 -1
  37. package/dist-types/index.d.ts +4 -1
  38. package/dist-types/models/enums.d.ts +685 -0
  39. package/dist-types/models/errors.d.ts +160 -0
  40. package/dist-types/models/models_0.d.ts +1195 -822
  41. package/dist-types/models/models_1.d.ts +2 -1218
  42. package/dist-types/ts3.4/commands/ListSuppressedDestinationsCommand.d.ts +1 -1
  43. package/dist-types/ts3.4/commands/ListTagsForResourceCommand.d.ts +1 -1
  44. package/dist-types/ts3.4/commands/ListTenantResourcesCommand.d.ts +1 -1
  45. package/dist-types/ts3.4/commands/ListTenantsCommand.d.ts +1 -1
  46. package/dist-types/ts3.4/commands/PutAccountDedicatedIpWarmupAttributesCommand.d.ts +1 -1
  47. package/dist-types/ts3.4/commands/PutAccountDetailsCommand.d.ts +1 -1
  48. package/dist-types/ts3.4/commands/PutAccountSendingAttributesCommand.d.ts +1 -1
  49. package/dist-types/ts3.4/commands/PutAccountSuppressionAttributesCommand.d.ts +1 -1
  50. package/dist-types/ts3.4/commands/PutAccountVdmAttributesCommand.d.ts +1 -1
  51. package/dist-types/ts3.4/commands/PutConfigurationSetArchivingOptionsCommand.d.ts +1 -1
  52. package/dist-types/ts3.4/commands/PutConfigurationSetDeliveryOptionsCommand.d.ts +1 -1
  53. package/dist-types/ts3.4/commands/PutConfigurationSetReputationOptionsCommand.d.ts +1 -1
  54. package/dist-types/ts3.4/commands/PutConfigurationSetSendingOptionsCommand.d.ts +1 -1
  55. package/dist-types/ts3.4/commands/PutConfigurationSetSuppressionOptionsCommand.d.ts +1 -1
  56. package/dist-types/ts3.4/commands/PutConfigurationSetTrackingOptionsCommand.d.ts +1 -1
  57. package/dist-types/ts3.4/commands/PutConfigurationSetVdmOptionsCommand.d.ts +1 -1
  58. package/dist-types/ts3.4/commands/PutDedicatedIpInPoolCommand.d.ts +1 -1
  59. package/dist-types/ts3.4/commands/PutDedicatedIpPoolScalingAttributesCommand.d.ts +1 -1
  60. package/dist-types/ts3.4/commands/PutDedicatedIpWarmupAttributesCommand.d.ts +1 -1
  61. package/dist-types/ts3.4/commands/PutDeliverabilityDashboardOptionCommand.d.ts +1 -1
  62. package/dist-types/ts3.4/commands/PutEmailIdentityConfigurationSetAttributesCommand.d.ts +1 -1
  63. package/dist-types/ts3.4/commands/PutEmailIdentityDkimAttributesCommand.d.ts +1 -1
  64. package/dist-types/ts3.4/commands/PutEmailIdentityDkimSigningAttributesCommand.d.ts +1 -1
  65. package/dist-types/ts3.4/commands/PutEmailIdentityFeedbackAttributesCommand.d.ts +1 -1
  66. package/dist-types/ts3.4/commands/PutEmailIdentityMailFromAttributesCommand.d.ts +1 -1
  67. package/dist-types/ts3.4/commands/PutSuppressedDestinationCommand.d.ts +1 -1
  68. package/dist-types/ts3.4/commands/SendBulkEmailCommand.d.ts +1 -1
  69. package/dist-types/ts3.4/commands/SendCustomVerificationEmailCommand.d.ts +1 -1
  70. package/dist-types/ts3.4/commands/SendEmailCommand.d.ts +2 -1
  71. package/dist-types/ts3.4/index.d.ts +4 -1
  72. package/dist-types/ts3.4/models/enums.d.ts +374 -0
  73. package/dist-types/ts3.4/models/errors.d.ts +93 -0
  74. package/dist-types/ts3.4/models/models_0.d.ts +257 -456
  75. package/dist-types/ts3.4/models/models_1.d.ts +1 -239
  76. package/package.json +13 -13
  77. package/dist-es/models/index.js +0 -2
  78. package/dist-types/models/index.d.ts +0 -2
  79. package/dist-types/ts3.4/models/index.d.ts +0 -2
@@ -1,1221 +1,5 @@
1
- import { BehaviorOnMxFailure, BulkEmailContent, BulkEmailEntry, BulkEmailEntryResult, ContactLanguage, Destination, DkimSigningAttributes, DkimSigningAttributesOrigin, DkimStatus, DomainDeliverabilityTrackingOption, EmailContent, EmailTemplateContent, EventDestinationDefinition, HttpsPolicy, ListManagementOptions, MailType, MessageTag, ReputationEntityType, ScalingMode, SendingStatus, SuppressionListReason, Tag, TlsPolicy, Topic, TopicPreference, VdmAttributes, VdmOptions } from "./models_0";
2
- /**
3
- * <p>A request to obtain a list of email destinations that are on the suppression list for
4
- * your account.</p>
5
- * @public
6
- */
7
- export interface ListSuppressedDestinationsRequest {
8
- /**
9
- * <p>The factors that caused the email address to be added to .</p>
10
- * @public
11
- */
12
- Reasons?: SuppressionListReason[] | undefined;
13
- /**
14
- * <p>Used to filter the list of suppressed email destinations so that it only includes
15
- * addresses that were added to the list after a specific date.</p>
16
- * @public
17
- */
18
- StartDate?: Date | undefined;
19
- /**
20
- * <p>Used to filter the list of suppressed email destinations so that it only includes
21
- * addresses that were added to the list before a specific date.</p>
22
- * @public
23
- */
24
- EndDate?: Date | undefined;
25
- /**
26
- * <p>A token returned from a previous call to <code>ListSuppressedDestinations</code> to
27
- * indicate the position in the list of suppressed email addresses.</p>
28
- * @public
29
- */
30
- NextToken?: string | undefined;
31
- /**
32
- * <p>The number of results to show in a single call to
33
- * <code>ListSuppressedDestinations</code>. If the number of results is larger than the
34
- * number you specified in this parameter, then the response includes a
35
- * <code>NextToken</code> element, which you can use to obtain additional
36
- * results.</p>
37
- * @public
38
- */
39
- PageSize?: number | undefined;
40
- }
41
- /**
42
- * <p>A summary that describes the suppressed email address.</p>
43
- * @public
44
- */
45
- export interface SuppressedDestinationSummary {
46
- /**
47
- * <p>The email address that's on the suppression list for your account.</p>
48
- * @public
49
- */
50
- EmailAddress: string | undefined;
51
- /**
52
- * <p>The reason that the address was added to the suppression list for your account.</p>
53
- * @public
54
- */
55
- Reason: SuppressionListReason | undefined;
56
- /**
57
- * <p>The date and time when the suppressed destination was last updated, shown in Unix time
58
- * format.</p>
59
- * @public
60
- */
61
- LastUpdateTime: Date | undefined;
62
- }
63
- /**
64
- * <p>A list of suppressed email addresses.</p>
65
- * @public
66
- */
67
- export interface ListSuppressedDestinationsResponse {
68
- /**
69
- * <p>A list of summaries, each containing a summary for a suppressed email
70
- * destination.</p>
71
- * @public
72
- */
73
- SuppressedDestinationSummaries?: SuppressedDestinationSummary[] | undefined;
74
- /**
75
- * <p>A token that indicates that there are additional email addresses on the suppression
76
- * list for your account. To view additional suppressed addresses, issue another request to
77
- * <code>ListSuppressedDestinations</code>, and pass this token in the
78
- * <code>NextToken</code> parameter.</p>
79
- * @public
80
- */
81
- NextToken?: string | undefined;
82
- }
83
- /**
84
- * @public
85
- */
86
- export interface ListTagsForResourceRequest {
87
- /**
88
- * <p>The Amazon Resource Name (ARN) of the resource that you want to retrieve tag
89
- * information for.</p>
90
- * @public
91
- */
92
- ResourceArn: string | undefined;
93
- }
94
- /**
95
- * @public
96
- */
97
- export interface ListTagsForResourceResponse {
98
- /**
99
- * <p>An array that lists all the tags that are associated with the resource. Each tag
100
- * consists of a required tag key (<code>Key</code>) and an associated tag value
101
- * (<code>Value</code>)</p>
102
- * @public
103
- */
104
- Tags: Tag[] | undefined;
105
- }
106
- /**
107
- * @public
108
- * @enum
109
- */
110
- export declare const ListTenantResourcesFilterKey: {
111
- readonly RESOURCE_TYPE: "RESOURCE_TYPE";
112
- };
113
- /**
114
- * @public
115
- */
116
- export type ListTenantResourcesFilterKey = (typeof ListTenantResourcesFilterKey)[keyof typeof ListTenantResourcesFilterKey];
117
- /**
118
- * <p>Represents a request to list resources associated with a specific tenant.</p>
119
- * @public
120
- */
121
- export interface ListTenantResourcesRequest {
122
- /**
123
- * <p>The name of the tenant to list resources for.</p>
124
- * @public
125
- */
126
- TenantName: string | undefined;
127
- /**
128
- * <p>A map of filter keys and values for filtering the list of tenant resources. Currently,
129
- * the only supported filter key is <code>RESOURCE_TYPE</code>.</p>
130
- * @public
131
- */
132
- Filter?: Partial<Record<ListTenantResourcesFilterKey, string>> | undefined;
133
- /**
134
- * <p>The number of results to show in a single call to <code>ListTenantResources</code>.
135
- * If the number of results is larger than the number you specified in this parameter,
136
- * then the response includes a <code>NextToken</code> element, which you can use to obtain additional results.</p>
137
- * @public
138
- */
139
- PageSize?: number | undefined;
140
- /**
141
- * <p>A token returned from a previous call to <code>ListTenantResources</code> to indicate the position in the list of tenant resources.</p>
142
- * @public
143
- */
144
- NextToken?: string | undefined;
145
- }
146
- /**
147
- * @public
148
- * @enum
149
- */
150
- export declare const ResourceType: {
151
- readonly CONFIGURATION_SET: "CONFIGURATION_SET";
152
- readonly EMAIL_IDENTITY: "EMAIL_IDENTITY";
153
- readonly EMAIL_TEMPLATE: "EMAIL_TEMPLATE";
154
- };
155
- /**
156
- * @public
157
- */
158
- export type ResourceType = (typeof ResourceType)[keyof typeof ResourceType];
159
- /**
160
- * <p>A structure that contains information about a resource associated with a tenant.</p>
161
- * @public
162
- */
163
- export interface TenantResource {
164
- /**
165
- * <p>The type of resource associated with the tenant. Valid values are <code>EMAIL_IDENTITY</code>,
166
- * <code>CONFIGURATION_SET</code>, or <code>EMAIL_TEMPLATE</code>.</p>
167
- * @public
168
- */
169
- ResourceType?: ResourceType | undefined;
170
- /**
171
- * <p>The Amazon Resource Name (ARN) of the resource associated with the tenant.</p>
172
- * @public
173
- */
174
- ResourceArn?: string | undefined;
175
- }
176
- /**
177
- * <p>Information about resources associated with a specific tenant.</p>
178
- * @public
179
- */
180
- export interface ListTenantResourcesResponse {
181
- /**
182
- * <p>An array that contains information about each resource associated with the tenant.</p>
183
- * @public
184
- */
185
- TenantResources?: TenantResource[] | undefined;
186
- /**
187
- * <p>A token that indicates that there are additional resources to list. To view additional resources,
188
- * issue another request to <code>ListTenantResources</code>, and pass this token in the <code>NextToken</code> parameter.</p>
189
- * @public
190
- */
191
- NextToken?: string | undefined;
192
- }
193
- /**
194
- * <p>Represents a request to list all tenants associated with your account in the current Amazon Web Services Region.</p>
195
- * @public
196
- */
197
- export interface ListTenantsRequest {
198
- /**
199
- * <p>A token returned from a previous call to <code>ListTenants</code> to indicate the position in the list of tenants.</p>
200
- * @public
201
- */
202
- NextToken?: string | undefined;
203
- /**
204
- * <p>The number of results to show in a single call to <code>ListTenants</code>.
205
- * If the number of results is larger than the number you specified in this parameter,
206
- * then the response includes a <code>NextToken</code> element, which you can use to obtain additional results.</p>
207
- * @public
208
- */
209
- PageSize?: number | undefined;
210
- }
211
- /**
212
- * <p>A structure that contains basic information about a tenant.</p>
213
- * @public
214
- */
215
- export interface TenantInfo {
216
- /**
217
- * <p>The name of the tenant.</p>
218
- * @public
219
- */
220
- TenantName?: string | undefined;
221
- /**
222
- * <p>A unique identifier for the tenant.</p>
223
- * @public
224
- */
225
- TenantId?: string | undefined;
226
- /**
227
- * <p>The Amazon Resource Name (ARN) of the tenant.</p>
228
- * @public
229
- */
230
- TenantArn?: string | undefined;
231
- /**
232
- * <p>The date and time when the tenant was created.</p>
233
- * @public
234
- */
235
- CreatedTimestamp?: Date | undefined;
236
- }
237
- /**
238
- * <p>Information about tenants associated with your account.</p>
239
- * @public
240
- */
241
- export interface ListTenantsResponse {
242
- /**
243
- * <p>An array that contains basic information about each tenant.</p>
244
- * @public
245
- */
246
- Tenants?: TenantInfo[] | undefined;
247
- /**
248
- * <p>A token that indicates that there are additional tenants to list. To view additional tenants,
249
- * issue another request to <code>ListTenants</code>, and pass this token in the <code>NextToken</code> parameter.</p>
250
- * @public
251
- */
252
- NextToken?: string | undefined;
253
- }
254
- /**
255
- * <p>A request to enable or disable the automatic IP address warm-up feature.</p>
256
- * @public
257
- */
258
- export interface PutAccountDedicatedIpWarmupAttributesRequest {
259
- /**
260
- * <p>Enables or disables the automatic warm-up feature for dedicated IP addresses that are
261
- * associated with your Amazon SES account in the current Amazon Web Services Region. Set to <code>true</code>
262
- * to enable the automatic warm-up feature, or set to <code>false</code> to disable
263
- * it.</p>
264
- * @public
265
- */
266
- AutoWarmupEnabled?: boolean | undefined;
267
- }
268
- /**
269
- * <p>An HTTP 200 response if the request succeeds, or an error message if the request
270
- * fails.</p>
271
- * @public
272
- */
273
- export interface PutAccountDedicatedIpWarmupAttributesResponse {
274
- }
275
- /**
276
- * <p>A request to submit new account details.</p>
277
- * @public
278
- */
279
- export interface PutAccountDetailsRequest {
280
- /**
281
- * <p>The type of email your account will send.</p>
282
- * @public
283
- */
284
- MailType: MailType | undefined;
285
- /**
286
- * <p>The URL of your website. This information helps us better understand the type of
287
- * content that you plan to send.</p>
288
- * @public
289
- */
290
- WebsiteURL: string | undefined;
291
- /**
292
- * <p>The language you would prefer to be contacted with.</p>
293
- * @public
294
- */
295
- ContactLanguage?: ContactLanguage | undefined;
296
- /**
297
- * <p>A description of the types of email that you plan to send.</p>
298
- *
299
- * @deprecated Use case description is optional and deprecated
300
- * @public
301
- */
302
- UseCaseDescription?: string | undefined;
303
- /**
304
- * <p>Additional email addresses that you would like to be notified regarding Amazon SES
305
- * matters.</p>
306
- * @public
307
- */
308
- AdditionalContactEmailAddresses?: string[] | undefined;
309
- /**
310
- * <p>Indicates whether or not your account should have production access in the current
311
- * Amazon Web Services Region.</p>
312
- * <p>If the value is <code>false</code>, then your account is in the
313
- * <i>sandbox</i>. When your account is in the sandbox, you can only send
314
- * email to verified identities.
315
- * </p>
316
- * <p>If the value is <code>true</code>, then your account has production access. When your
317
- * account has production access, you can send email to any address. The sending quota and
318
- * maximum sending rate for your account vary based on your specific use case.</p>
319
- * @public
320
- */
321
- ProductionAccessEnabled?: boolean | undefined;
322
- }
323
- /**
324
- * <p>An HTTP 200 response if the request succeeds, or an error message if the request
325
- * fails.</p>
326
- * @public
327
- */
328
- export interface PutAccountDetailsResponse {
329
- }
330
- /**
331
- * <p>A request to change the ability of your account to send email.</p>
332
- * @public
333
- */
334
- export interface PutAccountSendingAttributesRequest {
335
- /**
336
- * <p>Enables or disables your account's ability to send email. Set to <code>true</code> to
337
- * enable email sending, or set to <code>false</code> to disable email sending.</p>
338
- * <note>
339
- * <p>If Amazon Web Services paused your account's ability to send email, you can't use this operation
340
- * to resume your account's ability to send email.</p>
341
- * </note>
342
- * @public
343
- */
344
- SendingEnabled?: boolean | undefined;
345
- }
346
- /**
347
- * <p>An HTTP 200 response if the request succeeds, or an error message if the request
348
- * fails.</p>
349
- * @public
350
- */
351
- export interface PutAccountSendingAttributesResponse {
352
- }
353
- /**
354
- * <p>A request to change your account's suppression preferences.</p>
355
- * @public
356
- */
357
- export interface PutAccountSuppressionAttributesRequest {
358
- /**
359
- * <p>A list that contains the reasons that email addresses will be automatically added to
360
- * the suppression list for your account. This list can contain any or all of the
361
- * following:</p>
362
- * <ul>
363
- * <li>
364
- * <p>
365
- * <code>COMPLAINT</code> – Amazon SES adds an email address to the suppression
366
- * list for your account when a message sent to that address results in a
367
- * complaint.</p>
368
- * </li>
369
- * <li>
370
- * <p>
371
- * <code>BOUNCE</code> – Amazon SES adds an email address to the suppression
372
- * list for your account when a message sent to that address results in a hard
373
- * bounce.</p>
374
- * </li>
375
- * </ul>
376
- * @public
377
- */
378
- SuppressedReasons?: SuppressionListReason[] | undefined;
379
- }
380
- /**
381
- * <p>An HTTP 200 response if the request succeeds, or an error message if the request
382
- * fails.</p>
383
- * @public
384
- */
385
- export interface PutAccountSuppressionAttributesResponse {
386
- }
387
- /**
388
- * <p>A request to submit new account VDM attributes.</p>
389
- * @public
390
- */
391
- export interface PutAccountVdmAttributesRequest {
392
- /**
393
- * <p>The VDM attributes that you wish to apply to your Amazon SES account.</p>
394
- * @public
395
- */
396
- VdmAttributes: VdmAttributes | undefined;
397
- }
398
- /**
399
- * @public
400
- */
401
- export interface PutAccountVdmAttributesResponse {
402
- }
403
- /**
404
- * <p>A request to associate a configuration set with a MailManager archive.</p>
405
- * @public
406
- */
407
- export interface PutConfigurationSetArchivingOptionsRequest {
408
- /**
409
- * <p>The name of the configuration set to associate with a MailManager archive.</p>
410
- * @public
411
- */
412
- ConfigurationSetName: string | undefined;
413
- /**
414
- * <p>The Amazon Resource Name (ARN) of the MailManager archive that the Amazon SES API v2 sends email
415
- * to.</p>
416
- * @public
417
- */
418
- ArchiveArn?: string | undefined;
419
- }
420
- /**
421
- * <p>An HTTP 200 response if the request succeeds, or an error message if the request
422
- * fails.</p>
423
- * @public
424
- */
425
- export interface PutConfigurationSetArchivingOptionsResponse {
426
- }
427
- /**
428
- * <p>A request to associate a configuration set with a dedicated IP pool.</p>
429
- * @public
430
- */
431
- export interface PutConfigurationSetDeliveryOptionsRequest {
432
- /**
433
- * <p>The name of the configuration set to associate with a dedicated IP pool.</p>
434
- * @public
435
- */
436
- ConfigurationSetName: string | undefined;
437
- /**
438
- * <p>Specifies whether messages that use the configuration set are required to use
439
- * Transport Layer Security (TLS). If the value is <code>Require</code>, messages are only
440
- * delivered if a TLS connection can be established. If the value is <code>Optional</code>,
441
- * messages can be delivered in plain text if a TLS connection can't be established.</p>
442
- * @public
443
- */
444
- TlsPolicy?: TlsPolicy | undefined;
445
- /**
446
- * <p>The name of the dedicated IP pool to associate with the configuration set.</p>
447
- * @public
448
- */
449
- SendingPoolName?: string | undefined;
450
- /**
451
- * <p>The maximum amount of time, in seconds, that Amazon SES API v2 will attempt delivery of email.
452
- * If specified, the value must greater than or equal to 300 seconds (5 minutes)
453
- * and less than or equal to 50400 seconds (840 minutes).
454
- * </p>
455
- * @public
456
- */
457
- MaxDeliverySeconds?: number | undefined;
458
- }
459
- /**
460
- * <p>An HTTP 200 response if the request succeeds, or an error message if the request
461
- * fails.</p>
462
- * @public
463
- */
464
- export interface PutConfigurationSetDeliveryOptionsResponse {
465
- }
466
- /**
467
- * <p>A request to enable or disable tracking of reputation metrics for a configuration
468
- * set.</p>
469
- * @public
470
- */
471
- export interface PutConfigurationSetReputationOptionsRequest {
472
- /**
473
- * <p>The name of the configuration set.</p>
474
- * @public
475
- */
476
- ConfigurationSetName: string | undefined;
477
- /**
478
- * <p>If <code>true</code>, tracking of reputation metrics is enabled for the configuration
479
- * set. If <code>false</code>, tracking of reputation metrics is disabled for the
480
- * configuration set.</p>
481
- * @public
482
- */
483
- ReputationMetricsEnabled?: boolean | undefined;
484
- }
485
- /**
486
- * <p>An HTTP 200 response if the request succeeds, or an error message if the request
487
- * fails.</p>
488
- * @public
489
- */
490
- export interface PutConfigurationSetReputationOptionsResponse {
491
- }
492
- /**
493
- * <p>A request to enable or disable the ability of Amazon SES to send emails that use a specific
494
- * configuration set.</p>
495
- * @public
496
- */
497
- export interface PutConfigurationSetSendingOptionsRequest {
498
- /**
499
- * <p>The name of the configuration set to enable or disable email sending for.</p>
500
- * @public
501
- */
502
- ConfigurationSetName: string | undefined;
503
- /**
504
- * <p>If <code>true</code>, email sending is enabled for the configuration set. If
505
- * <code>false</code>, email sending is disabled for the configuration set.</p>
506
- * @public
507
- */
508
- SendingEnabled?: boolean | undefined;
509
- }
510
- /**
511
- * <p>An HTTP 200 response if the request succeeds, or an error message if the request
512
- * fails.</p>
513
- * @public
514
- */
515
- export interface PutConfigurationSetSendingOptionsResponse {
516
- }
517
- /**
518
- * <p>A request to change the account suppression list preferences for a specific
519
- * configuration set.</p>
520
- * @public
521
- */
522
- export interface PutConfigurationSetSuppressionOptionsRequest {
523
- /**
524
- * <p>The name of the configuration set to change the suppression list preferences
525
- * for.</p>
526
- * @public
527
- */
528
- ConfigurationSetName: string | undefined;
529
- /**
530
- * <p>A list that contains the reasons that email addresses are automatically added to the
531
- * suppression list for your account. This list can contain any or all of the
532
- * following:</p>
533
- * <ul>
534
- * <li>
535
- * <p>
536
- * <code>COMPLAINT</code> – Amazon SES adds an email address to the suppression
537
- * list for your account when a message sent to that address results in a
538
- * complaint.</p>
539
- * </li>
540
- * <li>
541
- * <p>
542
- * <code>BOUNCE</code> – Amazon SES adds an email address to the suppression
543
- * list for your account when a message sent to that address results in a hard
544
- * bounce.</p>
545
- * </li>
546
- * </ul>
547
- * @public
548
- */
549
- SuppressedReasons?: SuppressionListReason[] | undefined;
550
- }
551
- /**
552
- * <p>An HTTP 200 response if the request succeeds, or an error message if the request
553
- * fails.</p>
554
- * @public
555
- */
556
- export interface PutConfigurationSetSuppressionOptionsResponse {
557
- }
558
- /**
559
- * <p>A request to add a custom domain for tracking open and click events to a configuration
560
- * set.</p>
561
- * @public
562
- */
563
- export interface PutConfigurationSetTrackingOptionsRequest {
564
- /**
565
- * <p>The name of the configuration set.</p>
566
- * @public
567
- */
568
- ConfigurationSetName: string | undefined;
569
- /**
570
- * <p>The domain to use to track open and click events.</p>
571
- * @public
572
- */
573
- CustomRedirectDomain?: string | undefined;
574
- /**
575
- * <p>The https policy to use for tracking open and click events. If the value is OPTIONAL or HttpsPolicy is not
576
- * specified, the open trackers use HTTP and click tracker use the original protocol of the link.
577
- * If the value is REQUIRE, both open and click tracker uses HTTPS and if the value is REQUIRE_OPEN_ONLY
578
- * open tracker uses HTTPS and link tracker is same as original protocol of the link.
579
- * </p>
580
- * @public
581
- */
582
- HttpsPolicy?: HttpsPolicy | undefined;
583
- }
584
- /**
585
- * <p>An HTTP 200 response if the request succeeds, or an error message if the request
586
- * fails.</p>
587
- * @public
588
- */
589
- export interface PutConfigurationSetTrackingOptionsResponse {
590
- }
591
- /**
592
- * <p>A request to add specific VDM settings to a configuration set.</p>
593
- * @public
594
- */
595
- export interface PutConfigurationSetVdmOptionsRequest {
596
- /**
597
- * <p>The name of the configuration set.</p>
598
- * @public
599
- */
600
- ConfigurationSetName: string | undefined;
601
- /**
602
- * <p>The VDM options to apply to the configuration set.</p>
603
- * @public
604
- */
605
- VdmOptions?: VdmOptions | undefined;
606
- }
607
- /**
608
- * <p>An HTTP 200 response if the request succeeds, or an error message if the request
609
- * fails.</p>
610
- * @public
611
- */
612
- export interface PutConfigurationSetVdmOptionsResponse {
613
- }
614
- /**
615
- * <p>A request to move a dedicated IP address to a dedicated IP pool.</p>
616
- * @public
617
- */
618
- export interface PutDedicatedIpInPoolRequest {
619
- /**
620
- * <p>The IP address that you want to move to the dedicated IP pool. The value you specify
621
- * has to be a dedicated IP address that's associated with your Amazon Web Services account.</p>
622
- * @public
623
- */
624
- Ip: string | undefined;
625
- /**
626
- * <p>The name of the IP pool that you want to add the dedicated IP address to. You have to
627
- * specify an IP pool that already exists.</p>
628
- * @public
629
- */
630
- DestinationPoolName: string | undefined;
631
- }
632
- /**
633
- * <p>An HTTP 200 response if the request succeeds, or an error message if the request
634
- * fails.</p>
635
- * @public
636
- */
637
- export interface PutDedicatedIpInPoolResponse {
638
- }
639
- /**
640
- * <p>A request to convert a dedicated IP pool to a different scaling mode.</p>
641
- * @public
642
- */
643
- export interface PutDedicatedIpPoolScalingAttributesRequest {
644
- /**
645
- * <p>The name of the dedicated IP pool.</p>
646
- * @public
647
- */
648
- PoolName: string | undefined;
649
- /**
650
- * <p>The scaling mode to apply to the dedicated IP pool.</p>
651
- * <note>
652
- * <p>Changing the scaling mode from <code>MANAGED</code> to <code>STANDARD</code> is not supported.</p>
653
- * </note>
654
- * @public
655
- */
656
- ScalingMode: ScalingMode | undefined;
657
- }
658
- /**
659
- * <p>An HTTP 200 response if the request succeeds, or an error message if the request
660
- * fails.</p>
661
- * @public
662
- */
663
- export interface PutDedicatedIpPoolScalingAttributesResponse {
664
- }
665
- /**
666
- * <p>A request to change the warm-up attributes for a dedicated IP address. This operation
667
- * is useful when you want to resume the warm-up process for an existing IP address.</p>
668
- * @public
669
- */
670
- export interface PutDedicatedIpWarmupAttributesRequest {
671
- /**
672
- * <p>The dedicated IP address that you want to update the warm-up attributes for.</p>
673
- * @public
674
- */
675
- Ip: string | undefined;
676
- /**
677
- * <p>The warm-up percentage that you want to associate with the dedicated IP
678
- * address.</p>
679
- * @public
680
- */
681
- WarmupPercentage: number | undefined;
682
- }
683
- /**
684
- * <p>An HTTP 200 response if the request succeeds, or an error message if the request
685
- * fails.</p>
686
- * @public
687
- */
688
- export interface PutDedicatedIpWarmupAttributesResponse {
689
- }
690
- /**
691
- * <p>Enable or disable the Deliverability dashboard. When you enable the Deliverability dashboard, you gain
692
- * access to reputation, deliverability, and other metrics for the domains that you use to
693
- * send email using Amazon SES API v2. You also gain the ability to perform predictive inbox placement tests.</p>
694
- * <p>When you use the Deliverability dashboard, you pay a monthly subscription charge, in addition
695
- * to any other fees that you accrue by using Amazon SES and other Amazon Web Services services. For more
696
- * information about the features and cost of a Deliverability dashboard subscription, see <a href="http://aws.amazon.com/pinpoint/pricing/">Amazon Pinpoint Pricing</a>.</p>
697
- * @public
698
- */
699
- export interface PutDeliverabilityDashboardOptionRequest {
700
- /**
701
- * <p>Specifies whether to enable the Deliverability dashboard. To enable the dashboard, set this
702
- * value to <code>true</code>.</p>
703
- * @public
704
- */
705
- DashboardEnabled: boolean | undefined;
706
- /**
707
- * <p>An array of objects, one for each verified domain that you use to send email and
708
- * enabled the Deliverability dashboard for.</p>
709
- * @public
710
- */
711
- SubscribedDomains?: DomainDeliverabilityTrackingOption[] | undefined;
712
- }
713
- /**
714
- * <p>A response that indicates whether the Deliverability dashboard is enabled.</p>
715
- * @public
716
- */
717
- export interface PutDeliverabilityDashboardOptionResponse {
718
- }
719
- /**
720
- * <p>A request to associate a configuration set with an email identity.</p>
721
- * @public
722
- */
723
- export interface PutEmailIdentityConfigurationSetAttributesRequest {
724
- /**
725
- * <p>The email address or domain to associate with a configuration set.</p>
726
- * @public
727
- */
728
- EmailIdentity: string | undefined;
729
- /**
730
- * <p>The configuration set to associate with an email identity.</p>
731
- * @public
732
- */
733
- ConfigurationSetName?: string | undefined;
734
- }
735
- /**
736
- * <p>If the action is successful, the service sends back an HTTP 200 response with an empty
737
- * HTTP body.</p>
738
- * @public
739
- */
740
- export interface PutEmailIdentityConfigurationSetAttributesResponse {
741
- }
742
- /**
743
- * <p>A request to enable or disable DKIM signing of email that you send from an email
744
- * identity.</p>
745
- * @public
746
- */
747
- export interface PutEmailIdentityDkimAttributesRequest {
748
- /**
749
- * <p>The email identity.</p>
750
- * @public
751
- */
752
- EmailIdentity: string | undefined;
753
- /**
754
- * <p>Sets the DKIM signing configuration for the identity.</p>
755
- * <p>When you set this value <code>true</code>, then the messages that are sent from the
756
- * identity are signed using DKIM. If you set this value to <code>false</code>, your
757
- * messages are sent without DKIM signing.</p>
758
- * @public
759
- */
760
- SigningEnabled?: boolean | undefined;
761
- }
762
- /**
763
- * <p>An HTTP 200 response if the request succeeds, or an error message if the request
764
- * fails.</p>
765
- * @public
766
- */
767
- export interface PutEmailIdentityDkimAttributesResponse {
768
- }
769
- /**
770
- * <p>A request to change the DKIM attributes for an email identity.</p>
771
- * @public
772
- */
773
- export interface PutEmailIdentityDkimSigningAttributesRequest {
774
- /**
775
- * <p>The email identity.</p>
776
- * @public
777
- */
778
- EmailIdentity: string | undefined;
779
- /**
780
- * <p>The method to use to configure DKIM for the identity. There are the following possible
781
- * values:</p>
782
- * <ul>
783
- * <li>
784
- * <p>
785
- * <code>AWS_SES</code> – Configure DKIM for the identity by using <a href="https://docs.aws.amazon.com/ses/latest/DeveloperGuide/easy-dkim.html">Easy
786
- * DKIM</a>.</p>
787
- * </li>
788
- * <li>
789
- * <p>
790
- * <code>EXTERNAL</code> – Configure DKIM for the identity by using Bring
791
- * Your Own DKIM (BYODKIM).</p>
792
- * </li>
793
- * </ul>
794
- * @public
795
- */
796
- SigningAttributesOrigin: DkimSigningAttributesOrigin | undefined;
797
- /**
798
- * <p>An object that contains information about the private key and selector that you want
799
- * to use to configure DKIM for the identity for Bring Your Own DKIM (BYODKIM) for the
800
- * identity, or, configures the key length to be used for <a href="https://docs.aws.amazon.com/ses/latest/DeveloperGuide/easy-dkim.html">Easy DKIM</a>.</p>
801
- * @public
802
- */
803
- SigningAttributes?: DkimSigningAttributes | undefined;
804
- }
805
- /**
806
- * <p>If the action is successful, the service sends back an HTTP 200 response.</p>
807
- * <p>The following data is returned in JSON format by the service.</p>
808
- * @public
809
- */
810
- export interface PutEmailIdentityDkimSigningAttributesResponse {
811
- /**
812
- * <p>The DKIM authentication status of the identity. Amazon SES determines the authentication
813
- * status by searching for specific records in the DNS configuration for your domain. If
814
- * you used <a href="https://docs.aws.amazon.com/ses/latest/DeveloperGuide/easy-dkim.html">Easy
815
- * DKIM</a> to set up DKIM authentication, Amazon SES tries to find three unique CNAME
816
- * records in the DNS configuration for your domain.</p>
817
- * <p>If you provided a public key to perform DKIM authentication, Amazon SES tries to find a TXT
818
- * record that uses the selector that you specified. The value of the TXT record must be a
819
- * public key that's paired with the private key that you specified in the process of
820
- * creating the identity.</p>
821
- * <p>The status can be one of the following:</p>
822
- * <ul>
823
- * <li>
824
- * <p>
825
- * <code>PENDING</code> – The verification process was initiated, but Amazon SES
826
- * hasn't yet detected the DKIM records in the DNS configuration for the
827
- * domain.</p>
828
- * </li>
829
- * <li>
830
- * <p>
831
- * <code>SUCCESS</code> – The verification process completed
832
- * successfully.</p>
833
- * </li>
834
- * <li>
835
- * <p>
836
- * <code>FAILED</code> – The verification process failed. This typically
837
- * occurs when Amazon SES fails to find the DKIM records in the DNS configuration of the
838
- * domain.</p>
839
- * </li>
840
- * <li>
841
- * <p>
842
- * <code>TEMPORARY_FAILURE</code> – A temporary issue is preventing Amazon SES
843
- * from determining the DKIM authentication status of the domain.</p>
844
- * </li>
845
- * <li>
846
- * <p>
847
- * <code>NOT_STARTED</code> – The DKIM verification process hasn't been
848
- * initiated for the domain.</p>
849
- * </li>
850
- * </ul>
851
- * @public
852
- */
853
- DkimStatus?: DkimStatus | undefined;
854
- /**
855
- * <p>If you used <a href="https://docs.aws.amazon.com/ses/latest/DeveloperGuide/easy-dkim.html">Easy DKIM</a> to configure DKIM authentication for the domain, then this object
856
- * contains a set of unique strings that you use to create a set of CNAME records that you
857
- * add to the DNS configuration for your domain. When Amazon SES detects these records in the
858
- * DNS configuration for your domain, the DKIM authentication process is complete.</p>
859
- * <p>If you configured DKIM authentication for the domain by providing your own
860
- * public-private key pair, then this object contains the selector that's associated with
861
- * your public key.</p>
862
- * <p>Regardless of the DKIM authentication method you use, Amazon SES searches for the
863
- * appropriate records in the DNS configuration of the domain for up to 72 hours.</p>
864
- * @public
865
- */
866
- DkimTokens?: string[] | undefined;
867
- }
868
- /**
869
- * <p>A request to set the attributes that control how bounce and complaint events are
870
- * processed.</p>
871
- * @public
872
- */
873
- export interface PutEmailIdentityFeedbackAttributesRequest {
874
- /**
875
- * <p>The email identity.</p>
876
- * @public
877
- */
878
- EmailIdentity: string | undefined;
879
- /**
880
- * <p>Sets the feedback forwarding configuration for the identity.</p>
881
- * <p>If the value is <code>true</code>, you receive email notifications when bounce or
882
- * complaint events occur. These notifications are sent to the address that you specified
883
- * in the <code>Return-Path</code> header of the original email.</p>
884
- * <p>You're required to have a method of tracking bounces and complaints. If you haven't
885
- * set up another mechanism for receiving bounce or complaint notifications (for example,
886
- * by setting up an event destination), you receive an email notification when these events
887
- * occur (even if this setting is disabled).</p>
888
- * @public
889
- */
890
- EmailForwardingEnabled?: boolean | undefined;
891
- }
892
- /**
893
- * <p>An HTTP 200 response if the request succeeds, or an error message if the request
894
- * fails.</p>
895
- * @public
896
- */
897
- export interface PutEmailIdentityFeedbackAttributesResponse {
898
- }
899
- /**
900
- * <p>A request to configure the custom MAIL FROM domain for a verified identity.</p>
901
- * @public
902
- */
903
- export interface PutEmailIdentityMailFromAttributesRequest {
904
- /**
905
- * <p>The verified email identity.</p>
906
- * @public
907
- */
908
- EmailIdentity: string | undefined;
909
- /**
910
- * <p> The custom MAIL FROM domain that you want the verified identity to use. The MAIL FROM
911
- * domain must meet the following criteria:</p>
912
- * <ul>
913
- * <li>
914
- * <p>It has to be a subdomain of the verified identity.</p>
915
- * </li>
916
- * <li>
917
- * <p>It can't be used to receive email.</p>
918
- * </li>
919
- * <li>
920
- * <p>It can't be used in a "From" address if the MAIL FROM domain is a destination
921
- * for feedback forwarding emails.</p>
922
- * </li>
923
- * </ul>
924
- * @public
925
- */
926
- MailFromDomain?: string | undefined;
927
- /**
928
- * <p>The action to take if the required MX record isn't found when you send an email. When
929
- * you set this value to <code>UseDefaultValue</code>, the mail is sent using
930
- * <i>amazonses.com</i> as the MAIL FROM domain. When you set this value
931
- * to <code>RejectMessage</code>, the Amazon SES API v2 returns a
932
- * <code>MailFromDomainNotVerified</code> error, and doesn't attempt to deliver the
933
- * email.</p>
934
- * <p>These behaviors are taken when the custom MAIL FROM domain configuration is in the
935
- * <code>Pending</code>, <code>Failed</code>, and <code>TemporaryFailure</code>
936
- * states.</p>
937
- * @public
938
- */
939
- BehaviorOnMxFailure?: BehaviorOnMxFailure | undefined;
940
- }
941
- /**
942
- * <p>An HTTP 200 response if the request succeeds, or an error message if the request
943
- * fails.</p>
944
- * @public
945
- */
946
- export interface PutEmailIdentityMailFromAttributesResponse {
947
- }
948
- /**
949
- * <p>A request to add an email destination to the suppression list for your account.</p>
950
- * @public
951
- */
952
- export interface PutSuppressedDestinationRequest {
953
- /**
954
- * <p>The email address that should be added to the suppression list for your
955
- * account.</p>
956
- * @public
957
- */
958
- EmailAddress: string | undefined;
959
- /**
960
- * <p>The factors that should cause the email address to be added to the suppression list
961
- * for your account.</p>
962
- * @public
963
- */
964
- Reason: SuppressionListReason | undefined;
965
- }
966
- /**
967
- * <p>An HTTP 200 response if the request succeeds, or an error message if the request
968
- * fails.</p>
969
- * @public
970
- */
971
- export interface PutSuppressedDestinationResponse {
972
- }
973
- /**
974
- * <p>Represents a request to send email messages to multiple destinations using Amazon SES. For
975
- * more information, see the <a href="https://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-personalized-email-api.html">Amazon SES Developer
976
- * Guide</a>.</p>
977
- * @public
978
- */
979
- export interface SendBulkEmailRequest {
980
- /**
981
- * <p>The email address to use as the "From" address for the email. The address that you
982
- * specify has to be verified.</p>
983
- * @public
984
- */
985
- FromEmailAddress?: string | undefined;
986
- /**
987
- * <p>This parameter is used only for sending authorization. It is the ARN of the identity
988
- * that is associated with the sending authorization policy that permits you to use the
989
- * email address specified in the <code>FromEmailAddress</code> parameter.</p>
990
- * <p>For example, if the owner of example.com (which has ARN
991
- * arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it that
992
- * authorizes you to use sender@example.com, then you would specify the
993
- * <code>FromEmailAddressIdentityArn</code> to be
994
- * arn:aws:ses:us-east-1:123456789012:identity/example.com, and the
995
- * <code>FromEmailAddress</code> to be sender@example.com.</p>
996
- * <p>For more information about sending authorization, see the <a href="https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html">Amazon SES Developer
997
- * Guide</a>.</p>
998
- * @public
999
- */
1000
- FromEmailAddressIdentityArn?: string | undefined;
1001
- /**
1002
- * <p>The "Reply-to" email addresses for the message. When the recipient replies to the
1003
- * message, each Reply-to address receives the reply.</p>
1004
- * @public
1005
- */
1006
- ReplyToAddresses?: string[] | undefined;
1007
- /**
1008
- * <p>The address that you want bounce and complaint notifications to be sent to.</p>
1009
- * @public
1010
- */
1011
- FeedbackForwardingEmailAddress?: string | undefined;
1012
- /**
1013
- * <p>This parameter is used only for sending authorization. It is the ARN of the identity
1014
- * that is associated with the sending authorization policy that permits you to use the
1015
- * email address specified in the <code>FeedbackForwardingEmailAddress</code>
1016
- * parameter.</p>
1017
- * <p>For example, if the owner of example.com (which has ARN
1018
- * arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it that
1019
- * authorizes you to use feedback@example.com, then you would specify the
1020
- * <code>FeedbackForwardingEmailAddressIdentityArn</code> to be
1021
- * arn:aws:ses:us-east-1:123456789012:identity/example.com, and the
1022
- * <code>FeedbackForwardingEmailAddress</code> to be feedback@example.com.</p>
1023
- * <p>For more information about sending authorization, see the <a href="https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html">Amazon SES Developer
1024
- * Guide</a>.</p>
1025
- * @public
1026
- */
1027
- FeedbackForwardingEmailAddressIdentityArn?: string | undefined;
1028
- /**
1029
- * <p>A list of tags, in the form of name/value pairs, to apply to an email that you send
1030
- * using the <code>SendEmail</code> operation. Tags correspond to characteristics of the
1031
- * email that you define, so that you can publish email sending events.</p>
1032
- * @public
1033
- */
1034
- DefaultEmailTags?: MessageTag[] | undefined;
1035
- /**
1036
- * <p>An object that contains the body of the message. You can specify a template
1037
- * message.</p>
1038
- * @public
1039
- */
1040
- DefaultContent: BulkEmailContent | undefined;
1041
- /**
1042
- * <p>The list of bulk email entry objects.</p>
1043
- * @public
1044
- */
1045
- BulkEmailEntries: BulkEmailEntry[] | undefined;
1046
- /**
1047
- * <p>The name of the configuration set to use when sending the email.</p>
1048
- * @public
1049
- */
1050
- ConfigurationSetName?: string | undefined;
1051
- /**
1052
- * <p>The ID of the multi-region endpoint (global-endpoint).</p>
1053
- * @public
1054
- */
1055
- EndpointId?: string | undefined;
1056
- /**
1057
- * <p>The name of the tenant through which this bulk email will be sent.</p>
1058
- * <note>
1059
- * <p>
1060
- * The email sending operation will only succeed if all referenced resources
1061
- * (identities, configuration sets, and templates) are associated with this tenant.
1062
- * </p>
1063
- * </note>
1064
- * @public
1065
- */
1066
- TenantName?: string | undefined;
1067
- }
1068
- /**
1069
- * <p>The following data is returned in JSON format by the service.</p>
1070
- * @public
1071
- */
1072
- export interface SendBulkEmailResponse {
1073
- /**
1074
- * <p>One object per intended recipient. Check each response object and retry any messages
1075
- * with a failure status.</p>
1076
- * @public
1077
- */
1078
- BulkEmailEntryResults: BulkEmailEntryResult[] | undefined;
1079
- }
1080
- /**
1081
- * <p>Represents a request to send a custom verification email to a specified
1082
- * recipient.</p>
1083
- * @public
1084
- */
1085
- export interface SendCustomVerificationEmailRequest {
1086
- /**
1087
- * <p>The email address to verify.</p>
1088
- * @public
1089
- */
1090
- EmailAddress: string | undefined;
1091
- /**
1092
- * <p>The name of the custom verification email template to use when sending the
1093
- * verification email.</p>
1094
- * @public
1095
- */
1096
- TemplateName: string | undefined;
1097
- /**
1098
- * <p>Name of a configuration set to use when sending the verification email.</p>
1099
- * @public
1100
- */
1101
- ConfigurationSetName?: string | undefined;
1102
- }
1103
- /**
1104
- * <p>The following element is returned by the service.</p>
1105
- * @public
1106
- */
1107
- export interface SendCustomVerificationEmailResponse {
1108
- /**
1109
- * <p>The unique message identifier returned from the
1110
- * <code>SendCustomVerificationEmail</code> operation.</p>
1111
- * @public
1112
- */
1113
- MessageId?: string | undefined;
1114
- }
1115
- /**
1116
- * <p>Represents a request to send a single formatted email using Amazon SES. For more
1117
- * information, see the <a href="https://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-email-formatted.html">Amazon SES Developer
1118
- * Guide</a>.</p>
1119
- * @public
1120
- */
1121
- export interface SendEmailRequest {
1122
- /**
1123
- * <p>The email address to use as the "From" address for the email. The address that you
1124
- * specify has to be verified.
1125
- * </p>
1126
- * @public
1127
- */
1128
- FromEmailAddress?: string | undefined;
1129
- /**
1130
- * <p>This parameter is used only for sending authorization. It is the ARN of the identity
1131
- * that is associated with the sending authorization policy that permits you to use the
1132
- * email address specified in the <code>FromEmailAddress</code> parameter.</p>
1133
- * <p>For example, if the owner of example.com (which has ARN
1134
- * arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it that
1135
- * authorizes you to use sender@example.com, then you would specify the
1136
- * <code>FromEmailAddressIdentityArn</code> to be
1137
- * arn:aws:ses:us-east-1:123456789012:identity/example.com, and the
1138
- * <code>FromEmailAddress</code> to be sender@example.com.</p>
1139
- * <p>For more information about sending authorization, see the <a href="https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html">Amazon SES Developer
1140
- * Guide</a>.</p>
1141
- * <p>For Raw emails, the <code>FromEmailAddressIdentityArn</code> value overrides the
1142
- * X-SES-SOURCE-ARN and X-SES-FROM-ARN headers specified in raw email message
1143
- * content.</p>
1144
- * @public
1145
- */
1146
- FromEmailAddressIdentityArn?: string | undefined;
1147
- /**
1148
- * <p>An object that contains the recipients of the email message.</p>
1149
- * @public
1150
- */
1151
- Destination?: Destination | undefined;
1152
- /**
1153
- * <p>The "Reply-to" email addresses for the message. When the recipient replies to the
1154
- * message, each Reply-to address receives the reply.</p>
1155
- * @public
1156
- */
1157
- ReplyToAddresses?: string[] | undefined;
1158
- /**
1159
- * <p>The address that you want bounce and complaint notifications to be sent to.</p>
1160
- * @public
1161
- */
1162
- FeedbackForwardingEmailAddress?: string | undefined;
1163
- /**
1164
- * <p>This parameter is used only for sending authorization. It is the ARN of the identity
1165
- * that is associated with the sending authorization policy that permits you to use the
1166
- * email address specified in the <code>FeedbackForwardingEmailAddress</code>
1167
- * parameter.</p>
1168
- * <p>For example, if the owner of example.com (which has ARN
1169
- * arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it that
1170
- * authorizes you to use feedback@example.com, then you would specify the
1171
- * <code>FeedbackForwardingEmailAddressIdentityArn</code> to be
1172
- * arn:aws:ses:us-east-1:123456789012:identity/example.com, and the
1173
- * <code>FeedbackForwardingEmailAddress</code> to be feedback@example.com.</p>
1174
- * <p>For more information about sending authorization, see the <a href="https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html">Amazon SES Developer
1175
- * Guide</a>.</p>
1176
- * @public
1177
- */
1178
- FeedbackForwardingEmailAddressIdentityArn?: string | undefined;
1179
- /**
1180
- * <p>An object that contains the body of the message. You can send either a Simple message,
1181
- * Raw message, or a Templated message.</p>
1182
- * @public
1183
- */
1184
- Content: EmailContent | undefined;
1185
- /**
1186
- * <p>A list of tags, in the form of name/value pairs, to apply to an email that you send
1187
- * using the <code>SendEmail</code> operation. Tags correspond to characteristics of the
1188
- * email that you define, so that you can publish email sending events. </p>
1189
- * @public
1190
- */
1191
- EmailTags?: MessageTag[] | undefined;
1192
- /**
1193
- * <p>The name of the configuration set to use when sending the email.</p>
1194
- * @public
1195
- */
1196
- ConfigurationSetName?: string | undefined;
1197
- /**
1198
- * <p>The ID of the multi-region endpoint (global-endpoint).</p>
1199
- * @public
1200
- */
1201
- EndpointId?: string | undefined;
1202
- /**
1203
- * <p>The name of the tenant through which this email will be sent.</p>
1204
- * <note>
1205
- * <p>The email sending operation will only succeed if all referenced resources
1206
- * (identities, configuration sets, and templates) are associated with this tenant.
1207
- * </p>
1208
- * </note>
1209
- * @public
1210
- */
1211
- TenantName?: string | undefined;
1212
- /**
1213
- * <p>An object used to specify a list or topic to which an email belongs, which will be
1214
- * used when a contact chooses to unsubscribe.</p>
1215
- * @public
1216
- */
1217
- ListManagementOptions?: ListManagementOptions | undefined;
1218
- }
1
+ import { ReputationEntityType, SendingStatus } from "./enums";
2
+ import { EmailTemplateContent, EventDestinationDefinition, Tag, Topic, TopicPreference } from "./models_0";
1219
3
  /**
1220
4
  * <p>A unique message ID that you receive when an email is accepted for sending.</p>
1221
5
  * @public