aws-sdk-sesv2 1.37.0 → 1.39.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.
- checksums.yaml +4 -4
- data/CHANGELOG.md +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-sesv2/client.rb +505 -3
- data/lib/aws-sdk-sesv2/client_api.rb +246 -0
- data/lib/aws-sdk-sesv2/endpoints.rb +70 -0
- data/lib/aws-sdk-sesv2/plugins/endpoints.rb +10 -0
- data/lib/aws-sdk-sesv2/types.rb +710 -5
- data/lib/aws-sdk-sesv2.rb +1 -1
- metadata +2 -2
data/lib/aws-sdk-sesv2/types.rb
CHANGED
@@ -248,6 +248,34 @@ module Aws::SESV2
|
|
248
248
|
include Aws::Structure
|
249
249
|
end
|
250
250
|
|
251
|
+
# Information about a `Bounce` event.
|
252
|
+
#
|
253
|
+
# @!attribute [rw] bounce_type
|
254
|
+
# The type of the bounce, as determined by SES. Can be one of
|
255
|
+
# `UNDETERMINED`, `TRANSIENT`, or `PERMANENT`
|
256
|
+
# @return [String]
|
257
|
+
#
|
258
|
+
# @!attribute [rw] bounce_sub_type
|
259
|
+
# The subtype of the bounce, as determined by SES.
|
260
|
+
# @return [String]
|
261
|
+
#
|
262
|
+
# @!attribute [rw] diagnostic_code
|
263
|
+
# The status code issued by the reporting Message Transfer Authority
|
264
|
+
# (MTA). This field only appears if a delivery status notification
|
265
|
+
# (DSN) was attached to the bounce and the `Diagnostic-Code` was
|
266
|
+
# provided in the DSN.
|
267
|
+
# @return [String]
|
268
|
+
#
|
269
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/Bounce AWS API Documentation
|
270
|
+
#
|
271
|
+
class Bounce < Struct.new(
|
272
|
+
:bounce_type,
|
273
|
+
:bounce_sub_type,
|
274
|
+
:diagnostic_code)
|
275
|
+
SENSITIVE = []
|
276
|
+
include Aws::Structure
|
277
|
+
end
|
278
|
+
|
251
279
|
# An object that contains the body of the message. You can specify a
|
252
280
|
# template message.
|
253
281
|
#
|
@@ -385,6 +413,27 @@ module Aws::SESV2
|
|
385
413
|
include Aws::Structure
|
386
414
|
end
|
387
415
|
|
416
|
+
# Represents a request to cancel an export job using the export job ID.
|
417
|
+
#
|
418
|
+
# @!attribute [rw] job_id
|
419
|
+
# The export job ID.
|
420
|
+
# @return [String]
|
421
|
+
#
|
422
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/CancelExportJobRequest AWS API Documentation
|
423
|
+
#
|
424
|
+
class CancelExportJobRequest < Struct.new(
|
425
|
+
:job_id)
|
426
|
+
SENSITIVE = []
|
427
|
+
include Aws::Structure
|
428
|
+
end
|
429
|
+
|
430
|
+
# An HTTP 200 response if the request succeeds, or an error message if
|
431
|
+
# the request fails.
|
432
|
+
#
|
433
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/CancelExportJobResponse AWS API Documentation
|
434
|
+
#
|
435
|
+
class CancelExportJobResponse < Aws::EmptyStructure; end
|
436
|
+
|
388
437
|
# An object that defines an Amazon CloudWatch destination for email
|
389
438
|
# events. You can use Amazon CloudWatch to monitor and gain insights on
|
390
439
|
# your email sending metrics.
|
@@ -445,6 +494,29 @@ module Aws::SESV2
|
|
445
494
|
include Aws::Structure
|
446
495
|
end
|
447
496
|
|
497
|
+
# Information about a `Complaint` event.
|
498
|
+
#
|
499
|
+
# @!attribute [rw] complaint_sub_type
|
500
|
+
# Can either be `null` or `OnAccountSuppressionList`. If the value is
|
501
|
+
# `OnAccountSuppressionList`, SES accepted the message, but didn't
|
502
|
+
# attempt to send it because it was on the account-level suppression
|
503
|
+
# list.
|
504
|
+
# @return [String]
|
505
|
+
#
|
506
|
+
# @!attribute [rw] complaint_feedback_type
|
507
|
+
# The value of the `Feedback-Type` field from the feedback report
|
508
|
+
# received from the ISP.
|
509
|
+
# @return [String]
|
510
|
+
#
|
511
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/Complaint AWS API Documentation
|
512
|
+
#
|
513
|
+
class Complaint < Struct.new(
|
514
|
+
:complaint_sub_type,
|
515
|
+
:complaint_feedback_type)
|
516
|
+
SENSITIVE = []
|
517
|
+
include Aws::Structure
|
518
|
+
end
|
519
|
+
|
448
520
|
# The resource is being modified by another operation or thread.
|
449
521
|
#
|
450
522
|
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/ConcurrentModificationException AWS API Documentation
|
@@ -1044,6 +1116,41 @@ module Aws::SESV2
|
|
1044
1116
|
#
|
1045
1117
|
class CreateEmailTemplateResponse < Aws::EmptyStructure; end
|
1046
1118
|
|
1119
|
+
# Represents a request to create an export job from a data source to a
|
1120
|
+
# data destination.
|
1121
|
+
#
|
1122
|
+
# @!attribute [rw] export_data_source
|
1123
|
+
# The data source for the export job.
|
1124
|
+
# @return [Types::ExportDataSource]
|
1125
|
+
#
|
1126
|
+
# @!attribute [rw] export_destination
|
1127
|
+
# The destination for the export job.
|
1128
|
+
# @return [Types::ExportDestination]
|
1129
|
+
#
|
1130
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/CreateExportJobRequest AWS API Documentation
|
1131
|
+
#
|
1132
|
+
class CreateExportJobRequest < Struct.new(
|
1133
|
+
:export_data_source,
|
1134
|
+
:export_destination)
|
1135
|
+
SENSITIVE = []
|
1136
|
+
include Aws::Structure
|
1137
|
+
end
|
1138
|
+
|
1139
|
+
# An HTTP 200 response if the request succeeds, or an error message if
|
1140
|
+
# the request fails.
|
1141
|
+
#
|
1142
|
+
# @!attribute [rw] job_id
|
1143
|
+
# A string that represents the export job ID.
|
1144
|
+
# @return [String]
|
1145
|
+
#
|
1146
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/CreateExportJobResponse AWS API Documentation
|
1147
|
+
#
|
1148
|
+
class CreateExportJobResponse < Struct.new(
|
1149
|
+
:job_id)
|
1150
|
+
SENSITIVE = []
|
1151
|
+
include Aws::Structure
|
1152
|
+
end
|
1153
|
+
|
1047
1154
|
# Represents a request to create an import job from a data source for a
|
1048
1155
|
# data destination.
|
1049
1156
|
#
|
@@ -1985,6 +2092,31 @@ module Aws::SESV2
|
|
1985
2092
|
include Aws::Structure
|
1986
2093
|
end
|
1987
2094
|
|
2095
|
+
# An email's insights contain metadata and delivery information about a
|
2096
|
+
# specific email.
|
2097
|
+
#
|
2098
|
+
# @!attribute [rw] destination
|
2099
|
+
# The recipient of the email.
|
2100
|
+
# @return [String]
|
2101
|
+
#
|
2102
|
+
# @!attribute [rw] isp
|
2103
|
+
# The recipient's ISP (e.g., `Gmail`, `Yahoo`, etc.).
|
2104
|
+
# @return [String]
|
2105
|
+
#
|
2106
|
+
# @!attribute [rw] events
|
2107
|
+
# A list of events associated with the sent email.
|
2108
|
+
# @return [Array<Types::InsightsEvent>]
|
2109
|
+
#
|
2110
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/EmailInsights AWS API Documentation
|
2111
|
+
#
|
2112
|
+
class EmailInsights < Struct.new(
|
2113
|
+
:destination,
|
2114
|
+
:isp,
|
2115
|
+
:events)
|
2116
|
+
SENSITIVE = [:destination]
|
2117
|
+
include Aws::Structure
|
2118
|
+
end
|
2119
|
+
|
1988
2120
|
# The content of the email, composed of a subject line, an HTML part,
|
1989
2121
|
# and a text-only part.
|
1990
2122
|
#
|
@@ -2214,15 +2346,211 @@ module Aws::SESV2
|
|
2214
2346
|
include Aws::Structure
|
2215
2347
|
end
|
2216
2348
|
|
2217
|
-
#
|
2349
|
+
# Contains a `Bounce` object if the event type is `BOUNCE`. Contains a
|
2350
|
+
# `Complaint` object if the event type is `COMPLAINT`.
|
2351
|
+
#
|
2352
|
+
# @!attribute [rw] bounce
|
2353
|
+
# Information about a `Bounce` event.
|
2354
|
+
# @return [Types::Bounce]
|
2355
|
+
#
|
2356
|
+
# @!attribute [rw] complaint
|
2357
|
+
# Information about a `Complaint` event.
|
2358
|
+
# @return [Types::Complaint]
|
2359
|
+
#
|
2360
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/EventDetails AWS API Documentation
|
2361
|
+
#
|
2362
|
+
class EventDetails < Struct.new(
|
2363
|
+
:bounce,
|
2364
|
+
:complaint)
|
2365
|
+
SENSITIVE = []
|
2366
|
+
include Aws::Structure
|
2367
|
+
end
|
2368
|
+
|
2369
|
+
# An object that contains details about the data source of the export
|
2370
|
+
# job. It can only contain one of `MetricsDataSource` or
|
2371
|
+
# `MessageInsightsDataSource` object.
|
2372
|
+
#
|
2373
|
+
# @!attribute [rw] metrics_data_source
|
2374
|
+
# An object that contains details about the data source for the
|
2375
|
+
# metrics export.
|
2376
|
+
# @return [Types::MetricsDataSource]
|
2377
|
+
#
|
2378
|
+
# @!attribute [rw] message_insights_data_source
|
2379
|
+
# An object that contains filters applied when performing the Message
|
2380
|
+
# Insights export.
|
2381
|
+
# @return [Types::MessageInsightsDataSource]
|
2382
|
+
#
|
2383
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/ExportDataSource AWS API Documentation
|
2384
|
+
#
|
2385
|
+
class ExportDataSource < Struct.new(
|
2386
|
+
:metrics_data_source,
|
2387
|
+
:message_insights_data_source)
|
2388
|
+
SENSITIVE = []
|
2389
|
+
include Aws::Structure
|
2390
|
+
end
|
2391
|
+
|
2392
|
+
# An object that contains details about the destination of the export
|
2393
|
+
# job.
|
2394
|
+
#
|
2395
|
+
# @!attribute [rw] data_format
|
2396
|
+
# The data format of the final export job file, can be one of the
|
2397
|
+
# following:
|
2398
|
+
#
|
2399
|
+
# * `CSV` - A comma-separated values file.
|
2400
|
+
#
|
2401
|
+
# * `JSON` - A Json file.
|
2402
|
+
# @return [String]
|
2403
|
+
#
|
2404
|
+
# @!attribute [rw] s3_url
|
2405
|
+
# An Amazon S3 pre-signed URL that points to the generated export
|
2406
|
+
# file.
|
2407
|
+
# @return [String]
|
2408
|
+
#
|
2409
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/ExportDestination AWS API Documentation
|
2410
|
+
#
|
2411
|
+
class ExportDestination < Struct.new(
|
2412
|
+
:data_format,
|
2413
|
+
:s3_url)
|
2414
|
+
SENSITIVE = []
|
2415
|
+
include Aws::Structure
|
2416
|
+
end
|
2417
|
+
|
2418
|
+
# A summary of the export job.
|
2419
|
+
#
|
2420
|
+
# @!attribute [rw] job_id
|
2421
|
+
# The export job ID.
|
2422
|
+
# @return [String]
|
2423
|
+
#
|
2424
|
+
# @!attribute [rw] export_source_type
|
2425
|
+
# The source type of the export job.
|
2426
|
+
# @return [String]
|
2427
|
+
#
|
2428
|
+
# @!attribute [rw] job_status
|
2429
|
+
# The status of the export job.
|
2430
|
+
# @return [String]
|
2431
|
+
#
|
2432
|
+
# @!attribute [rw] created_timestamp
|
2433
|
+
# The timestamp of when the export job was created.
|
2434
|
+
# @return [Time]
|
2435
|
+
#
|
2436
|
+
# @!attribute [rw] completed_timestamp
|
2437
|
+
# The timestamp of when the export job was completed.
|
2438
|
+
# @return [Time]
|
2439
|
+
#
|
2440
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/ExportJobSummary AWS API Documentation
|
2441
|
+
#
|
2442
|
+
class ExportJobSummary < Struct.new(
|
2443
|
+
:job_id,
|
2444
|
+
:export_source_type,
|
2445
|
+
:job_status,
|
2446
|
+
:created_timestamp,
|
2447
|
+
:completed_timestamp)
|
2448
|
+
SENSITIVE = []
|
2449
|
+
include Aws::Structure
|
2450
|
+
end
|
2451
|
+
|
2452
|
+
# An object that contains a mapping between a `Metric` and
|
2453
|
+
# `MetricAggregation`.
|
2454
|
+
#
|
2455
|
+
# @!attribute [rw] name
|
2456
|
+
# The metric to export, can be one of the following:
|
2457
|
+
#
|
2458
|
+
# * `SEND` - Emails sent eligible for tracking in the VDM dashboard.
|
2459
|
+
# This excludes emails sent to the mailbox simulator and emails
|
2460
|
+
# addressed to more than one recipient.
|
2461
|
+
#
|
2462
|
+
# * `COMPLAINT` - Complaints received for your account. This excludes
|
2463
|
+
# complaints from the mailbox simulator, those originating from your
|
2464
|
+
# account-level suppression list (if enabled), and those for emails
|
2465
|
+
# addressed to more than one recipient
|
2466
|
+
#
|
2467
|
+
# * `PERMANENT_BOUNCE` - Permanent bounces - i.e., feedback received
|
2468
|
+
# for emails sent to non-existent mailboxes. Excludes bounces from
|
2469
|
+
# the mailbox simulator, those originating from your account-level
|
2470
|
+
# suppression list (if enabled), and those for emails addressed to
|
2471
|
+
# more than one recipient.
|
2472
|
+
#
|
2473
|
+
# * `TRANSIENT_BOUNCE` - Transient bounces - i.e., feedback received
|
2474
|
+
# for delivery failures excluding issues with non-existent
|
2475
|
+
# mailboxes. Excludes bounces from the mailbox simulator, and those
|
2476
|
+
# for emails addressed to more than one recipient.
|
2477
|
+
#
|
2478
|
+
# * `OPEN` - Unique open events for emails including open trackers.
|
2479
|
+
# Excludes opens for emails addressed to more than one recipient.
|
2480
|
+
#
|
2481
|
+
# * `CLICK` - Unique click events for emails including wrapped links.
|
2482
|
+
# Excludes clicks for emails addressed to more than one recipient.
|
2483
|
+
#
|
2484
|
+
# * `DELIVERY` - Successful deliveries for email sending attempts.
|
2485
|
+
# Excludes deliveries to the mailbox simulator and for emails
|
2486
|
+
# addressed to more than one recipient.
|
2487
|
+
#
|
2488
|
+
# * `DELIVERY_OPEN` - Successful deliveries for email sending
|
2489
|
+
# attempts. Excludes deliveries to the mailbox simulator, for emails
|
2490
|
+
# addressed to more than one recipient, and emails without open
|
2491
|
+
# trackers.
|
2492
|
+
#
|
2493
|
+
# * `DELIVERY_CLICK` - Successful deliveries for email sending
|
2494
|
+
# attempts. Excludes deliveries to the mailbox simulator, for emails
|
2495
|
+
# addressed to more than one recipient, and emails without click
|
2496
|
+
# trackers.
|
2497
|
+
#
|
2498
|
+
# * `DELIVERY_COMPLAINT` - Successful deliveries for email sending
|
2499
|
+
# attempts. Excludes deliveries to the mailbox simulator, for emails
|
2500
|
+
# addressed to more than one recipient, and emails addressed to
|
2501
|
+
# recipients hosted by ISPs with which Amazon SES does not have a
|
2502
|
+
# feedback loop agreement.
|
2503
|
+
# @return [String]
|
2504
|
+
#
|
2505
|
+
# @!attribute [rw] aggregation
|
2506
|
+
# The aggregation to apply to a metric, can be one of the following:
|
2507
|
+
#
|
2508
|
+
# * `VOLUME` - The volume of events for this metric.
|
2509
|
+
#
|
2510
|
+
# * `RATE` - The rate for this metric relative to the `SEND` metric
|
2511
|
+
# volume.
|
2512
|
+
# @return [String]
|
2513
|
+
#
|
2514
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/ExportMetric AWS API Documentation
|
2515
|
+
#
|
2516
|
+
class ExportMetric < Struct.new(
|
2517
|
+
:name,
|
2518
|
+
:aggregation)
|
2519
|
+
SENSITIVE = []
|
2520
|
+
include Aws::Structure
|
2521
|
+
end
|
2522
|
+
|
2523
|
+
# Statistics about the execution of an export job.
|
2524
|
+
#
|
2525
|
+
# @!attribute [rw] processed_records_count
|
2526
|
+
# The number of records that were processed to generate the final
|
2527
|
+
# export file.
|
2528
|
+
# @return [Integer]
|
2529
|
+
#
|
2530
|
+
# @!attribute [rw] exported_records_count
|
2531
|
+
# The number of records that were exported to the final export file.
|
2532
|
+
#
|
2533
|
+
# This value might not be available for all export source types
|
2534
|
+
# @return [Integer]
|
2535
|
+
#
|
2536
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/ExportStatistics AWS API Documentation
|
2537
|
+
#
|
2538
|
+
class ExportStatistics < Struct.new(
|
2539
|
+
:processed_records_count,
|
2540
|
+
:exported_records_count)
|
2541
|
+
SENSITIVE = []
|
2542
|
+
include Aws::Structure
|
2543
|
+
end
|
2544
|
+
|
2545
|
+
# An object that contains the failure details about a job.
|
2218
2546
|
#
|
2219
2547
|
# @!attribute [rw] failed_records_s3_url
|
2220
|
-
# An Amazon S3
|
2548
|
+
# An Amazon S3 pre-signed URL that contains all the failed records and
|
2221
2549
|
# related information.
|
2222
2550
|
# @return [String]
|
2223
2551
|
#
|
2224
2552
|
# @!attribute [rw] error_message
|
2225
|
-
# A message about why the
|
2553
|
+
# A message about why the job failed.
|
2226
2554
|
# @return [String]
|
2227
2555
|
#
|
2228
2556
|
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/FailureInfo AWS API Documentation
|
@@ -3124,6 +3452,76 @@ module Aws::SESV2
|
|
3124
3452
|
include Aws::Structure
|
3125
3453
|
end
|
3126
3454
|
|
3455
|
+
# Represents a request to retrieve information about an export job using
|
3456
|
+
# the export job ID.
|
3457
|
+
#
|
3458
|
+
# @!attribute [rw] job_id
|
3459
|
+
# The export job ID.
|
3460
|
+
# @return [String]
|
3461
|
+
#
|
3462
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/GetExportJobRequest AWS API Documentation
|
3463
|
+
#
|
3464
|
+
class GetExportJobRequest < Struct.new(
|
3465
|
+
:job_id)
|
3466
|
+
SENSITIVE = []
|
3467
|
+
include Aws::Structure
|
3468
|
+
end
|
3469
|
+
|
3470
|
+
# An HTTP 200 response if the request succeeds, or an error message if
|
3471
|
+
# the request fails.
|
3472
|
+
#
|
3473
|
+
# @!attribute [rw] job_id
|
3474
|
+
# The export job ID.
|
3475
|
+
# @return [String]
|
3476
|
+
#
|
3477
|
+
# @!attribute [rw] export_source_type
|
3478
|
+
# The type of source of the export job.
|
3479
|
+
# @return [String]
|
3480
|
+
#
|
3481
|
+
# @!attribute [rw] job_status
|
3482
|
+
# The status of the export job.
|
3483
|
+
# @return [String]
|
3484
|
+
#
|
3485
|
+
# @!attribute [rw] export_destination
|
3486
|
+
# The destination of the export job.
|
3487
|
+
# @return [Types::ExportDestination]
|
3488
|
+
#
|
3489
|
+
# @!attribute [rw] export_data_source
|
3490
|
+
# The data source of the export job.
|
3491
|
+
# @return [Types::ExportDataSource]
|
3492
|
+
#
|
3493
|
+
# @!attribute [rw] created_timestamp
|
3494
|
+
# The timestamp of when the export job was created.
|
3495
|
+
# @return [Time]
|
3496
|
+
#
|
3497
|
+
# @!attribute [rw] completed_timestamp
|
3498
|
+
# The timestamp of when the export job was completed.
|
3499
|
+
# @return [Time]
|
3500
|
+
#
|
3501
|
+
# @!attribute [rw] failure_info
|
3502
|
+
# The failure details about an export job.
|
3503
|
+
# @return [Types::FailureInfo]
|
3504
|
+
#
|
3505
|
+
# @!attribute [rw] statistics
|
3506
|
+
# The statistics about the export job.
|
3507
|
+
# @return [Types::ExportStatistics]
|
3508
|
+
#
|
3509
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/GetExportJobResponse AWS API Documentation
|
3510
|
+
#
|
3511
|
+
class GetExportJobResponse < Struct.new(
|
3512
|
+
:job_id,
|
3513
|
+
:export_source_type,
|
3514
|
+
:job_status,
|
3515
|
+
:export_destination,
|
3516
|
+
:export_data_source,
|
3517
|
+
:created_timestamp,
|
3518
|
+
:completed_timestamp,
|
3519
|
+
:failure_info,
|
3520
|
+
:statistics)
|
3521
|
+
SENSITIVE = []
|
3522
|
+
include Aws::Structure
|
3523
|
+
end
|
3524
|
+
|
3127
3525
|
# Represents a request for information about an import job using the
|
3128
3526
|
# import job ID.
|
3129
3527
|
#
|
@@ -3195,6 +3593,60 @@ module Aws::SESV2
|
|
3195
3593
|
include Aws::Structure
|
3196
3594
|
end
|
3197
3595
|
|
3596
|
+
# A request to return information about a message.
|
3597
|
+
#
|
3598
|
+
# @!attribute [rw] message_id
|
3599
|
+
# A `MessageId` is a unique identifier for a message, and is returned
|
3600
|
+
# when sending emails through Amazon SES.
|
3601
|
+
# @return [String]
|
3602
|
+
#
|
3603
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/GetMessageInsightsRequest AWS API Documentation
|
3604
|
+
#
|
3605
|
+
class GetMessageInsightsRequest < Struct.new(
|
3606
|
+
:message_id)
|
3607
|
+
SENSITIVE = []
|
3608
|
+
include Aws::Structure
|
3609
|
+
end
|
3610
|
+
|
3611
|
+
# Information about a message.
|
3612
|
+
#
|
3613
|
+
# @!attribute [rw] message_id
|
3614
|
+
# A unique identifier for the message.
|
3615
|
+
# @return [String]
|
3616
|
+
#
|
3617
|
+
# @!attribute [rw] from_email_address
|
3618
|
+
# The from address used to send the message.
|
3619
|
+
# @return [String]
|
3620
|
+
#
|
3621
|
+
# @!attribute [rw] subject
|
3622
|
+
# The subject line of the message.
|
3623
|
+
# @return [String]
|
3624
|
+
#
|
3625
|
+
# @!attribute [rw] email_tags
|
3626
|
+
# A list of tags, in the form of name/value pairs, that were applied
|
3627
|
+
# to the email you sent, along with Amazon SES [Auto-Tags][1].
|
3628
|
+
#
|
3629
|
+
#
|
3630
|
+
#
|
3631
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/dg/monitor-using-event-publishing.html
|
3632
|
+
# @return [Array<Types::MessageTag>]
|
3633
|
+
#
|
3634
|
+
# @!attribute [rw] insights
|
3635
|
+
# A set of insights associated with the message.
|
3636
|
+
# @return [Array<Types::EmailInsights>]
|
3637
|
+
#
|
3638
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/GetMessageInsightsResponse AWS API Documentation
|
3639
|
+
#
|
3640
|
+
class GetMessageInsightsResponse < Struct.new(
|
3641
|
+
:message_id,
|
3642
|
+
:from_email_address,
|
3643
|
+
:subject,
|
3644
|
+
:email_tags,
|
3645
|
+
:insights)
|
3646
|
+
SENSITIVE = [:from_email_address, :subject]
|
3647
|
+
include Aws::Structure
|
3648
|
+
end
|
3649
|
+
|
3198
3650
|
# A request to retrieve information about an email address that's on
|
3199
3651
|
# the suppression list for your account.
|
3200
3652
|
#
|
@@ -3363,7 +3815,7 @@ module Aws::SESV2
|
|
3363
3815
|
# A summary of the import job.
|
3364
3816
|
#
|
3365
3817
|
# @!attribute [rw] job_id
|
3366
|
-
# A string that represents
|
3818
|
+
# A string that represents a job ID.
|
3367
3819
|
# @return [String]
|
3368
3820
|
#
|
3369
3821
|
# @!attribute [rw] import_destination
|
@@ -3372,7 +3824,15 @@ module Aws::SESV2
|
|
3372
3824
|
# @return [Types::ImportDestination]
|
3373
3825
|
#
|
3374
3826
|
# @!attribute [rw] job_status
|
3375
|
-
# The status of
|
3827
|
+
# The status of a job.
|
3828
|
+
#
|
3829
|
+
# * `CREATED` – Job has just been created.
|
3830
|
+
#
|
3831
|
+
# * `PROCESSING` – Job is processing.
|
3832
|
+
#
|
3833
|
+
# * `ERROR` – An error occurred during processing.
|
3834
|
+
#
|
3835
|
+
# * `COMPLETED` – Job has completed processing successfully.
|
3376
3836
|
# @return [String]
|
3377
3837
|
#
|
3378
3838
|
# @!attribute [rw] created_timestamp
|
@@ -3425,6 +3885,57 @@ module Aws::SESV2
|
|
3425
3885
|
include Aws::Structure
|
3426
3886
|
end
|
3427
3887
|
|
3888
|
+
# An object containing details about a specific event.
|
3889
|
+
#
|
3890
|
+
# @!attribute [rw] timestamp
|
3891
|
+
# The timestamp of the event.
|
3892
|
+
# @return [Time]
|
3893
|
+
#
|
3894
|
+
# @!attribute [rw] type
|
3895
|
+
# The type of event:
|
3896
|
+
#
|
3897
|
+
# * `SEND` - The send request was successful and SES will attempt to
|
3898
|
+
# deliver the message to the recipient’s mail server. (If
|
3899
|
+
# account-level or global suppression is being used, SES will still
|
3900
|
+
# count it as a send, but delivery is suppressed.)
|
3901
|
+
#
|
3902
|
+
# * `DELIVERY` - SES successfully delivered the email to the
|
3903
|
+
# recipient's mail server. Excludes deliveries to the mailbox
|
3904
|
+
# simulator, and those from emails addressed to more than one
|
3905
|
+
# recipient.
|
3906
|
+
#
|
3907
|
+
# * `BOUNCE` - Feedback received for delivery failures. Additional
|
3908
|
+
# details about the bounce are provided in the `Details` object.
|
3909
|
+
# Excludes bounces from the mailbox simulator, and those from emails
|
3910
|
+
# addressed to more than one recipient.
|
3911
|
+
#
|
3912
|
+
# * `COMPLAINT` - Complaint received for the email. Additional details
|
3913
|
+
# about the complaint are provided in the `Details` object. This
|
3914
|
+
# excludes complaints from the mailbox simulator, those originating
|
3915
|
+
# from your account-level suppression list (if enabled), and those
|
3916
|
+
# from emails addressed to more than one recipient.
|
3917
|
+
#
|
3918
|
+
# * `OPEN` - Open event for emails including open trackers. Excludes
|
3919
|
+
# opens for emails addressed to more than one recipient.
|
3920
|
+
#
|
3921
|
+
# * `CLICK` - Click event for emails including wrapped links. Excludes
|
3922
|
+
# clicks for emails addressed to more than one recipient.
|
3923
|
+
# @return [String]
|
3924
|
+
#
|
3925
|
+
# @!attribute [rw] details
|
3926
|
+
# Details about bounce or complaint events.
|
3927
|
+
# @return [Types::EventDetails]
|
3928
|
+
#
|
3929
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/InsightsEvent AWS API Documentation
|
3930
|
+
#
|
3931
|
+
class InsightsEvent < Struct.new(
|
3932
|
+
:timestamp,
|
3933
|
+
:type,
|
3934
|
+
:details)
|
3935
|
+
SENSITIVE = []
|
3936
|
+
include Aws::Structure
|
3937
|
+
end
|
3938
|
+
|
3428
3939
|
# The request couldn't be processed because an error occurred with the
|
3429
3940
|
# Amazon SES API v2.
|
3430
3941
|
#
|
@@ -3987,6 +4498,65 @@ module Aws::SESV2
|
|
3987
4498
|
include Aws::Structure
|
3988
4499
|
end
|
3989
4500
|
|
4501
|
+
# Represents a request to list all export jobs with filters.
|
4502
|
+
#
|
4503
|
+
# @!attribute [rw] next_token
|
4504
|
+
# The pagination token returned from a previous call to
|
4505
|
+
# `ListExportJobs` to indicate the position in the list of export
|
4506
|
+
# jobs.
|
4507
|
+
# @return [String]
|
4508
|
+
#
|
4509
|
+
# @!attribute [rw] page_size
|
4510
|
+
# Maximum number of export jobs to return at once. Use this parameter
|
4511
|
+
# to paginate results. If additional export jobs exist beyond the
|
4512
|
+
# specified limit, the `NextToken` element is sent in the response.
|
4513
|
+
# Use the `NextToken` value in subsequent calls to `ListExportJobs` to
|
4514
|
+
# retrieve additional export jobs.
|
4515
|
+
# @return [Integer]
|
4516
|
+
#
|
4517
|
+
# @!attribute [rw] export_source_type
|
4518
|
+
# A value used to list export jobs that have a certain
|
4519
|
+
# `ExportSourceType`.
|
4520
|
+
# @return [String]
|
4521
|
+
#
|
4522
|
+
# @!attribute [rw] job_status
|
4523
|
+
# A value used to list export jobs that have a certain `JobStatus`.
|
4524
|
+
# @return [String]
|
4525
|
+
#
|
4526
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/ListExportJobsRequest AWS API Documentation
|
4527
|
+
#
|
4528
|
+
class ListExportJobsRequest < Struct.new(
|
4529
|
+
:next_token,
|
4530
|
+
:page_size,
|
4531
|
+
:export_source_type,
|
4532
|
+
:job_status)
|
4533
|
+
SENSITIVE = []
|
4534
|
+
include Aws::Structure
|
4535
|
+
end
|
4536
|
+
|
4537
|
+
# An HTTP 200 response if the request succeeds, or an error message if
|
4538
|
+
# the request fails.
|
4539
|
+
#
|
4540
|
+
# @!attribute [rw] export_jobs
|
4541
|
+
# A list of the export job summaries.
|
4542
|
+
# @return [Array<Types::ExportJobSummary>]
|
4543
|
+
#
|
4544
|
+
# @!attribute [rw] next_token
|
4545
|
+
# A string token indicating that there might be additional export jobs
|
4546
|
+
# available to be listed. Use this token to a subsequent call to
|
4547
|
+
# `ListExportJobs` with the same parameters to retrieve the next page
|
4548
|
+
# of export jobs.
|
4549
|
+
# @return [String]
|
4550
|
+
#
|
4551
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/ListExportJobsResponse AWS API Documentation
|
4552
|
+
#
|
4553
|
+
class ListExportJobsResponse < Struct.new(
|
4554
|
+
:export_jobs,
|
4555
|
+
:next_token)
|
4556
|
+
SENSITIVE = []
|
4557
|
+
include Aws::Structure
|
4558
|
+
end
|
4559
|
+
|
3990
4560
|
# Represents a request to list all of the import jobs for a data
|
3991
4561
|
# destination within the specified maximum number of import jobs.
|
3992
4562
|
#
|
@@ -4297,6 +4867,104 @@ module Aws::SESV2
|
|
4297
4867
|
include Aws::Structure
|
4298
4868
|
end
|
4299
4869
|
|
4870
|
+
# An object that contains filters applied when performing the Message
|
4871
|
+
# Insights export.
|
4872
|
+
#
|
4873
|
+
# @!attribute [rw] start_date
|
4874
|
+
# Represents the start date for the export interval as a timestamp.
|
4875
|
+
# The start date is inclusive.
|
4876
|
+
# @return [Time]
|
4877
|
+
#
|
4878
|
+
# @!attribute [rw] end_date
|
4879
|
+
# Represents the end date for the export interval as a timestamp. The
|
4880
|
+
# end date is inclusive.
|
4881
|
+
# @return [Time]
|
4882
|
+
#
|
4883
|
+
# @!attribute [rw] include
|
4884
|
+
# Filters for results to be included in the export file.
|
4885
|
+
# @return [Types::MessageInsightsFilters]
|
4886
|
+
#
|
4887
|
+
# @!attribute [rw] exclude
|
4888
|
+
# Filters for results to be excluded from the export file.
|
4889
|
+
# @return [Types::MessageInsightsFilters]
|
4890
|
+
#
|
4891
|
+
# @!attribute [rw] max_results
|
4892
|
+
# The maximum number of results.
|
4893
|
+
# @return [Integer]
|
4894
|
+
#
|
4895
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/MessageInsightsDataSource AWS API Documentation
|
4896
|
+
#
|
4897
|
+
class MessageInsightsDataSource < Struct.new(
|
4898
|
+
:start_date,
|
4899
|
+
:end_date,
|
4900
|
+
:include,
|
4901
|
+
:exclude,
|
4902
|
+
:max_results)
|
4903
|
+
SENSITIVE = []
|
4904
|
+
include Aws::Structure
|
4905
|
+
end
|
4906
|
+
|
4907
|
+
# An object containing Message Insights filters.
|
4908
|
+
#
|
4909
|
+
# If you specify multiple filters, the filters are joined by AND.
|
4910
|
+
#
|
4911
|
+
# If you specify multiple values for a filter, the values are joined by
|
4912
|
+
# OR. Filter values are case-sensitive.
|
4913
|
+
#
|
4914
|
+
# `FromEmailAddress`, `Destination`, and `Subject` filters support
|
4915
|
+
# partial match. A partial match is performed by using the `*` wildcard
|
4916
|
+
# character placed at the beginning (suffix match), the end (prefix
|
4917
|
+
# match) or both ends of the string (contains match). In order to match
|
4918
|
+
# the literal characters `*` or ``, they must be escaped using the ``
|
4919
|
+
# character. If no wildcard character is present, an exact match is
|
4920
|
+
# performed.
|
4921
|
+
#
|
4922
|
+
# @!attribute [rw] from_email_address
|
4923
|
+
# The from address used to send the message.
|
4924
|
+
# @return [Array<String>]
|
4925
|
+
#
|
4926
|
+
# @!attribute [rw] destination
|
4927
|
+
# The recipient's email address.
|
4928
|
+
# @return [Array<String>]
|
4929
|
+
#
|
4930
|
+
# @!attribute [rw] subject
|
4931
|
+
# The subject line of the message.
|
4932
|
+
# @return [Array<String>]
|
4933
|
+
#
|
4934
|
+
# @!attribute [rw] isp
|
4935
|
+
# The recipient's ISP (e.g., `Gmail`, `Yahoo`, etc.).
|
4936
|
+
# @return [Array<String>]
|
4937
|
+
#
|
4938
|
+
# @!attribute [rw] last_delivery_event
|
4939
|
+
# The last delivery-related event for the email, where the ordering is
|
4940
|
+
# as follows: `SEND` < `BOUNCE` < `DELIVERY` < `COMPLAINT`.
|
4941
|
+
# @return [Array<String>]
|
4942
|
+
#
|
4943
|
+
# @!attribute [rw] last_engagement_event
|
4944
|
+
# The last engagement-related event for the email, where the ordering
|
4945
|
+
# is as follows: `OPEN` < `CLICK`.
|
4946
|
+
#
|
4947
|
+
# Engagement events are only available if [Engagement tracking][1] is
|
4948
|
+
# enabled.
|
4949
|
+
#
|
4950
|
+
#
|
4951
|
+
#
|
4952
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/dg/vdm-settings.html
|
4953
|
+
# @return [Array<String>]
|
4954
|
+
#
|
4955
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/MessageInsightsFilters AWS API Documentation
|
4956
|
+
#
|
4957
|
+
class MessageInsightsFilters < Struct.new(
|
4958
|
+
:from_email_address,
|
4959
|
+
:destination,
|
4960
|
+
:subject,
|
4961
|
+
:isp,
|
4962
|
+
:last_delivery_event,
|
4963
|
+
:last_engagement_event)
|
4964
|
+
SENSITIVE = []
|
4965
|
+
include Aws::Structure
|
4966
|
+
end
|
4967
|
+
|
4300
4968
|
# The message can't be sent because it contains invalid content.
|
4301
4969
|
#
|
4302
4970
|
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/MessageRejected AWS API Documentation
|
@@ -4390,6 +5058,43 @@ module Aws::SESV2
|
|
4390
5058
|
include Aws::Structure
|
4391
5059
|
end
|
4392
5060
|
|
5061
|
+
# An object that contains details about the data source for the metrics
|
5062
|
+
# export.
|
5063
|
+
#
|
5064
|
+
# @!attribute [rw] dimensions
|
5065
|
+
# An object that contains a mapping between a `MetricDimensionName`
|
5066
|
+
# and `MetricDimensionValue` to filter metrics by. Must contain a
|
5067
|
+
# least 1 dimension but no more than 3 unique ones.
|
5068
|
+
# @return [Hash<String,Array<String>>]
|
5069
|
+
#
|
5070
|
+
# @!attribute [rw] namespace
|
5071
|
+
# The metrics namespace - e.g., `VDM`.
|
5072
|
+
# @return [String]
|
5073
|
+
#
|
5074
|
+
# @!attribute [rw] metrics
|
5075
|
+
# A list of `ExportMetric` objects to export.
|
5076
|
+
# @return [Array<Types::ExportMetric>]
|
5077
|
+
#
|
5078
|
+
# @!attribute [rw] start_date
|
5079
|
+
# Represents the start date for the export interval as a timestamp.
|
5080
|
+
# @return [Time]
|
5081
|
+
#
|
5082
|
+
# @!attribute [rw] end_date
|
5083
|
+
# Represents the end date for the export interval as a timestamp.
|
5084
|
+
# @return [Time]
|
5085
|
+
#
|
5086
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/MetricsDataSource AWS API Documentation
|
5087
|
+
#
|
5088
|
+
class MetricsDataSource < Struct.new(
|
5089
|
+
:dimensions,
|
5090
|
+
:namespace,
|
5091
|
+
:metrics,
|
5092
|
+
:start_date,
|
5093
|
+
:end_date)
|
5094
|
+
SENSITIVE = []
|
5095
|
+
include Aws::Structure
|
5096
|
+
end
|
5097
|
+
|
4393
5098
|
# The resource you attempted to access doesn't exist.
|
4394
5099
|
#
|
4395
5100
|
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/NotFoundException AWS API Documentation
|