@aws-sdk/client-sesv2 3.395.0 → 3.402.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 +40 -0
- package/dist-cjs/SESv2.js +10 -0
- package/dist-cjs/commands/CancelExportJobCommand.js +46 -0
- package/dist-cjs/commands/CreateExportJobCommand.js +47 -0
- package/dist-cjs/commands/GetExportJobCommand.js +47 -0
- package/dist-cjs/commands/GetMessageInsightsCommand.js +47 -0
- package/dist-cjs/commands/ListExportJobsCommand.js +46 -0
- package/dist-cjs/commands/index.js +5 -0
- package/dist-cjs/endpoint/ruleset.js +1 -1
- package/dist-cjs/models/index.js +1 -0
- package/dist-cjs/models/models_0.js +76 -8
- package/dist-cjs/models/models_1.js +2 -0
- package/dist-cjs/pagination/ListExportJobsPaginator.js +29 -0
- package/dist-cjs/pagination/index.js +1 -0
- package/dist-cjs/protocols/Aws_restJson1.js +405 -4
- package/dist-cjs/runtimeExtensions.js +5 -5
- package/dist-es/SESv2.js +10 -0
- package/dist-es/commands/CancelExportJobCommand.js +42 -0
- package/dist-es/commands/CreateExportJobCommand.js +43 -0
- package/dist-es/commands/GetExportJobCommand.js +43 -0
- package/dist-es/commands/GetMessageInsightsCommand.js +43 -0
- package/dist-es/commands/ListExportJobsCommand.js +42 -0
- package/dist-es/commands/index.js +5 -0
- package/dist-es/endpoint/ruleset.js +1 -1
- package/dist-es/models/index.js +1 -0
- package/dist-es/models/models_0.js +67 -6
- package/dist-es/models/models_1.js +1 -0
- package/dist-es/pagination/ListExportJobsPaginator.js +25 -0
- package/dist-es/pagination/index.js +1 -0
- package/dist-es/protocols/Aws_restJson1.js +391 -0
- package/dist-es/runtimeExtensions.js +5 -5
- package/dist-types/SESv2.d.ts +35 -0
- package/dist-types/SESv2Client.d.ts +7 -2
- package/dist-types/commands/CancelExportJobCommand.d.ts +80 -0
- package/dist-types/commands/CreateExportJobCommand.d.ts +152 -0
- package/dist-types/commands/GetExportJobCommand.d.ts +161 -0
- package/dist-types/commands/GetImportJobCommand.d.ts +1 -1
- package/dist-types/commands/GetMessageInsightsCommand.d.ts +115 -0
- package/dist-types/commands/ListExportJobsCommand.d.ts +91 -0
- package/dist-types/commands/ListImportJobsCommand.d.ts +1 -1
- package/dist-types/commands/PutSuppressedDestinationCommand.d.ts +2 -1
- package/dist-types/commands/SendBulkEmailCommand.d.ts +1 -1
- package/dist-types/commands/SendCustomVerificationEmailCommand.d.ts +1 -1
- package/dist-types/commands/SendEmailCommand.d.ts +1 -1
- package/dist-types/commands/TagResourceCommand.d.ts +1 -1
- package/dist-types/commands/TestRenderEmailTemplateCommand.d.ts +1 -1
- package/dist-types/commands/UntagResourceCommand.d.ts +1 -1
- package/dist-types/commands/UpdateConfigurationSetEventDestinationCommand.d.ts +1 -1
- package/dist-types/commands/UpdateContactCommand.d.ts +1 -1
- package/dist-types/commands/UpdateContactListCommand.d.ts +1 -1
- package/dist-types/commands/UpdateCustomVerificationEmailTemplateCommand.d.ts +1 -1
- package/dist-types/commands/UpdateEmailIdentityPolicyCommand.d.ts +1 -1
- package/dist-types/commands/UpdateEmailTemplateCommand.d.ts +1 -1
- package/dist-types/commands/index.d.ts +5 -0
- package/dist-types/extensionConfiguration.d.ts +6 -0
- package/dist-types/models/index.d.ts +1 -0
- package/dist-types/models/models_0.d.ts +811 -558
- package/dist-types/models/models_1.d.ts +523 -0
- package/dist-types/pagination/ListExportJobsPaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +1 -0
- package/dist-types/protocols/Aws_restJson1.d.ts +45 -0
- package/dist-types/runtimeExtensions.d.ts +2 -2
- package/dist-types/ts3.4/SESv2.d.ts +85 -0
- package/dist-types/ts3.4/SESv2Client.d.ts +30 -0
- package/dist-types/ts3.4/commands/CancelExportJobCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/CreateExportJobCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/GetExportJobCommand.d.ts +35 -0
- package/dist-types/ts3.4/commands/GetMessageInsightsCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/ListExportJobsCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/PutSuppressedDestinationCommand.d.ts +2 -4
- package/dist-types/ts3.4/commands/SendBulkEmailCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/SendCustomVerificationEmailCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/SendEmailCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/TestRenderEmailTemplateCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateConfigurationSetEventDestinationCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateContactCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateContactListCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateCustomVerificationEmailTemplateCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateEmailIdentityPolicyCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateEmailTemplateCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/index.d.ts +5 -0
- package/dist-types/ts3.4/extensionConfiguration.d.ts +3 -0
- package/dist-types/ts3.4/models/index.d.ts +1 -0
- package/dist-types/ts3.4/models/models_0.d.ts +176 -102
- package/dist-types/ts3.4/models/models_1.d.ts +109 -0
- package/dist-types/ts3.4/pagination/ListExportJobsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +1 -0
- package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +60 -0
- package/dist-types/ts3.4/runtimeExtensions.d.ts +2 -2
- package/package.json +29 -29
- package/dist-types/clientConfiguration.d.ts +0 -6
- package/dist-types/ts3.4/clientConfiguration.d.ts +0 -2
- /package/dist-cjs/{clientConfiguration.js → extensionConfiguration.js} +0 -0
- /package/dist-es/{clientConfiguration.js → extensionConfiguration.js} +0 -0
|
@@ -514,6 +514,45 @@ export interface Body {
|
|
|
514
514
|
*/
|
|
515
515
|
Html?: Content;
|
|
516
516
|
}
|
|
517
|
+
/**
|
|
518
|
+
* @public
|
|
519
|
+
* @enum
|
|
520
|
+
*/
|
|
521
|
+
export declare const BounceType: {
|
|
522
|
+
readonly PERMANENT: "PERMANENT";
|
|
523
|
+
readonly TRANSIENT: "TRANSIENT";
|
|
524
|
+
readonly UNDETERMINED: "UNDETERMINED";
|
|
525
|
+
};
|
|
526
|
+
/**
|
|
527
|
+
* @public
|
|
528
|
+
*/
|
|
529
|
+
export type BounceType = (typeof BounceType)[keyof typeof BounceType];
|
|
530
|
+
/**
|
|
531
|
+
* @public
|
|
532
|
+
* <p>Information about a <code>Bounce</code> event.</p>
|
|
533
|
+
*/
|
|
534
|
+
export interface Bounce {
|
|
535
|
+
/**
|
|
536
|
+
* @public
|
|
537
|
+
* <p>The type of the bounce, as determined by SES.
|
|
538
|
+
* Can be one of <code>UNDETERMINED</code>, <code>TRANSIENT</code>, or <code>PERMANENT</code>
|
|
539
|
+
* </p>
|
|
540
|
+
*/
|
|
541
|
+
BounceType?: BounceType | string;
|
|
542
|
+
/**
|
|
543
|
+
* @public
|
|
544
|
+
* <p>The subtype of the bounce, as determined by SES.</p>
|
|
545
|
+
*/
|
|
546
|
+
BounceSubType?: string;
|
|
547
|
+
/**
|
|
548
|
+
* @public
|
|
549
|
+
* <p>The status code issued by the reporting Message Transfer Authority (MTA).
|
|
550
|
+
* This field only appears if a delivery status notification (DSN) was attached to the bounce
|
|
551
|
+
* and the <code>Diagnostic-Code</code> was provided in the DSN.
|
|
552
|
+
* </p>
|
|
553
|
+
*/
|
|
554
|
+
DiagnosticCode?: string;
|
|
555
|
+
}
|
|
517
556
|
/**
|
|
518
557
|
* @public
|
|
519
558
|
* <p>An object that defines the email template to use for an email message, and the values
|
|
@@ -793,6 +832,24 @@ export interface BulkEmailEntryResult {
|
|
|
793
832
|
*/
|
|
794
833
|
MessageId?: string;
|
|
795
834
|
}
|
|
835
|
+
/**
|
|
836
|
+
* @public
|
|
837
|
+
* <p>Represents a request to cancel an export job using the export job ID.</p>
|
|
838
|
+
*/
|
|
839
|
+
export interface CancelExportJobRequest {
|
|
840
|
+
/**
|
|
841
|
+
* @public
|
|
842
|
+
* <p>The export job ID.</p>
|
|
843
|
+
*/
|
|
844
|
+
JobId: string | undefined;
|
|
845
|
+
}
|
|
846
|
+
/**
|
|
847
|
+
* @public
|
|
848
|
+
* <p>An HTTP 200 response if the request succeeds, or an error message if the request
|
|
849
|
+
* fails.</p>
|
|
850
|
+
*/
|
|
851
|
+
export interface CancelExportJobResponse {
|
|
852
|
+
}
|
|
796
853
|
/**
|
|
797
854
|
* @public
|
|
798
855
|
* @enum
|
|
@@ -866,6 +923,28 @@ export interface CloudWatchDestination {
|
|
|
866
923
|
*/
|
|
867
924
|
DimensionConfigurations: CloudWatchDimensionConfiguration[] | undefined;
|
|
868
925
|
}
|
|
926
|
+
/**
|
|
927
|
+
* @public
|
|
928
|
+
* <p>Information about a <code>Complaint</code> event.</p>
|
|
929
|
+
*/
|
|
930
|
+
export interface Complaint {
|
|
931
|
+
/**
|
|
932
|
+
* @public
|
|
933
|
+
* <p>
|
|
934
|
+
* Can either be <code>null</code> or <code>OnAccountSuppressionList</code>.
|
|
935
|
+
* If the value is <code>OnAccountSuppressionList</code>, SES accepted the message,
|
|
936
|
+
* but didn't attempt to send it because it was on the account-level suppression list.
|
|
937
|
+
* </p>
|
|
938
|
+
*/
|
|
939
|
+
ComplaintSubType?: string;
|
|
940
|
+
/**
|
|
941
|
+
* @public
|
|
942
|
+
* <p>
|
|
943
|
+
* The value of the <code>Feedback-Type</code> field from the feedback report received from the ISP.
|
|
944
|
+
* </p>
|
|
945
|
+
*/
|
|
946
|
+
ComplaintFeedbackType?: string;
|
|
947
|
+
}
|
|
869
948
|
/**
|
|
870
949
|
* @public
|
|
871
950
|
* <p>The resource is being modified by another operation or thread.</p>
|
|
@@ -2196,6 +2275,275 @@ export interface CreateEmailTemplateRequest {
|
|
|
2196
2275
|
*/
|
|
2197
2276
|
export interface CreateEmailTemplateResponse {
|
|
2198
2277
|
}
|
|
2278
|
+
/**
|
|
2279
|
+
* @public
|
|
2280
|
+
* @enum
|
|
2281
|
+
*/
|
|
2282
|
+
export declare const DeliveryEventType: {
|
|
2283
|
+
readonly COMPLAINT: "COMPLAINT";
|
|
2284
|
+
readonly DELIVERY: "DELIVERY";
|
|
2285
|
+
readonly PERMANENT_BOUNCE: "PERMANENT_BOUNCE";
|
|
2286
|
+
readonly SEND: "SEND";
|
|
2287
|
+
readonly TRANSIENT_BOUNCE: "TRANSIENT_BOUNCE";
|
|
2288
|
+
readonly UNDETERMINED_BOUNCE: "UNDETERMINED_BOUNCE";
|
|
2289
|
+
};
|
|
2290
|
+
/**
|
|
2291
|
+
* @public
|
|
2292
|
+
*/
|
|
2293
|
+
export type DeliveryEventType = (typeof DeliveryEventType)[keyof typeof DeliveryEventType];
|
|
2294
|
+
/**
|
|
2295
|
+
* @public
|
|
2296
|
+
* @enum
|
|
2297
|
+
*/
|
|
2298
|
+
export declare const EngagementEventType: {
|
|
2299
|
+
readonly CLICK: "CLICK";
|
|
2300
|
+
readonly OPEN: "OPEN";
|
|
2301
|
+
};
|
|
2302
|
+
/**
|
|
2303
|
+
* @public
|
|
2304
|
+
*/
|
|
2305
|
+
export type EngagementEventType = (typeof EngagementEventType)[keyof typeof EngagementEventType];
|
|
2306
|
+
/**
|
|
2307
|
+
* @public
|
|
2308
|
+
* <p>An object containing Message Insights filters.</p>
|
|
2309
|
+
* <p>If you specify multiple filters, the filters are joined by AND.</p>
|
|
2310
|
+
* <p>If you specify multiple values for a filter, the values are joined by OR. Filter values are case-sensitive.</p>
|
|
2311
|
+
* <p>
|
|
2312
|
+
* <code>FromEmailAddress</code>, <code>Destination</code>, and <code>Subject</code> filters support partial match.
|
|
2313
|
+
* A partial match is performed by using the <code>*</code> wildcard character placed at the beginning (suffix match), the end (prefix match)
|
|
2314
|
+
* or both ends of the string (contains match).
|
|
2315
|
+
* In order to match the literal characters <code>*</code> or <code>\</code>, they must be escaped using the <code>\</code> character.
|
|
2316
|
+
* If no wildcard character is present, an exact match is performed.
|
|
2317
|
+
* </p>
|
|
2318
|
+
*/
|
|
2319
|
+
export interface MessageInsightsFilters {
|
|
2320
|
+
/**
|
|
2321
|
+
* @public
|
|
2322
|
+
* <p>The from address used to send the message.</p>
|
|
2323
|
+
*/
|
|
2324
|
+
FromEmailAddress?: string[];
|
|
2325
|
+
/**
|
|
2326
|
+
* @public
|
|
2327
|
+
* <p>The recipient's email address.</p>
|
|
2328
|
+
*/
|
|
2329
|
+
Destination?: string[];
|
|
2330
|
+
/**
|
|
2331
|
+
* @public
|
|
2332
|
+
* <p>The subject line of the message.</p>
|
|
2333
|
+
*/
|
|
2334
|
+
Subject?: string[];
|
|
2335
|
+
/**
|
|
2336
|
+
* @public
|
|
2337
|
+
* <p>The recipient's ISP (e.g., <code>Gmail</code>, <code>Yahoo</code>,
|
|
2338
|
+
* etc.).</p>
|
|
2339
|
+
*/
|
|
2340
|
+
Isp?: string[];
|
|
2341
|
+
/**
|
|
2342
|
+
* @public
|
|
2343
|
+
* <p>
|
|
2344
|
+
* The last delivery-related event for the email, where the ordering is as follows:
|
|
2345
|
+
* <code>SEND</code> < <code>BOUNCE</code> < <code>DELIVERY</code> < <code>COMPLAINT</code>.
|
|
2346
|
+
* </p>
|
|
2347
|
+
*/
|
|
2348
|
+
LastDeliveryEvent?: (DeliveryEventType | string)[];
|
|
2349
|
+
/**
|
|
2350
|
+
* @public
|
|
2351
|
+
* <p>
|
|
2352
|
+
* The last engagement-related event for the email, where the ordering is as follows:
|
|
2353
|
+
* <code>OPEN</code> < <code>CLICK</code>.
|
|
2354
|
+
* </p>
|
|
2355
|
+
* <p>
|
|
2356
|
+
* Engagement events are only available if <a href="https://docs.aws.amazon.com/ses/latest/dg/vdm-settings.html">Engagement tracking</a>
|
|
2357
|
+
* is enabled.
|
|
2358
|
+
* </p>
|
|
2359
|
+
*/
|
|
2360
|
+
LastEngagementEvent?: (EngagementEventType | string)[];
|
|
2361
|
+
}
|
|
2362
|
+
/**
|
|
2363
|
+
* @public
|
|
2364
|
+
* <p>An object that contains filters applied when performing the Message Insights export.</p>
|
|
2365
|
+
*/
|
|
2366
|
+
export interface MessageInsightsDataSource {
|
|
2367
|
+
/**
|
|
2368
|
+
* @public
|
|
2369
|
+
* <p>Represents the start date for the export interval as a timestamp. The start date is inclusive.</p>
|
|
2370
|
+
*/
|
|
2371
|
+
StartDate: Date | undefined;
|
|
2372
|
+
/**
|
|
2373
|
+
* @public
|
|
2374
|
+
* <p>Represents the end date for the export interval as a timestamp. The end date is inclusive.</p>
|
|
2375
|
+
*/
|
|
2376
|
+
EndDate: Date | undefined;
|
|
2377
|
+
/**
|
|
2378
|
+
* @public
|
|
2379
|
+
* <p>Filters for results to be included in the export file.</p>
|
|
2380
|
+
*/
|
|
2381
|
+
Include?: MessageInsightsFilters;
|
|
2382
|
+
/**
|
|
2383
|
+
* @public
|
|
2384
|
+
* <p>Filters for results to be excluded from the export file.</p>
|
|
2385
|
+
*/
|
|
2386
|
+
Exclude?: MessageInsightsFilters;
|
|
2387
|
+
/**
|
|
2388
|
+
* @public
|
|
2389
|
+
* <p>The maximum number of results.</p>
|
|
2390
|
+
*/
|
|
2391
|
+
MaxResults?: number;
|
|
2392
|
+
}
|
|
2393
|
+
/**
|
|
2394
|
+
* @public
|
|
2395
|
+
* @enum
|
|
2396
|
+
*/
|
|
2397
|
+
export declare const MetricAggregation: {
|
|
2398
|
+
readonly RATE: "RATE";
|
|
2399
|
+
readonly VOLUME: "VOLUME";
|
|
2400
|
+
};
|
|
2401
|
+
/**
|
|
2402
|
+
* @public
|
|
2403
|
+
*/
|
|
2404
|
+
export type MetricAggregation = (typeof MetricAggregation)[keyof typeof MetricAggregation];
|
|
2405
|
+
/**
|
|
2406
|
+
* @public
|
|
2407
|
+
* <p>An object that contains a mapping between a <code>Metric</code> and
|
|
2408
|
+
* <code>MetricAggregation</code>.</p>
|
|
2409
|
+
*/
|
|
2410
|
+
export interface ExportMetric {
|
|
2411
|
+
/**
|
|
2412
|
+
* @public
|
|
2413
|
+
* <p>The metric to export, can be one of the following:</p>
|
|
2414
|
+
* <ul>
|
|
2415
|
+
* <li>
|
|
2416
|
+
* <p>
|
|
2417
|
+
* <code>SEND</code> - Emails sent eligible for tracking in the VDM
|
|
2418
|
+
* dashboard. This excludes emails sent to the mailbox simulator and emails
|
|
2419
|
+
* addressed to more than one recipient.</p>
|
|
2420
|
+
* </li>
|
|
2421
|
+
* <li>
|
|
2422
|
+
* <p>
|
|
2423
|
+
* <code>COMPLAINT</code> - Complaints received for your account. This
|
|
2424
|
+
* excludes complaints from the mailbox simulator, those originating from your
|
|
2425
|
+
* account-level suppression list (if enabled), and those for emails addressed to
|
|
2426
|
+
* more than one recipient</p>
|
|
2427
|
+
* </li>
|
|
2428
|
+
* <li>
|
|
2429
|
+
* <p>
|
|
2430
|
+
* <code>PERMANENT_BOUNCE</code> - Permanent bounces - i.e., feedback
|
|
2431
|
+
* received for emails sent to non-existent mailboxes. Excludes bounces from the
|
|
2432
|
+
* mailbox simulator, those originating from your account-level suppression list
|
|
2433
|
+
* (if enabled), and those for emails addressed to more than one recipient.</p>
|
|
2434
|
+
* </li>
|
|
2435
|
+
* <li>
|
|
2436
|
+
* <p>
|
|
2437
|
+
* <code>TRANSIENT_BOUNCE</code> - Transient bounces - i.e., feedback
|
|
2438
|
+
* received for delivery failures excluding issues with non-existent mailboxes.
|
|
2439
|
+
* Excludes bounces from the mailbox simulator, and those for emails addressed to
|
|
2440
|
+
* more than one recipient.</p>
|
|
2441
|
+
* </li>
|
|
2442
|
+
* <li>
|
|
2443
|
+
* <p>
|
|
2444
|
+
* <code>OPEN</code> - Unique open events for emails including open
|
|
2445
|
+
* trackers. Excludes opens for emails addressed to more than one recipient.</p>
|
|
2446
|
+
* </li>
|
|
2447
|
+
* <li>
|
|
2448
|
+
* <p>
|
|
2449
|
+
* <code>CLICK</code> - Unique click events for emails including wrapped
|
|
2450
|
+
* links. Excludes clicks for emails addressed to more than one recipient.</p>
|
|
2451
|
+
* </li>
|
|
2452
|
+
* <li>
|
|
2453
|
+
* <p>
|
|
2454
|
+
* <code>DELIVERY</code> - Successful deliveries for email sending
|
|
2455
|
+
* attempts. Excludes deliveries to the mailbox simulator and for emails addressed
|
|
2456
|
+
* to more than one recipient.</p>
|
|
2457
|
+
* </li>
|
|
2458
|
+
* <li>
|
|
2459
|
+
* <p>
|
|
2460
|
+
* <code>DELIVERY_OPEN</code> - Successful deliveries for email sending
|
|
2461
|
+
* attempts. Excludes deliveries to the mailbox simulator, for emails addressed to
|
|
2462
|
+
* more than one recipient, and emails without open trackers.</p>
|
|
2463
|
+
* </li>
|
|
2464
|
+
* <li>
|
|
2465
|
+
* <p>
|
|
2466
|
+
* <code>DELIVERY_CLICK</code> - Successful deliveries for email sending
|
|
2467
|
+
* attempts. Excludes deliveries to the mailbox simulator, for emails addressed to
|
|
2468
|
+
* more than one recipient, and emails without click trackers.</p>
|
|
2469
|
+
* </li>
|
|
2470
|
+
* <li>
|
|
2471
|
+
* <p>
|
|
2472
|
+
* <code>DELIVERY_COMPLAINT</code> - Successful deliveries for email
|
|
2473
|
+
* sending attempts. Excludes deliveries to the mailbox simulator, for emails
|
|
2474
|
+
* addressed to more than one recipient, and emails addressed to recipients hosted
|
|
2475
|
+
* by ISPs with which Amazon SES does not have a feedback loop agreement.</p>
|
|
2476
|
+
* </li>
|
|
2477
|
+
* </ul>
|
|
2478
|
+
*/
|
|
2479
|
+
Name?: Metric | string;
|
|
2480
|
+
/**
|
|
2481
|
+
* @public
|
|
2482
|
+
* <p>The aggregation to apply to a metric, can be one of the following:</p>
|
|
2483
|
+
* <ul>
|
|
2484
|
+
* <li>
|
|
2485
|
+
* <p>
|
|
2486
|
+
* <code>VOLUME</code> - The volume of events for this metric.</p>
|
|
2487
|
+
* </li>
|
|
2488
|
+
* <li>
|
|
2489
|
+
* <p>
|
|
2490
|
+
* <code>RATE</code> - The rate for this metric relative to the
|
|
2491
|
+
* <code>SEND</code> metric volume.</p>
|
|
2492
|
+
* </li>
|
|
2493
|
+
* </ul>
|
|
2494
|
+
*/
|
|
2495
|
+
Aggregation?: MetricAggregation | string;
|
|
2496
|
+
}
|
|
2497
|
+
/**
|
|
2498
|
+
* @public
|
|
2499
|
+
* <p>An object that contains details about the data source for the metrics export.</p>
|
|
2500
|
+
*/
|
|
2501
|
+
export interface MetricsDataSource {
|
|
2502
|
+
/**
|
|
2503
|
+
* @public
|
|
2504
|
+
* <p>An object that contains a mapping between a <code>MetricDimensionName</code> and
|
|
2505
|
+
* <code>MetricDimensionValue</code> to filter metrics by. Must contain a least 1
|
|
2506
|
+
* dimension but no more than 3 unique ones.</p>
|
|
2507
|
+
*/
|
|
2508
|
+
Dimensions: Record<string, string[]> | undefined;
|
|
2509
|
+
/**
|
|
2510
|
+
* @public
|
|
2511
|
+
* <p>The metrics namespace - e.g., <code>VDM</code>.</p>
|
|
2512
|
+
*/
|
|
2513
|
+
Namespace: MetricNamespace | string | undefined;
|
|
2514
|
+
/**
|
|
2515
|
+
* @public
|
|
2516
|
+
* <p>A list of <code>ExportMetric</code> objects to export.</p>
|
|
2517
|
+
*/
|
|
2518
|
+
Metrics: ExportMetric[] | undefined;
|
|
2519
|
+
/**
|
|
2520
|
+
* @public
|
|
2521
|
+
* <p>Represents the start date for the export interval as a timestamp.</p>
|
|
2522
|
+
*/
|
|
2523
|
+
StartDate: Date | undefined;
|
|
2524
|
+
/**
|
|
2525
|
+
* @public
|
|
2526
|
+
* <p>Represents the end date for the export interval as a timestamp.</p>
|
|
2527
|
+
*/
|
|
2528
|
+
EndDate: Date | undefined;
|
|
2529
|
+
}
|
|
2530
|
+
/**
|
|
2531
|
+
* @public
|
|
2532
|
+
* <p>An object that contains details about the data source of the export job. It can only
|
|
2533
|
+
* contain one of <code>MetricsDataSource</code> or <code>MessageInsightsDataSource</code> object.</p>
|
|
2534
|
+
*/
|
|
2535
|
+
export interface ExportDataSource {
|
|
2536
|
+
/**
|
|
2537
|
+
* @public
|
|
2538
|
+
* <p>An object that contains details about the data source for the metrics export.</p>
|
|
2539
|
+
*/
|
|
2540
|
+
MetricsDataSource?: MetricsDataSource;
|
|
2541
|
+
/**
|
|
2542
|
+
* @public
|
|
2543
|
+
* <p>An object that contains filters applied when performing the Message Insights export.</p>
|
|
2544
|
+
*/
|
|
2545
|
+
MessageInsightsDataSource?: MessageInsightsDataSource;
|
|
2546
|
+
}
|
|
2199
2547
|
/**
|
|
2200
2548
|
* @public
|
|
2201
2549
|
* @enum
|
|
@@ -2208,6 +2556,61 @@ export declare const DataFormat: {
|
|
|
2208
2556
|
* @public
|
|
2209
2557
|
*/
|
|
2210
2558
|
export type DataFormat = (typeof DataFormat)[keyof typeof DataFormat];
|
|
2559
|
+
/**
|
|
2560
|
+
* @public
|
|
2561
|
+
* <p>An object that contains details about the destination of the export job.</p>
|
|
2562
|
+
*/
|
|
2563
|
+
export interface ExportDestination {
|
|
2564
|
+
/**
|
|
2565
|
+
* @public
|
|
2566
|
+
* <p>The data format of the final export job file, can be one of the following:</p>
|
|
2567
|
+
* <ul>
|
|
2568
|
+
* <li>
|
|
2569
|
+
* <p>
|
|
2570
|
+
* <code>CSV</code> - A comma-separated values file.</p>
|
|
2571
|
+
* </li>
|
|
2572
|
+
* <li>
|
|
2573
|
+
* <p>
|
|
2574
|
+
* <code>JSON</code> - A Json file.</p>
|
|
2575
|
+
* </li>
|
|
2576
|
+
* </ul>
|
|
2577
|
+
*/
|
|
2578
|
+
DataFormat: DataFormat | string | undefined;
|
|
2579
|
+
/**
|
|
2580
|
+
* @public
|
|
2581
|
+
* <p>An Amazon S3 pre-signed URL that points to the generated export file.</p>
|
|
2582
|
+
*/
|
|
2583
|
+
S3Url?: string;
|
|
2584
|
+
}
|
|
2585
|
+
/**
|
|
2586
|
+
* @public
|
|
2587
|
+
* <p>Represents a request to create an export job from a data source to a data
|
|
2588
|
+
* destination.</p>
|
|
2589
|
+
*/
|
|
2590
|
+
export interface CreateExportJobRequest {
|
|
2591
|
+
/**
|
|
2592
|
+
* @public
|
|
2593
|
+
* <p>The data source for the export job.</p>
|
|
2594
|
+
*/
|
|
2595
|
+
ExportDataSource: ExportDataSource | undefined;
|
|
2596
|
+
/**
|
|
2597
|
+
* @public
|
|
2598
|
+
* <p>The destination for the export job.</p>
|
|
2599
|
+
*/
|
|
2600
|
+
ExportDestination: ExportDestination | undefined;
|
|
2601
|
+
}
|
|
2602
|
+
/**
|
|
2603
|
+
* @public
|
|
2604
|
+
* <p>An HTTP 200 response if the request succeeds, or an error message if the request
|
|
2605
|
+
* fails.</p>
|
|
2606
|
+
*/
|
|
2607
|
+
export interface CreateExportJobResponse {
|
|
2608
|
+
/**
|
|
2609
|
+
* @public
|
|
2610
|
+
* <p>A string that represents the export job ID.</p>
|
|
2611
|
+
*/
|
|
2612
|
+
JobId?: string;
|
|
2613
|
+
}
|
|
2211
2614
|
/**
|
|
2212
2615
|
* @public
|
|
2213
2616
|
* <p>An object that contains details about the data source of the import job.</p>
|
|
@@ -2921,23 +3324,126 @@ export interface DomainDeliverabilityTrackingOption {
|
|
|
2921
3324
|
}
|
|
2922
3325
|
/**
|
|
2923
3326
|
* @public
|
|
2924
|
-
* <p>
|
|
3327
|
+
* <p>
|
|
3328
|
+
* Contains a <code>Bounce</code> object if the event type is <code>BOUNCE</code>.
|
|
3329
|
+
* Contains a <code>Complaint</code> object if the event type is <code>COMPLAINT</code>.
|
|
3330
|
+
* </p>
|
|
2925
3331
|
*/
|
|
2926
|
-
export interface
|
|
3332
|
+
export interface EventDetails {
|
|
2927
3333
|
/**
|
|
2928
3334
|
* @public
|
|
2929
|
-
* <p>
|
|
3335
|
+
* <p>Information about a <code>Bounce</code> event.</p>
|
|
2930
3336
|
*/
|
|
2931
|
-
|
|
3337
|
+
Bounce?: Bounce;
|
|
2932
3338
|
/**
|
|
2933
3339
|
* @public
|
|
2934
|
-
* <p>
|
|
3340
|
+
* <p>Information about a <code>Complaint</code> event.</p>
|
|
2935
3341
|
*/
|
|
2936
|
-
|
|
3342
|
+
Complaint?: Complaint;
|
|
2937
3343
|
}
|
|
2938
3344
|
/**
|
|
2939
3345
|
* @public
|
|
2940
|
-
* <p>
|
|
3346
|
+
* <p>An object containing details about a specific event.</p>
|
|
3347
|
+
*/
|
|
3348
|
+
export interface InsightsEvent {
|
|
3349
|
+
/**
|
|
3350
|
+
* @public
|
|
3351
|
+
* <p>The timestamp of the event.</p>
|
|
3352
|
+
*/
|
|
3353
|
+
Timestamp?: Date;
|
|
3354
|
+
/**
|
|
3355
|
+
* @public
|
|
3356
|
+
* <p>The type of event:</p>
|
|
3357
|
+
* <ul>
|
|
3358
|
+
* <li>
|
|
3359
|
+
* <p>
|
|
3360
|
+
* <code>SEND</code> - The send request was successful and SES will
|
|
3361
|
+
* attempt to deliver the message to the recipient’s mail server. (If account-level
|
|
3362
|
+
* or global suppression is being used, SES will still count it as a send,
|
|
3363
|
+
* but delivery is suppressed.)
|
|
3364
|
+
* </p>
|
|
3365
|
+
* </li>
|
|
3366
|
+
* <li>
|
|
3367
|
+
* <p>
|
|
3368
|
+
* <code>DELIVERY</code> - SES successfully delivered the email to the
|
|
3369
|
+
* recipient's mail server. Excludes deliveries to the mailbox simulator,
|
|
3370
|
+
* and those from emails addressed to more than one recipient.
|
|
3371
|
+
* </p>
|
|
3372
|
+
* </li>
|
|
3373
|
+
* <li>
|
|
3374
|
+
* <p>
|
|
3375
|
+
* <code>BOUNCE</code> - Feedback received for delivery failures. Additional details about the bounce are provided in the <code>Details</code> object.
|
|
3376
|
+
* Excludes bounces from the mailbox simulator, and those from emails addressed to more than one recipient.
|
|
3377
|
+
* </p>
|
|
3378
|
+
* </li>
|
|
3379
|
+
* <li>
|
|
3380
|
+
* <p>
|
|
3381
|
+
* <code>COMPLAINT</code> - Complaint received for the email. Additional details about the complaint are provided in the <code>Details</code> object.
|
|
3382
|
+
* This excludes complaints from the mailbox simulator, those originating from
|
|
3383
|
+
* your account-level suppression list (if enabled), and those from emails addressed
|
|
3384
|
+
* to more than one recipient.
|
|
3385
|
+
* </p>
|
|
3386
|
+
* </li>
|
|
3387
|
+
* <li>
|
|
3388
|
+
* <p>
|
|
3389
|
+
* <code>OPEN</code> - Open event for emails including open trackers.
|
|
3390
|
+
* Excludes opens for emails addressed to more than one recipient.</p>
|
|
3391
|
+
* </li>
|
|
3392
|
+
* <li>
|
|
3393
|
+
* <p>
|
|
3394
|
+
* <code>CLICK</code> - Click event for emails including wrapped links.
|
|
3395
|
+
* Excludes clicks for emails addressed to more than one recipient.</p>
|
|
3396
|
+
* </li>
|
|
3397
|
+
* </ul>
|
|
3398
|
+
*/
|
|
3399
|
+
Type?: EventType | string;
|
|
3400
|
+
/**
|
|
3401
|
+
* @public
|
|
3402
|
+
* <p>Details about bounce or complaint events.</p>
|
|
3403
|
+
*/
|
|
3404
|
+
Details?: EventDetails;
|
|
3405
|
+
}
|
|
3406
|
+
/**
|
|
3407
|
+
* @public
|
|
3408
|
+
* <p>An email's insights contain metadata and delivery information about a specific email.</p>
|
|
3409
|
+
*/
|
|
3410
|
+
export interface EmailInsights {
|
|
3411
|
+
/**
|
|
3412
|
+
* @public
|
|
3413
|
+
* <p>The recipient of the email.</p>
|
|
3414
|
+
*/
|
|
3415
|
+
Destination?: string;
|
|
3416
|
+
/**
|
|
3417
|
+
* @public
|
|
3418
|
+
* <p>The recipient's ISP (e.g., <code>Gmail</code>, <code>Yahoo</code>,
|
|
3419
|
+
* etc.).</p>
|
|
3420
|
+
*/
|
|
3421
|
+
Isp?: string;
|
|
3422
|
+
/**
|
|
3423
|
+
* @public
|
|
3424
|
+
* <p>A list of events associated with the sent email.</p>
|
|
3425
|
+
*/
|
|
3426
|
+
Events?: InsightsEvent[];
|
|
3427
|
+
}
|
|
3428
|
+
/**
|
|
3429
|
+
* @public
|
|
3430
|
+
* <p>Contains information about an email template.</p>
|
|
3431
|
+
*/
|
|
3432
|
+
export interface EmailTemplateMetadata {
|
|
3433
|
+
/**
|
|
3434
|
+
* @public
|
|
3435
|
+
* <p>The name of the template.</p>
|
|
3436
|
+
*/
|
|
3437
|
+
TemplateName?: string;
|
|
3438
|
+
/**
|
|
3439
|
+
* @public
|
|
3440
|
+
* <p>The time and date the template was created.</p>
|
|
3441
|
+
*/
|
|
3442
|
+
CreatedTimestamp?: Date;
|
|
3443
|
+
}
|
|
3444
|
+
/**
|
|
3445
|
+
* @public
|
|
3446
|
+
* <p>In the Amazon SES API v2, <i>events</i> include message sends, deliveries, opens,
|
|
2941
3447
|
* clicks, bounces, complaints and delivery delays. <i>Event destinations</i>
|
|
2942
3448
|
* are places that you can send information about these events to. For example, you can
|
|
2943
3449
|
* send event data to Amazon SNS to receive notifications when you receive bounces or
|
|
@@ -3059,18 +3565,92 @@ export interface EventDestination {
|
|
|
3059
3565
|
}
|
|
3060
3566
|
/**
|
|
3061
3567
|
* @public
|
|
3062
|
-
*
|
|
3568
|
+
* @enum
|
|
3569
|
+
*/
|
|
3570
|
+
export declare const ExportSourceType: {
|
|
3571
|
+
readonly MESSAGE_INSIGHTS: "MESSAGE_INSIGHTS";
|
|
3572
|
+
readonly METRICS_DATA: "METRICS_DATA";
|
|
3573
|
+
};
|
|
3574
|
+
/**
|
|
3575
|
+
* @public
|
|
3576
|
+
*/
|
|
3577
|
+
export type ExportSourceType = (typeof ExportSourceType)[keyof typeof ExportSourceType];
|
|
3578
|
+
/**
|
|
3579
|
+
* @public
|
|
3580
|
+
* @enum
|
|
3581
|
+
*/
|
|
3582
|
+
export declare const JobStatus: {
|
|
3583
|
+
readonly CANCELLED: "CANCELLED";
|
|
3584
|
+
readonly COMPLETED: "COMPLETED";
|
|
3585
|
+
readonly CREATED: "CREATED";
|
|
3586
|
+
readonly FAILED: "FAILED";
|
|
3587
|
+
readonly PROCESSING: "PROCESSING";
|
|
3588
|
+
};
|
|
3589
|
+
/**
|
|
3590
|
+
* @public
|
|
3591
|
+
*/
|
|
3592
|
+
export type JobStatus = (typeof JobStatus)[keyof typeof JobStatus];
|
|
3593
|
+
/**
|
|
3594
|
+
* @public
|
|
3595
|
+
* <p>A summary of the export job.</p>
|
|
3596
|
+
*/
|
|
3597
|
+
export interface ExportJobSummary {
|
|
3598
|
+
/**
|
|
3599
|
+
* @public
|
|
3600
|
+
* <p>The export job ID.</p>
|
|
3601
|
+
*/
|
|
3602
|
+
JobId?: string;
|
|
3603
|
+
/**
|
|
3604
|
+
* @public
|
|
3605
|
+
* <p>The source type of the export job.</p>
|
|
3606
|
+
*/
|
|
3607
|
+
ExportSourceType?: ExportSourceType | string;
|
|
3608
|
+
/**
|
|
3609
|
+
* @public
|
|
3610
|
+
* <p>The status of the export job.</p>
|
|
3611
|
+
*/
|
|
3612
|
+
JobStatus?: JobStatus | string;
|
|
3613
|
+
/**
|
|
3614
|
+
* @public
|
|
3615
|
+
* <p>The timestamp of when the export job was created.</p>
|
|
3616
|
+
*/
|
|
3617
|
+
CreatedTimestamp?: Date;
|
|
3618
|
+
/**
|
|
3619
|
+
* @public
|
|
3620
|
+
* <p>The timestamp of when the export job was completed.</p>
|
|
3621
|
+
*/
|
|
3622
|
+
CompletedTimestamp?: Date;
|
|
3623
|
+
}
|
|
3624
|
+
/**
|
|
3625
|
+
* @public
|
|
3626
|
+
* <p>Statistics about the execution of an export job.</p>
|
|
3627
|
+
*/
|
|
3628
|
+
export interface ExportStatistics {
|
|
3629
|
+
/**
|
|
3630
|
+
* @public
|
|
3631
|
+
* <p>The number of records that were processed to generate the final export file.</p>
|
|
3632
|
+
*/
|
|
3633
|
+
ProcessedRecordsCount?: number;
|
|
3634
|
+
/**
|
|
3635
|
+
* @public
|
|
3636
|
+
* <p>The number of records that were exported to the final export file.</p>
|
|
3637
|
+
* <p>This value might not be available for all export source types</p>
|
|
3638
|
+
*/
|
|
3639
|
+
ExportedRecordsCount?: number;
|
|
3640
|
+
}
|
|
3641
|
+
/**
|
|
3642
|
+
* @public
|
|
3643
|
+
* <p>An object that contains the failure details about a job.</p>
|
|
3063
3644
|
*/
|
|
3064
3645
|
export interface FailureInfo {
|
|
3065
3646
|
/**
|
|
3066
3647
|
* @public
|
|
3067
|
-
* <p>An Amazon S3
|
|
3068
|
-
* information.</p>
|
|
3648
|
+
* <p>An Amazon S3 pre-signed URL that contains all the failed records and related information.</p>
|
|
3069
3649
|
*/
|
|
3070
3650
|
FailedRecordsS3Url?: string;
|
|
3071
3651
|
/**
|
|
3072
3652
|
* @public
|
|
3073
|
-
* <p>A message about why the
|
|
3653
|
+
* <p>A message about why the job failed.</p>
|
|
3074
3654
|
*/
|
|
3075
3655
|
ErrorMessage?: string;
|
|
3076
3656
|
}
|
|
@@ -4111,30 +4691,80 @@ export interface GetEmailTemplateResponse {
|
|
|
4111
4691
|
}
|
|
4112
4692
|
/**
|
|
4113
4693
|
* @public
|
|
4114
|
-
* <p>Represents a request
|
|
4694
|
+
* <p>Represents a request to retrieve information about an export job using the export job
|
|
4115
4695
|
* ID.</p>
|
|
4116
4696
|
*/
|
|
4117
|
-
export interface
|
|
4697
|
+
export interface GetExportJobRequest {
|
|
4118
4698
|
/**
|
|
4119
4699
|
* @public
|
|
4120
|
-
* <p>The
|
|
4700
|
+
* <p>The export job ID.</p>
|
|
4121
4701
|
*/
|
|
4122
4702
|
JobId: string | undefined;
|
|
4123
4703
|
}
|
|
4124
4704
|
/**
|
|
4125
4705
|
* @public
|
|
4126
|
-
*
|
|
4706
|
+
* <p>An HTTP 200 response if the request succeeds, or an error message if the request
|
|
4707
|
+
* fails.</p>
|
|
4127
4708
|
*/
|
|
4128
|
-
export
|
|
4129
|
-
|
|
4130
|
-
|
|
4131
|
-
|
|
4132
|
-
|
|
4133
|
-
|
|
4709
|
+
export interface GetExportJobResponse {
|
|
4710
|
+
/**
|
|
4711
|
+
* @public
|
|
4712
|
+
* <p>The export job ID.</p>
|
|
4713
|
+
*/
|
|
4714
|
+
JobId?: string;
|
|
4715
|
+
/**
|
|
4716
|
+
* @public
|
|
4717
|
+
* <p>The type of source of the export job.</p>
|
|
4718
|
+
*/
|
|
4719
|
+
ExportSourceType?: ExportSourceType | string;
|
|
4720
|
+
/**
|
|
4721
|
+
* @public
|
|
4722
|
+
* <p>The status of the export job.</p>
|
|
4723
|
+
*/
|
|
4724
|
+
JobStatus?: JobStatus | string;
|
|
4725
|
+
/**
|
|
4726
|
+
* @public
|
|
4727
|
+
* <p>The destination of the export job.</p>
|
|
4728
|
+
*/
|
|
4729
|
+
ExportDestination?: ExportDestination;
|
|
4730
|
+
/**
|
|
4731
|
+
* @public
|
|
4732
|
+
* <p>The data source of the export job.</p>
|
|
4733
|
+
*/
|
|
4734
|
+
ExportDataSource?: ExportDataSource;
|
|
4735
|
+
/**
|
|
4736
|
+
* @public
|
|
4737
|
+
* <p>The timestamp of when the export job was created.</p>
|
|
4738
|
+
*/
|
|
4739
|
+
CreatedTimestamp?: Date;
|
|
4740
|
+
/**
|
|
4741
|
+
* @public
|
|
4742
|
+
* <p>The timestamp of when the export job was completed.</p>
|
|
4743
|
+
*/
|
|
4744
|
+
CompletedTimestamp?: Date;
|
|
4745
|
+
/**
|
|
4746
|
+
* @public
|
|
4747
|
+
* <p>The failure details about an export job.</p>
|
|
4748
|
+
*/
|
|
4749
|
+
FailureInfo?: FailureInfo;
|
|
4750
|
+
/**
|
|
4751
|
+
* @public
|
|
4752
|
+
* <p>The statistics about the export job.</p>
|
|
4753
|
+
*/
|
|
4754
|
+
Statistics?: ExportStatistics;
|
|
4755
|
+
}
|
|
4134
4756
|
/**
|
|
4135
4757
|
* @public
|
|
4758
|
+
* <p>Represents a request for information about an import job using the import job
|
|
4759
|
+
* ID.</p>
|
|
4136
4760
|
*/
|
|
4137
|
-
export
|
|
4761
|
+
export interface GetImportJobRequest {
|
|
4762
|
+
/**
|
|
4763
|
+
* @public
|
|
4764
|
+
* <p>The ID of the import job.</p>
|
|
4765
|
+
*/
|
|
4766
|
+
JobId: string | undefined;
|
|
4767
|
+
}
|
|
4138
4768
|
/**
|
|
4139
4769
|
* @public
|
|
4140
4770
|
* <p>An HTTP 200 response if the request succeeds, or an error message if the request
|
|
@@ -4188,6 +4818,54 @@ export interface GetImportJobResponse {
|
|
|
4188
4818
|
*/
|
|
4189
4819
|
FailedRecordsCount?: number;
|
|
4190
4820
|
}
|
|
4821
|
+
/**
|
|
4822
|
+
* @public
|
|
4823
|
+
* <p>A request to return information about a message.</p>
|
|
4824
|
+
*/
|
|
4825
|
+
export interface GetMessageInsightsRequest {
|
|
4826
|
+
/**
|
|
4827
|
+
* @public
|
|
4828
|
+
* <p>
|
|
4829
|
+
* A <code>MessageId</code> is a unique identifier for a message, and is
|
|
4830
|
+
* returned when sending emails through Amazon SES.
|
|
4831
|
+
* </p>
|
|
4832
|
+
*/
|
|
4833
|
+
MessageId: string | undefined;
|
|
4834
|
+
}
|
|
4835
|
+
/**
|
|
4836
|
+
* @public
|
|
4837
|
+
* <p>Information about a message.</p>
|
|
4838
|
+
*/
|
|
4839
|
+
export interface GetMessageInsightsResponse {
|
|
4840
|
+
/**
|
|
4841
|
+
* @public
|
|
4842
|
+
* <p>A unique identifier for the message.</p>
|
|
4843
|
+
*/
|
|
4844
|
+
MessageId?: string;
|
|
4845
|
+
/**
|
|
4846
|
+
* @public
|
|
4847
|
+
* <p>The from address used to send the message.</p>
|
|
4848
|
+
*/
|
|
4849
|
+
FromEmailAddress?: string;
|
|
4850
|
+
/**
|
|
4851
|
+
* @public
|
|
4852
|
+
* <p>The subject line of the message.</p>
|
|
4853
|
+
*/
|
|
4854
|
+
Subject?: string;
|
|
4855
|
+
/**
|
|
4856
|
+
* @public
|
|
4857
|
+
* <p>
|
|
4858
|
+
* A list of tags, in the form of name/value pairs, that were applied to the email you sent, along with Amazon SES
|
|
4859
|
+
* <a href="https://docs.aws.amazon.com/ses/latest/dg/monitor-using-event-publishing.html">Auto-Tags</a>.
|
|
4860
|
+
* </p>
|
|
4861
|
+
*/
|
|
4862
|
+
EmailTags?: MessageTag[];
|
|
4863
|
+
/**
|
|
4864
|
+
* @public
|
|
4865
|
+
* <p>A set of insights associated with the message.</p>
|
|
4866
|
+
*/
|
|
4867
|
+
Insights?: EmailInsights[];
|
|
4868
|
+
}
|
|
4191
4869
|
/**
|
|
4192
4870
|
* @public
|
|
4193
4871
|
* <p>A request to retrieve information about an email address that's on the suppression
|
|
@@ -4334,7 +5012,7 @@ export type ImportDestinationType = (typeof ImportDestinationType)[keyof typeof
|
|
|
4334
5012
|
export interface ImportJobSummary {
|
|
4335
5013
|
/**
|
|
4336
5014
|
* @public
|
|
4337
|
-
* <p>A string that represents
|
|
5015
|
+
* <p>A string that represents a job ID.</p>
|
|
4338
5016
|
*/
|
|
4339
5017
|
JobId?: string;
|
|
4340
5018
|
/**
|
|
@@ -4345,7 +5023,25 @@ export interface ImportJobSummary {
|
|
|
4345
5023
|
ImportDestination?: ImportDestination;
|
|
4346
5024
|
/**
|
|
4347
5025
|
* @public
|
|
4348
|
-
* <p>The status of
|
|
5026
|
+
* <p>The status of a job.</p>
|
|
5027
|
+
* <ul>
|
|
5028
|
+
* <li>
|
|
5029
|
+
* <p>
|
|
5030
|
+
* <code>CREATED</code> – Job has just been created.</p>
|
|
5031
|
+
* </li>
|
|
5032
|
+
* <li>
|
|
5033
|
+
* <p>
|
|
5034
|
+
* <code>PROCESSING</code> – Job is processing.</p>
|
|
5035
|
+
* </li>
|
|
5036
|
+
* <li>
|
|
5037
|
+
* <p>
|
|
5038
|
+
* <code>ERROR</code> – An error occurred during processing.</p>
|
|
5039
|
+
* </li>
|
|
5040
|
+
* <li>
|
|
5041
|
+
* <p>
|
|
5042
|
+
* <code>COMPLETED</code> – Job has completed processing successfully.</p>
|
|
5043
|
+
* </li>
|
|
5044
|
+
* </ul>
|
|
4349
5045
|
*/
|
|
4350
5046
|
JobStatus?: JobStatus | string;
|
|
4351
5047
|
/**
|
|
@@ -4813,49 +5509,100 @@ export interface ListEmailTemplatesResponse {
|
|
|
4813
5509
|
}
|
|
4814
5510
|
/**
|
|
4815
5511
|
* @public
|
|
4816
|
-
* <p>Represents a request to list all
|
|
4817
|
-
* specified maximum number of import jobs.</p>
|
|
5512
|
+
* <p>Represents a request to list all export jobs with filters.</p>
|
|
4818
5513
|
*/
|
|
4819
|
-
export interface
|
|
5514
|
+
export interface ListExportJobsRequest {
|
|
4820
5515
|
/**
|
|
4821
5516
|
* @public
|
|
4822
|
-
* <p>The
|
|
4823
|
-
*
|
|
5517
|
+
* <p>The pagination token returned from a previous call to <code>ListExportJobs</code> to
|
|
5518
|
+
* indicate the position in the list of export jobs.</p>
|
|
4824
5519
|
*/
|
|
4825
|
-
|
|
5520
|
+
NextToken?: string;
|
|
4826
5521
|
/**
|
|
4827
5522
|
* @public
|
|
4828
|
-
* <p>
|
|
4829
|
-
*
|
|
4830
|
-
*
|
|
5523
|
+
* <p>Maximum number of export jobs to return at once. Use this parameter to paginate
|
|
5524
|
+
* results. If additional export jobs exist beyond the specified limit, the
|
|
5525
|
+
* <code>NextToken</code> element is sent in the response. Use the
|
|
5526
|
+
* <code>NextToken</code> value in subsequent calls to <code>ListExportJobs</code> to
|
|
5527
|
+
* retrieve additional export jobs.</p>
|
|
4831
5528
|
*/
|
|
4832
|
-
|
|
5529
|
+
PageSize?: number;
|
|
4833
5530
|
/**
|
|
4834
5531
|
* @public
|
|
4835
|
-
* <p>
|
|
4836
|
-
*
|
|
4837
|
-
* <code>NextToken</code> element is sent in the response. Use the
|
|
4838
|
-
* <code>NextToken</code> value in subsequent requests to retrieve additional
|
|
4839
|
-
* addresses.</p>
|
|
5532
|
+
* <p>A value used to list export jobs that have a certain
|
|
5533
|
+
* <code>ExportSourceType</code>.</p>
|
|
4840
5534
|
*/
|
|
4841
|
-
|
|
5535
|
+
ExportSourceType?: ExportSourceType | string;
|
|
5536
|
+
/**
|
|
5537
|
+
* @public
|
|
5538
|
+
* <p>A value used to list export jobs that have a certain <code>JobStatus</code>.</p>
|
|
5539
|
+
*/
|
|
5540
|
+
JobStatus?: JobStatus | string;
|
|
4842
5541
|
}
|
|
4843
5542
|
/**
|
|
4844
5543
|
* @public
|
|
4845
5544
|
* <p>An HTTP 200 response if the request succeeds, or an error message if the request
|
|
4846
5545
|
* fails.</p>
|
|
4847
5546
|
*/
|
|
4848
|
-
export interface
|
|
5547
|
+
export interface ListExportJobsResponse {
|
|
4849
5548
|
/**
|
|
4850
5549
|
* @public
|
|
4851
|
-
* <p>A list of the
|
|
5550
|
+
* <p>A list of the export job summaries.</p>
|
|
4852
5551
|
*/
|
|
4853
|
-
|
|
5552
|
+
ExportJobs?: ExportJobSummary[];
|
|
4854
5553
|
/**
|
|
4855
5554
|
* @public
|
|
4856
|
-
* <p>A string token indicating that there might be additional
|
|
4857
|
-
* listed.
|
|
4858
|
-
*
|
|
5555
|
+
* <p>A string token indicating that there might be additional export jobs available to be
|
|
5556
|
+
* listed. Use this token to a subsequent call to <code>ListExportJobs</code> with the same
|
|
5557
|
+
* parameters to retrieve the next page of export jobs.</p>
|
|
5558
|
+
*/
|
|
5559
|
+
NextToken?: string;
|
|
5560
|
+
}
|
|
5561
|
+
/**
|
|
5562
|
+
* @public
|
|
5563
|
+
* <p>Represents a request to list all of the import jobs for a data destination within the
|
|
5564
|
+
* specified maximum number of import jobs.</p>
|
|
5565
|
+
*/
|
|
5566
|
+
export interface ListImportJobsRequest {
|
|
5567
|
+
/**
|
|
5568
|
+
* @public
|
|
5569
|
+
* <p>The destination of the import job, which can be used to list import jobs that have a
|
|
5570
|
+
* certain <code>ImportDestinationType</code>.</p>
|
|
5571
|
+
*/
|
|
5572
|
+
ImportDestinationType?: ImportDestinationType | string;
|
|
5573
|
+
/**
|
|
5574
|
+
* @public
|
|
5575
|
+
* <p>A string token indicating that there might be additional import jobs available to be
|
|
5576
|
+
* listed. Copy this token to a subsequent call to <code>ListImportJobs</code> with the
|
|
5577
|
+
* same parameters to retrieve the next page of import jobs.</p>
|
|
5578
|
+
*/
|
|
5579
|
+
NextToken?: string;
|
|
5580
|
+
/**
|
|
5581
|
+
* @public
|
|
5582
|
+
* <p>Maximum number of import jobs to return at once. Use this parameter to paginate
|
|
5583
|
+
* results. If additional import jobs exist beyond the specified limit, the
|
|
5584
|
+
* <code>NextToken</code> element is sent in the response. Use the
|
|
5585
|
+
* <code>NextToken</code> value in subsequent requests to retrieve additional
|
|
5586
|
+
* addresses.</p>
|
|
5587
|
+
*/
|
|
5588
|
+
PageSize?: number;
|
|
5589
|
+
}
|
|
5590
|
+
/**
|
|
5591
|
+
* @public
|
|
5592
|
+
* <p>An HTTP 200 response if the request succeeds, or an error message if the request
|
|
5593
|
+
* fails.</p>
|
|
5594
|
+
*/
|
|
5595
|
+
export interface ListImportJobsResponse {
|
|
5596
|
+
/**
|
|
5597
|
+
* @public
|
|
5598
|
+
* <p>A list of the import job summaries.</p>
|
|
5599
|
+
*/
|
|
5600
|
+
ImportJobs?: ImportJobSummary[];
|
|
5601
|
+
/**
|
|
5602
|
+
* @public
|
|
5603
|
+
* <p>A string token indicating that there might be additional import jobs available to be
|
|
5604
|
+
* listed. Copy this token to a subsequent call to <code>ListImportJobs</code> with the
|
|
5605
|
+
* same parameters to retrieve the next page of import jobs.</p>
|
|
4859
5606
|
*/
|
|
4860
5607
|
NextToken?: string;
|
|
4861
5608
|
}
|
|
@@ -5798,543 +6545,49 @@ export interface PutSuppressedDestinationRequest {
|
|
|
5798
6545
|
Reason: SuppressionListReason | string | undefined;
|
|
5799
6546
|
}
|
|
5800
6547
|
/**
|
|
5801
|
-
* @
|
|
5802
|
-
* <p>An HTTP 200 response if the request succeeds, or an error message if the request
|
|
5803
|
-
* fails.</p>
|
|
5804
|
-
*/
|
|
5805
|
-
export interface PutSuppressedDestinationResponse {
|
|
5806
|
-
}
|
|
5807
|
-
/**
|
|
5808
|
-
* @public
|
|
5809
|
-
* <p>Represents a request to send email messages to multiple destinations using Amazon SES. For
|
|
5810
|
-
* more information, see the <a href="https://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-personalized-email-api.html">Amazon SES Developer
|
|
5811
|
-
* Guide</a>.</p>
|
|
5812
|
-
*/
|
|
5813
|
-
export interface SendBulkEmailRequest {
|
|
5814
|
-
/**
|
|
5815
|
-
* @public
|
|
5816
|
-
* <p>The email address to use as the "From" address for the email. The
|
|
5817
|
-
* address that you specify has to be verified.</p>
|
|
5818
|
-
*/
|
|
5819
|
-
FromEmailAddress?: string;
|
|
5820
|
-
/**
|
|
5821
|
-
* @public
|
|
5822
|
-
* <p>This parameter is used only for sending authorization. It is the ARN of the identity
|
|
5823
|
-
* that is associated with the sending authorization policy that permits you to use the
|
|
5824
|
-
* email address specified in the <code>FromEmailAddress</code> parameter.</p>
|
|
5825
|
-
* <p>For example, if the owner of example.com (which has ARN
|
|
5826
|
-
* arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it that
|
|
5827
|
-
* authorizes you to use sender@example.com, then you would specify the
|
|
5828
|
-
* <code>FromEmailAddressIdentityArn</code> to be
|
|
5829
|
-
* arn:aws:ses:us-east-1:123456789012:identity/example.com, and the
|
|
5830
|
-
* <code>FromEmailAddress</code> to be sender@example.com.</p>
|
|
5831
|
-
* <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
|
|
5832
|
-
* Guide</a>.</p>
|
|
5833
|
-
*/
|
|
5834
|
-
FromEmailAddressIdentityArn?: string;
|
|
5835
|
-
/**
|
|
5836
|
-
* @public
|
|
5837
|
-
* <p>The "Reply-to" email addresses for the message. When the recipient replies to the
|
|
5838
|
-
* message, each Reply-to address receives the reply.</p>
|
|
5839
|
-
*/
|
|
5840
|
-
ReplyToAddresses?: string[];
|
|
5841
|
-
/**
|
|
5842
|
-
* @public
|
|
5843
|
-
* <p>The address that you want bounce and complaint notifications to be sent to.</p>
|
|
5844
|
-
*/
|
|
5845
|
-
FeedbackForwardingEmailAddress?: string;
|
|
5846
|
-
/**
|
|
5847
|
-
* @public
|
|
5848
|
-
* <p>This parameter is used only for sending authorization. It is the ARN of the identity
|
|
5849
|
-
* that is associated with the sending authorization policy that permits you to use the
|
|
5850
|
-
* email address specified in the <code>FeedbackForwardingEmailAddress</code>
|
|
5851
|
-
* parameter.</p>
|
|
5852
|
-
* <p>For example, if the owner of example.com (which has ARN
|
|
5853
|
-
* arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it that
|
|
5854
|
-
* authorizes you to use feedback@example.com, then you would specify the
|
|
5855
|
-
* <code>FeedbackForwardingEmailAddressIdentityArn</code> to be
|
|
5856
|
-
* arn:aws:ses:us-east-1:123456789012:identity/example.com, and the
|
|
5857
|
-
* <code>FeedbackForwardingEmailAddress</code> to be feedback@example.com.</p>
|
|
5858
|
-
* <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
|
|
5859
|
-
* Guide</a>.</p>
|
|
5860
|
-
*/
|
|
5861
|
-
FeedbackForwardingEmailAddressIdentityArn?: string;
|
|
5862
|
-
/**
|
|
5863
|
-
* @public
|
|
5864
|
-
* <p>A list of tags, in the form of name/value pairs, to apply to an email that you send
|
|
5865
|
-
* using the <code>SendEmail</code> operation. Tags correspond to characteristics of the
|
|
5866
|
-
* email that you define, so that you can publish email sending events.</p>
|
|
5867
|
-
*/
|
|
5868
|
-
DefaultEmailTags?: MessageTag[];
|
|
5869
|
-
/**
|
|
5870
|
-
* @public
|
|
5871
|
-
* <p>An object that contains the body of the message. You can specify a template
|
|
5872
|
-
* message.</p>
|
|
5873
|
-
*/
|
|
5874
|
-
DefaultContent: BulkEmailContent | undefined;
|
|
5875
|
-
/**
|
|
5876
|
-
* @public
|
|
5877
|
-
* <p>The list of bulk email entry objects.</p>
|
|
5878
|
-
*/
|
|
5879
|
-
BulkEmailEntries: BulkEmailEntry[] | undefined;
|
|
5880
|
-
/**
|
|
5881
|
-
* @public
|
|
5882
|
-
* <p>The name of the configuration set to use when sending the email.</p>
|
|
5883
|
-
*/
|
|
5884
|
-
ConfigurationSetName?: string;
|
|
5885
|
-
}
|
|
5886
|
-
/**
|
|
5887
|
-
* @public
|
|
5888
|
-
* <p>The following data is returned in JSON format by the service.</p>
|
|
5889
|
-
*/
|
|
5890
|
-
export interface SendBulkEmailResponse {
|
|
5891
|
-
/**
|
|
5892
|
-
* @public
|
|
5893
|
-
* <p>One object per intended recipient. Check each response object and retry any messages
|
|
5894
|
-
* with a failure status.</p>
|
|
5895
|
-
*/
|
|
5896
|
-
BulkEmailEntryResults: BulkEmailEntryResult[] | undefined;
|
|
5897
|
-
}
|
|
5898
|
-
/**
|
|
5899
|
-
* @public
|
|
5900
|
-
* <p>Represents a request to send a custom verification email to a specified
|
|
5901
|
-
* recipient.</p>
|
|
5902
|
-
*/
|
|
5903
|
-
export interface SendCustomVerificationEmailRequest {
|
|
5904
|
-
/**
|
|
5905
|
-
* @public
|
|
5906
|
-
* <p>The email address to verify.</p>
|
|
5907
|
-
*/
|
|
5908
|
-
EmailAddress: string | undefined;
|
|
5909
|
-
/**
|
|
5910
|
-
* @public
|
|
5911
|
-
* <p>The name of the custom verification email template to use when sending the
|
|
5912
|
-
* verification email.</p>
|
|
5913
|
-
*/
|
|
5914
|
-
TemplateName: string | undefined;
|
|
5915
|
-
/**
|
|
5916
|
-
* @public
|
|
5917
|
-
* <p>Name of a configuration set to use when sending the verification email.</p>
|
|
5918
|
-
*/
|
|
5919
|
-
ConfigurationSetName?: string;
|
|
5920
|
-
}
|
|
5921
|
-
/**
|
|
5922
|
-
* @public
|
|
5923
|
-
* <p>The following element is returned by the service.</p>
|
|
5924
|
-
*/
|
|
5925
|
-
export interface SendCustomVerificationEmailResponse {
|
|
5926
|
-
/**
|
|
5927
|
-
* @public
|
|
5928
|
-
* <p>The unique message identifier returned from the
|
|
5929
|
-
* <code>SendCustomVerificationEmail</code> operation.</p>
|
|
5930
|
-
*/
|
|
5931
|
-
MessageId?: string;
|
|
5932
|
-
}
|
|
5933
|
-
/**
|
|
5934
|
-
* @public
|
|
5935
|
-
* <p>Represents a request to send a single formatted email using Amazon SES. For more
|
|
5936
|
-
* information, see the <a href="https://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-email-formatted.html">Amazon SES Developer
|
|
5937
|
-
* Guide</a>.</p>
|
|
5938
|
-
*/
|
|
5939
|
-
export interface SendEmailRequest {
|
|
5940
|
-
/**
|
|
5941
|
-
* @public
|
|
5942
|
-
* <p>The email address to use as the "From" address for the email. The
|
|
5943
|
-
* address that you specify has to be verified.
|
|
5944
|
-
* </p>
|
|
5945
|
-
*/
|
|
5946
|
-
FromEmailAddress?: string;
|
|
5947
|
-
/**
|
|
5948
|
-
* @public
|
|
5949
|
-
* <p>This parameter is used only for sending authorization. It is the ARN of the identity
|
|
5950
|
-
* that is associated with the sending authorization policy that permits you to use the
|
|
5951
|
-
* email address specified in the <code>FromEmailAddress</code> parameter.</p>
|
|
5952
|
-
* <p>For example, if the owner of example.com (which has ARN
|
|
5953
|
-
* arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it that
|
|
5954
|
-
* authorizes you to use sender@example.com, then you would specify the
|
|
5955
|
-
* <code>FromEmailAddressIdentityArn</code> to be
|
|
5956
|
-
* arn:aws:ses:us-east-1:123456789012:identity/example.com, and the
|
|
5957
|
-
* <code>FromEmailAddress</code> to be sender@example.com.</p>
|
|
5958
|
-
* <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
|
|
5959
|
-
* Guide</a>.</p>
|
|
5960
|
-
* <p>For Raw emails, the <code>FromEmailAddressIdentityArn</code> value overrides the
|
|
5961
|
-
* X-SES-SOURCE-ARN and X-SES-FROM-ARN headers specified in raw email message
|
|
5962
|
-
* content.</p>
|
|
5963
|
-
*/
|
|
5964
|
-
FromEmailAddressIdentityArn?: string;
|
|
5965
|
-
/**
|
|
5966
|
-
* @public
|
|
5967
|
-
* <p>An object that contains the recipients of the email message.</p>
|
|
5968
|
-
*/
|
|
5969
|
-
Destination?: Destination;
|
|
5970
|
-
/**
|
|
5971
|
-
* @public
|
|
5972
|
-
* <p>The "Reply-to" email addresses for the message. When the recipient replies to the
|
|
5973
|
-
* message, each Reply-to address receives the reply.</p>
|
|
5974
|
-
*/
|
|
5975
|
-
ReplyToAddresses?: string[];
|
|
5976
|
-
/**
|
|
5977
|
-
* @public
|
|
5978
|
-
* <p>The address that you want bounce and complaint notifications to be sent to.</p>
|
|
5979
|
-
*/
|
|
5980
|
-
FeedbackForwardingEmailAddress?: string;
|
|
5981
|
-
/**
|
|
5982
|
-
* @public
|
|
5983
|
-
* <p>This parameter is used only for sending authorization. It is the ARN of the identity
|
|
5984
|
-
* that is associated with the sending authorization policy that permits you to use the
|
|
5985
|
-
* email address specified in the <code>FeedbackForwardingEmailAddress</code>
|
|
5986
|
-
* parameter.</p>
|
|
5987
|
-
* <p>For example, if the owner of example.com (which has ARN
|
|
5988
|
-
* arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it that
|
|
5989
|
-
* authorizes you to use feedback@example.com, then you would specify the
|
|
5990
|
-
* <code>FeedbackForwardingEmailAddressIdentityArn</code> to be
|
|
5991
|
-
* arn:aws:ses:us-east-1:123456789012:identity/example.com, and the
|
|
5992
|
-
* <code>FeedbackForwardingEmailAddress</code> to be feedback@example.com.</p>
|
|
5993
|
-
* <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
|
|
5994
|
-
* Guide</a>.</p>
|
|
5995
|
-
*/
|
|
5996
|
-
FeedbackForwardingEmailAddressIdentityArn?: string;
|
|
5997
|
-
/**
|
|
5998
|
-
* @public
|
|
5999
|
-
* <p>An object that contains the body of the message. You can send either a Simple message
|
|
6000
|
-
* Raw message or a template Message.</p>
|
|
6001
|
-
*/
|
|
6002
|
-
Content: EmailContent | undefined;
|
|
6003
|
-
/**
|
|
6004
|
-
* @public
|
|
6005
|
-
* <p>A list of tags, in the form of name/value pairs, to apply to an email that you send
|
|
6006
|
-
* using the <code>SendEmail</code> operation. Tags correspond to characteristics of the
|
|
6007
|
-
* email that you define, so that you can publish email sending events. </p>
|
|
6008
|
-
*/
|
|
6009
|
-
EmailTags?: MessageTag[];
|
|
6010
|
-
/**
|
|
6011
|
-
* @public
|
|
6012
|
-
* <p>The name of the configuration set to use when sending the email.</p>
|
|
6013
|
-
*/
|
|
6014
|
-
ConfigurationSetName?: string;
|
|
6015
|
-
/**
|
|
6016
|
-
* @public
|
|
6017
|
-
* <p>An object used to specify a list or topic to which an email belongs, which will be
|
|
6018
|
-
* used when a contact chooses to unsubscribe.</p>
|
|
6019
|
-
*/
|
|
6020
|
-
ListManagementOptions?: ListManagementOptions;
|
|
6021
|
-
}
|
|
6022
|
-
/**
|
|
6023
|
-
* @public
|
|
6024
|
-
* <p>A unique message ID that you receive when an email is accepted for sending.</p>
|
|
6025
|
-
*/
|
|
6026
|
-
export interface SendEmailResponse {
|
|
6027
|
-
/**
|
|
6028
|
-
* @public
|
|
6029
|
-
* <p>A unique identifier for the message that is generated when the message is
|
|
6030
|
-
* accepted.</p>
|
|
6031
|
-
* <note>
|
|
6032
|
-
* <p>It's possible for Amazon SES to accept a message without sending it. This can happen
|
|
6033
|
-
* when the message that you're trying to send has an attachment contains a virus, or
|
|
6034
|
-
* when you send a templated email that contains invalid personalization content, for
|
|
6035
|
-
* example.</p>
|
|
6036
|
-
* </note>
|
|
6037
|
-
*/
|
|
6038
|
-
MessageId?: string;
|
|
6039
|
-
}
|
|
6040
|
-
/**
|
|
6041
|
-
* @public
|
|
6042
|
-
*/
|
|
6043
|
-
export interface TagResourceRequest {
|
|
6044
|
-
/**
|
|
6045
|
-
* @public
|
|
6046
|
-
* <p>The Amazon Resource Name (ARN) of the resource that you want to add one or more tags
|
|
6047
|
-
* to.</p>
|
|
6048
|
-
*/
|
|
6049
|
-
ResourceArn: string | undefined;
|
|
6050
|
-
/**
|
|
6051
|
-
* @public
|
|
6052
|
-
* <p>A list of the tags that you want to add to the resource. A tag consists of a required
|
|
6053
|
-
* tag key (<code>Key</code>) and an associated tag value (<code>Value</code>). The maximum
|
|
6054
|
-
* length of a tag key is 128 characters. The maximum length of a tag value is 256
|
|
6055
|
-
* characters.</p>
|
|
6056
|
-
*/
|
|
6057
|
-
Tags: Tag[] | undefined;
|
|
6058
|
-
}
|
|
6059
|
-
/**
|
|
6060
|
-
* @public
|
|
6061
|
-
*/
|
|
6062
|
-
export interface TagResourceResponse {
|
|
6063
|
-
}
|
|
6064
|
-
/**
|
|
6065
|
-
* @public
|
|
6066
|
-
* <p>>Represents a request to create a preview of the MIME content of an email when
|
|
6067
|
-
* provided with a template and a set of replacement data.</p>
|
|
6068
|
-
*/
|
|
6069
|
-
export interface TestRenderEmailTemplateRequest {
|
|
6070
|
-
/**
|
|
6071
|
-
* @public
|
|
6072
|
-
* <p>The name of the template.</p>
|
|
6073
|
-
*/
|
|
6074
|
-
TemplateName: string | undefined;
|
|
6075
|
-
/**
|
|
6076
|
-
* @public
|
|
6077
|
-
* <p>A list of replacement values to apply to the template. This parameter is a JSON
|
|
6078
|
-
* object, typically consisting of key-value pairs in which the keys correspond to
|
|
6079
|
-
* replacement tags in the email template.</p>
|
|
6080
|
-
*/
|
|
6081
|
-
TemplateData: string | undefined;
|
|
6082
|
-
}
|
|
6083
|
-
/**
|
|
6084
|
-
* @public
|
|
6085
|
-
* <p>The following element is returned by the service.</p>
|
|
6086
|
-
*/
|
|
6087
|
-
export interface TestRenderEmailTemplateResponse {
|
|
6088
|
-
/**
|
|
6089
|
-
* @public
|
|
6090
|
-
* <p>The complete MIME message rendered by applying the data in the
|
|
6091
|
-
* <code>TemplateData</code> parameter to the template specified in the TemplateName
|
|
6092
|
-
* parameter.</p>
|
|
6093
|
-
*/
|
|
6094
|
-
RenderedTemplate: string | undefined;
|
|
6095
|
-
}
|
|
6096
|
-
/**
|
|
6097
|
-
* @public
|
|
6098
|
-
*/
|
|
6099
|
-
export interface UntagResourceRequest {
|
|
6100
|
-
/**
|
|
6101
|
-
* @public
|
|
6102
|
-
* <p>The Amazon Resource Name (ARN) of the resource that you want to remove one or more
|
|
6103
|
-
* tags from.</p>
|
|
6104
|
-
*/
|
|
6105
|
-
ResourceArn: string | undefined;
|
|
6106
|
-
/**
|
|
6107
|
-
* @public
|
|
6108
|
-
* <p>The tags (tag keys) that you want to remove from the resource. When you specify a tag
|
|
6109
|
-
* key, the action removes both that key and its associated tag value.</p>
|
|
6110
|
-
* <p>To remove more than one tag from the resource, append the <code>TagKeys</code>
|
|
6111
|
-
* parameter and argument for each additional tag to remove, separated by an ampersand. For
|
|
6112
|
-
* example:
|
|
6113
|
-
* <code>/v2/email/tags?ResourceArn=ResourceArn&TagKeys=Key1&TagKeys=Key2</code>
|
|
6114
|
-
* </p>
|
|
6115
|
-
*/
|
|
6116
|
-
TagKeys: string[] | undefined;
|
|
6117
|
-
}
|
|
6118
|
-
/**
|
|
6119
|
-
* @public
|
|
6120
|
-
*/
|
|
6121
|
-
export interface UntagResourceResponse {
|
|
6122
|
-
}
|
|
6123
|
-
/**
|
|
6124
|
-
* @public
|
|
6125
|
-
* <p>A request to change the settings for an event destination for a configuration
|
|
6126
|
-
* set.</p>
|
|
6127
|
-
*/
|
|
6128
|
-
export interface UpdateConfigurationSetEventDestinationRequest {
|
|
6129
|
-
/**
|
|
6130
|
-
* @public
|
|
6131
|
-
* <p>The name of the configuration set that contains the event destination to
|
|
6132
|
-
* modify.</p>
|
|
6133
|
-
*/
|
|
6134
|
-
ConfigurationSetName: string | undefined;
|
|
6135
|
-
/**
|
|
6136
|
-
* @public
|
|
6137
|
-
* <p>The name of the event destination.</p>
|
|
6138
|
-
*/
|
|
6139
|
-
EventDestinationName: string | undefined;
|
|
6140
|
-
/**
|
|
6141
|
-
* @public
|
|
6142
|
-
* <p>An object that defines the event destination.</p>
|
|
6143
|
-
*/
|
|
6144
|
-
EventDestination: EventDestinationDefinition | undefined;
|
|
6145
|
-
}
|
|
6146
|
-
/**
|
|
6147
|
-
* @public
|
|
6148
|
-
* <p>An HTTP 200 response if the request succeeds, or an error message if the request
|
|
6149
|
-
* fails.</p>
|
|
6150
|
-
*/
|
|
6151
|
-
export interface UpdateConfigurationSetEventDestinationResponse {
|
|
6152
|
-
}
|
|
6153
|
-
/**
|
|
6154
|
-
* @public
|
|
6155
|
-
*/
|
|
6156
|
-
export interface UpdateContactRequest {
|
|
6157
|
-
/**
|
|
6158
|
-
* @public
|
|
6159
|
-
* <p>The name of the contact list.</p>
|
|
6160
|
-
*/
|
|
6161
|
-
ContactListName: string | undefined;
|
|
6162
|
-
/**
|
|
6163
|
-
* @public
|
|
6164
|
-
* <p>The contact's email address.</p>
|
|
6165
|
-
*/
|
|
6166
|
-
EmailAddress: string | undefined;
|
|
6167
|
-
/**
|
|
6168
|
-
* @public
|
|
6169
|
-
* <p>The contact's preference for being opted-in to or opted-out of a topic.</p>
|
|
6170
|
-
*/
|
|
6171
|
-
TopicPreferences?: TopicPreference[];
|
|
6172
|
-
/**
|
|
6173
|
-
* @public
|
|
6174
|
-
* <p>A boolean value status noting if the contact is unsubscribed from all contact list
|
|
6175
|
-
* topics.</p>
|
|
6176
|
-
*/
|
|
6177
|
-
UnsubscribeAll?: boolean;
|
|
6178
|
-
/**
|
|
6179
|
-
* @public
|
|
6180
|
-
* <p>The attribute data attached to a contact.</p>
|
|
6181
|
-
*/
|
|
6182
|
-
AttributesData?: string;
|
|
6183
|
-
}
|
|
6184
|
-
/**
|
|
6185
|
-
* @public
|
|
6186
|
-
*/
|
|
6187
|
-
export interface UpdateContactResponse {
|
|
6188
|
-
}
|
|
6189
|
-
/**
|
|
6190
|
-
* @public
|
|
6191
|
-
*/
|
|
6192
|
-
export interface UpdateContactListRequest {
|
|
6193
|
-
/**
|
|
6194
|
-
* @public
|
|
6195
|
-
* <p>The name of the contact list.</p>
|
|
6196
|
-
*/
|
|
6197
|
-
ContactListName: string | undefined;
|
|
6198
|
-
/**
|
|
6199
|
-
* @public
|
|
6200
|
-
* <p>An interest group, theme, or label within a list. A contact list can have multiple
|
|
6201
|
-
* topics.</p>
|
|
6202
|
-
*/
|
|
6203
|
-
Topics?: Topic[];
|
|
6204
|
-
/**
|
|
6205
|
-
* @public
|
|
6206
|
-
* <p>A description of what the contact list is about.</p>
|
|
6207
|
-
*/
|
|
6208
|
-
Description?: string;
|
|
6209
|
-
}
|
|
6210
|
-
/**
|
|
6211
|
-
* @public
|
|
6548
|
+
* @internal
|
|
6212
6549
|
*/
|
|
6213
|
-
export
|
|
6214
|
-
}
|
|
6550
|
+
export declare const AccountDetailsFilterSensitiveLog: (obj: AccountDetails) => any;
|
|
6215
6551
|
/**
|
|
6216
|
-
* @
|
|
6217
|
-
* <p>Represents a request to update an existing custom verification email template.</p>
|
|
6552
|
+
* @internal
|
|
6218
6553
|
*/
|
|
6219
|
-
export
|
|
6220
|
-
/**
|
|
6221
|
-
* @public
|
|
6222
|
-
* <p>The name of the custom verification email template that you want to update.</p>
|
|
6223
|
-
*/
|
|
6224
|
-
TemplateName: string | undefined;
|
|
6225
|
-
/**
|
|
6226
|
-
* @public
|
|
6227
|
-
* <p>The email address that the custom verification email is sent from.</p>
|
|
6228
|
-
*/
|
|
6229
|
-
FromEmailAddress: string | undefined;
|
|
6230
|
-
/**
|
|
6231
|
-
* @public
|
|
6232
|
-
* <p>The subject line of the custom verification email.</p>
|
|
6233
|
-
*/
|
|
6234
|
-
TemplateSubject: string | undefined;
|
|
6235
|
-
/**
|
|
6236
|
-
* @public
|
|
6237
|
-
* <p>The content of the custom verification email. The total size of the email must be less
|
|
6238
|
-
* than 10 MB. The message body may contain HTML, with some limitations. For more
|
|
6239
|
-
* information, see <a href="https://docs.aws.amazon.com/ses/latest/dg/creating-identities.html#send-email-verify-address-custom-faq">Custom verification email frequently asked questions</a> in the <i>Amazon SES
|
|
6240
|
-
* Developer Guide</i>.</p>
|
|
6241
|
-
*/
|
|
6242
|
-
TemplateContent: string | undefined;
|
|
6243
|
-
/**
|
|
6244
|
-
* @public
|
|
6245
|
-
* <p>The URL that the recipient of the verification email is sent to if his or her address
|
|
6246
|
-
* is successfully verified.</p>
|
|
6247
|
-
*/
|
|
6248
|
-
SuccessRedirectionURL: string | undefined;
|
|
6249
|
-
/**
|
|
6250
|
-
* @public
|
|
6251
|
-
* <p>The URL that the recipient of the verification email is sent to if his or her address
|
|
6252
|
-
* is not successfully verified.</p>
|
|
6253
|
-
*/
|
|
6254
|
-
FailureRedirectionURL: string | undefined;
|
|
6255
|
-
}
|
|
6554
|
+
export declare const DkimSigningAttributesFilterSensitiveLog: (obj: DkimSigningAttributes) => any;
|
|
6256
6555
|
/**
|
|
6257
|
-
* @
|
|
6258
|
-
* <p>If the action is successful, the service sends back an HTTP 200 response with an empty
|
|
6259
|
-
* HTTP body.</p>
|
|
6556
|
+
* @internal
|
|
6260
6557
|
*/
|
|
6261
|
-
export
|
|
6262
|
-
}
|
|
6558
|
+
export declare const CreateEmailIdentityRequestFilterSensitiveLog: (obj: CreateEmailIdentityRequest) => any;
|
|
6263
6559
|
/**
|
|
6264
|
-
* @
|
|
6265
|
-
* <p>Represents a request to update a sending authorization policy for an identity. Sending
|
|
6266
|
-
* authorization is an Amazon SES feature that enables you to authorize other senders to use
|
|
6267
|
-
* your identities. For information, see the <a href="https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization-identity-owner-tasks-management.html">Amazon SES Developer Guide</a>.</p>
|
|
6560
|
+
* @internal
|
|
6268
6561
|
*/
|
|
6269
|
-
export
|
|
6270
|
-
/**
|
|
6271
|
-
* @public
|
|
6272
|
-
* <p>The email identity.</p>
|
|
6273
|
-
*/
|
|
6274
|
-
EmailIdentity: string | undefined;
|
|
6275
|
-
/**
|
|
6276
|
-
* @public
|
|
6277
|
-
* <p>The name of the policy.</p>
|
|
6278
|
-
* <p>The policy name cannot exceed 64 characters and can only include alphanumeric
|
|
6279
|
-
* characters, dashes, and underscores.</p>
|
|
6280
|
-
*/
|
|
6281
|
-
PolicyName: string | undefined;
|
|
6282
|
-
/**
|
|
6283
|
-
* @public
|
|
6284
|
-
* <p>The text of the policy in JSON format. The policy cannot exceed 4 KB.</p>
|
|
6285
|
-
* <p> For information about the syntax of sending authorization policies, see the <a href="https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization-policies.html">Amazon SES Developer
|
|
6286
|
-
* Guide</a>.</p>
|
|
6287
|
-
*/
|
|
6288
|
-
Policy: string | undefined;
|
|
6289
|
-
}
|
|
6562
|
+
export declare const MessageInsightsFiltersFilterSensitiveLog: (obj: MessageInsightsFilters) => any;
|
|
6290
6563
|
/**
|
|
6291
|
-
* @
|
|
6292
|
-
* <p>An HTTP 200 response if the request succeeds, or an error message if the request
|
|
6293
|
-
* fails.</p>
|
|
6564
|
+
* @internal
|
|
6294
6565
|
*/
|
|
6295
|
-
export
|
|
6296
|
-
}
|
|
6566
|
+
export declare const MessageInsightsDataSourceFilterSensitiveLog: (obj: MessageInsightsDataSource) => any;
|
|
6297
6567
|
/**
|
|
6298
|
-
* @
|
|
6299
|
-
* <p>Represents a request to update an email template. For more information, see the <a href="https://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-personalized-email-api.html">Amazon SES
|
|
6300
|
-
* Developer Guide</a>.</p>
|
|
6568
|
+
* @internal
|
|
6301
6569
|
*/
|
|
6302
|
-
export
|
|
6303
|
-
/**
|
|
6304
|
-
* @public
|
|
6305
|
-
* <p>The name of the template.</p>
|
|
6306
|
-
*/
|
|
6307
|
-
TemplateName: string | undefined;
|
|
6308
|
-
/**
|
|
6309
|
-
* @public
|
|
6310
|
-
* <p>The content of the email template, composed of a subject line, an HTML part, and a
|
|
6311
|
-
* text-only part.</p>
|
|
6312
|
-
*/
|
|
6313
|
-
TemplateContent: EmailTemplateContent | undefined;
|
|
6314
|
-
}
|
|
6570
|
+
export declare const ExportDataSourceFilterSensitiveLog: (obj: ExportDataSource) => any;
|
|
6315
6571
|
/**
|
|
6316
|
-
* @
|
|
6317
|
-
* <p>If the action is successful, the service sends back an HTTP 200 response with an empty
|
|
6318
|
-
* HTTP body.</p>
|
|
6572
|
+
* @internal
|
|
6319
6573
|
*/
|
|
6320
|
-
export
|
|
6321
|
-
}
|
|
6574
|
+
export declare const CreateExportJobRequestFilterSensitiveLog: (obj: CreateExportJobRequest) => any;
|
|
6322
6575
|
/**
|
|
6323
6576
|
* @internal
|
|
6324
6577
|
*/
|
|
6325
|
-
export declare const
|
|
6578
|
+
export declare const EmailInsightsFilterSensitiveLog: (obj: EmailInsights) => any;
|
|
6326
6579
|
/**
|
|
6327
6580
|
* @internal
|
|
6328
6581
|
*/
|
|
6329
|
-
export declare const
|
|
6582
|
+
export declare const GetAccountResponseFilterSensitiveLog: (obj: GetAccountResponse) => any;
|
|
6330
6583
|
/**
|
|
6331
6584
|
* @internal
|
|
6332
6585
|
*/
|
|
6333
|
-
export declare const
|
|
6586
|
+
export declare const GetExportJobResponseFilterSensitiveLog: (obj: GetExportJobResponse) => any;
|
|
6334
6587
|
/**
|
|
6335
6588
|
* @internal
|
|
6336
6589
|
*/
|
|
6337
|
-
export declare const
|
|
6590
|
+
export declare const GetMessageInsightsResponseFilterSensitiveLog: (obj: GetMessageInsightsResponse) => any;
|
|
6338
6591
|
/**
|
|
6339
6592
|
* @internal
|
|
6340
6593
|
*/
|