aws-sdk-sesv2 1.38.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 +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-sesv2/client.rb +501 -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
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: da7e1e8c51c4847955e90f53f6c19d8918e816b7d3c151afbe95447f7e2015ff
|
|
4
|
+
data.tar.gz: 691366e00ef84fc2079e91fc5b30105ad612fc1a888b346d0ed15b75849c5f30
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: da86ffce71ffae16d6e711e8a844254812ce279e96bae0e8ffc773aff3679b8ef5ec18acea5e8250291037433a086f31fe186d54f4a840b71fdb0ee2b412d70f
|
|
7
|
+
data.tar.gz: 4d2efddfb6859ac071e25b4d65f1d9eecd6d7cae4f084ea78b3c4b71ef4dcee685bf9be3e7c88b39df05c8358b55d6796aaaff466765f6f42b1bfc61ba42cd22
|
data/CHANGELOG.md
CHANGED
|
@@ -1,6 +1,11 @@
|
|
|
1
1
|
Unreleased Changes
|
|
2
2
|
------------------
|
|
3
3
|
|
|
4
|
+
1.39.0 (2023-08-29)
|
|
5
|
+
------------------
|
|
6
|
+
|
|
7
|
+
* Feature - Adds support for the new Export and Message Insights features: create, get, list and cancel export jobs; get message insights.
|
|
8
|
+
|
|
4
9
|
1.38.0 (2023-07-11)
|
|
5
10
|
------------------
|
|
6
11
|
|
data/VERSION
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
1.
|
|
1
|
+
1.39.0
|
data/lib/aws-sdk-sesv2/client.rb
CHANGED
|
@@ -441,6 +441,37 @@ module Aws::SESV2
|
|
|
441
441
|
req.send_request(options)
|
|
442
442
|
end
|
|
443
443
|
|
|
444
|
+
# Cancels an export job.
|
|
445
|
+
#
|
|
446
|
+
# @option params [required, String] :job_id
|
|
447
|
+
# The export job ID.
|
|
448
|
+
#
|
|
449
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
|
450
|
+
#
|
|
451
|
+
#
|
|
452
|
+
# @example Example: Cancel export job
|
|
453
|
+
#
|
|
454
|
+
# # Cancels the export job with ID ef28cf62-9d8e-4b60-9283-b09816c99a99
|
|
455
|
+
#
|
|
456
|
+
# resp = client.cancel_export_job({
|
|
457
|
+
# job_id: "ef28cf62-9d8e-4b60-9283-b09816c99a99",
|
|
458
|
+
# })
|
|
459
|
+
#
|
|
460
|
+
# @example Request syntax with placeholder values
|
|
461
|
+
#
|
|
462
|
+
# resp = client.cancel_export_job({
|
|
463
|
+
# job_id: "JobId", # required
|
|
464
|
+
# })
|
|
465
|
+
#
|
|
466
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/CancelExportJob AWS API Documentation
|
|
467
|
+
#
|
|
468
|
+
# @overload cancel_export_job(params = {})
|
|
469
|
+
# @param [Hash] params ({})
|
|
470
|
+
def cancel_export_job(params = {}, options = {})
|
|
471
|
+
req = build_request(:cancel_export_job, params)
|
|
472
|
+
req.send_request(options)
|
|
473
|
+
end
|
|
474
|
+
|
|
444
475
|
# Create a configuration set. *Configuration sets* are groups of rules
|
|
445
476
|
# that you can apply to the emails that you send. You apply a
|
|
446
477
|
# configuration set to an email by specifying the name of the
|
|
@@ -1076,6 +1107,152 @@ module Aws::SESV2
|
|
|
1076
1107
|
req.send_request(options)
|
|
1077
1108
|
end
|
|
1078
1109
|
|
|
1110
|
+
# Creates an export job for a data source and destination.
|
|
1111
|
+
#
|
|
1112
|
+
# You can execute this operation no more than once per second.
|
|
1113
|
+
#
|
|
1114
|
+
# @option params [required, Types::ExportDataSource] :export_data_source
|
|
1115
|
+
# The data source for the export job.
|
|
1116
|
+
#
|
|
1117
|
+
# @option params [required, Types::ExportDestination] :export_destination
|
|
1118
|
+
# The destination for the export job.
|
|
1119
|
+
#
|
|
1120
|
+
# @return [Types::CreateExportJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1121
|
+
#
|
|
1122
|
+
# * {Types::CreateExportJobResponse#job_id #job_id} => String
|
|
1123
|
+
#
|
|
1124
|
+
#
|
|
1125
|
+
# @example Example: Create Metrics export job
|
|
1126
|
+
#
|
|
1127
|
+
# # Creates a new export job for Metrics data
|
|
1128
|
+
#
|
|
1129
|
+
# resp = client.create_export_job({
|
|
1130
|
+
# export_data_source: {
|
|
1131
|
+
# metrics_data_source: {
|
|
1132
|
+
# dimensions: {
|
|
1133
|
+
# "ISP" => [
|
|
1134
|
+
# "*",
|
|
1135
|
+
# ],
|
|
1136
|
+
# },
|
|
1137
|
+
# end_date: Time.parse("2023-07-02T00:00:00"),
|
|
1138
|
+
# metrics: [
|
|
1139
|
+
# {
|
|
1140
|
+
# aggregation: "VOLUME",
|
|
1141
|
+
# name: "SEND",
|
|
1142
|
+
# },
|
|
1143
|
+
# {
|
|
1144
|
+
# aggregation: "VOLUME",
|
|
1145
|
+
# name: "COMPLAINT",
|
|
1146
|
+
# },
|
|
1147
|
+
# {
|
|
1148
|
+
# aggregation: "RATE",
|
|
1149
|
+
# name: "COMPLAINT",
|
|
1150
|
+
# },
|
|
1151
|
+
# ],
|
|
1152
|
+
# namespace: "VDM",
|
|
1153
|
+
# start_date: Time.parse("2023-07-01T00:00:00"),
|
|
1154
|
+
# },
|
|
1155
|
+
# },
|
|
1156
|
+
# export_destination: {
|
|
1157
|
+
# data_format: "CSV",
|
|
1158
|
+
# },
|
|
1159
|
+
# })
|
|
1160
|
+
#
|
|
1161
|
+
# resp.to_h outputs the following:
|
|
1162
|
+
# {
|
|
1163
|
+
# job_id: "ef28cf62-9d8e-4b60-9283-b09816c99a99",
|
|
1164
|
+
# }
|
|
1165
|
+
#
|
|
1166
|
+
# @example Example: Create Message Insights export job
|
|
1167
|
+
#
|
|
1168
|
+
# # Creates a new export job for Message Insights data
|
|
1169
|
+
#
|
|
1170
|
+
# resp = client.create_export_job({
|
|
1171
|
+
# export_data_source: {
|
|
1172
|
+
# message_insights_data_source: {
|
|
1173
|
+
# end_date: Time.parse("2023-07-02T00:00:00"),
|
|
1174
|
+
# exclude: {
|
|
1175
|
+
# from_email_address: [
|
|
1176
|
+
# "hello@example.com",
|
|
1177
|
+
# ],
|
|
1178
|
+
# },
|
|
1179
|
+
# include: {
|
|
1180
|
+
# subject: [
|
|
1181
|
+
# "Hello",
|
|
1182
|
+
# ],
|
|
1183
|
+
# },
|
|
1184
|
+
# start_date: Time.parse("2023-07-01T00:00:00"),
|
|
1185
|
+
# },
|
|
1186
|
+
# },
|
|
1187
|
+
# export_destination: {
|
|
1188
|
+
# data_format: "CSV",
|
|
1189
|
+
# },
|
|
1190
|
+
# })
|
|
1191
|
+
#
|
|
1192
|
+
# resp.to_h outputs the following:
|
|
1193
|
+
# {
|
|
1194
|
+
# job_id: "ef28cf62-9d8e-4b60-9283-b09816c99a99",
|
|
1195
|
+
# }
|
|
1196
|
+
#
|
|
1197
|
+
# @example Request syntax with placeholder values
|
|
1198
|
+
#
|
|
1199
|
+
# resp = client.create_export_job({
|
|
1200
|
+
# export_data_source: { # required
|
|
1201
|
+
# metrics_data_source: {
|
|
1202
|
+
# dimensions: { # required
|
|
1203
|
+
# "EMAIL_IDENTITY" => ["MetricDimensionValue"],
|
|
1204
|
+
# },
|
|
1205
|
+
# namespace: "VDM", # required, accepts VDM
|
|
1206
|
+
# metrics: [ # required
|
|
1207
|
+
# {
|
|
1208
|
+
# name: "SEND", # accepts SEND, COMPLAINT, PERMANENT_BOUNCE, TRANSIENT_BOUNCE, OPEN, CLICK, DELIVERY, DELIVERY_OPEN, DELIVERY_CLICK, DELIVERY_COMPLAINT
|
|
1209
|
+
# aggregation: "RATE", # accepts RATE, VOLUME
|
|
1210
|
+
# },
|
|
1211
|
+
# ],
|
|
1212
|
+
# start_date: Time.now, # required
|
|
1213
|
+
# end_date: Time.now, # required
|
|
1214
|
+
# },
|
|
1215
|
+
# message_insights_data_source: {
|
|
1216
|
+
# start_date: Time.now, # required
|
|
1217
|
+
# end_date: Time.now, # required
|
|
1218
|
+
# include: {
|
|
1219
|
+
# from_email_address: ["InsightsEmailAddress"],
|
|
1220
|
+
# destination: ["InsightsEmailAddress"],
|
|
1221
|
+
# subject: ["EmailSubject"],
|
|
1222
|
+
# isp: ["Isp"],
|
|
1223
|
+
# last_delivery_event: ["SEND"], # accepts SEND, DELIVERY, TRANSIENT_BOUNCE, PERMANENT_BOUNCE, UNDETERMINED_BOUNCE, COMPLAINT
|
|
1224
|
+
# last_engagement_event: ["OPEN"], # accepts OPEN, CLICK
|
|
1225
|
+
# },
|
|
1226
|
+
# exclude: {
|
|
1227
|
+
# from_email_address: ["InsightsEmailAddress"],
|
|
1228
|
+
# destination: ["InsightsEmailAddress"],
|
|
1229
|
+
# subject: ["EmailSubject"],
|
|
1230
|
+
# isp: ["Isp"],
|
|
1231
|
+
# last_delivery_event: ["SEND"], # accepts SEND, DELIVERY, TRANSIENT_BOUNCE, PERMANENT_BOUNCE, UNDETERMINED_BOUNCE, COMPLAINT
|
|
1232
|
+
# last_engagement_event: ["OPEN"], # accepts OPEN, CLICK
|
|
1233
|
+
# },
|
|
1234
|
+
# max_results: 1,
|
|
1235
|
+
# },
|
|
1236
|
+
# },
|
|
1237
|
+
# export_destination: { # required
|
|
1238
|
+
# data_format: "CSV", # required, accepts CSV, JSON
|
|
1239
|
+
# s3_url: "S3Url",
|
|
1240
|
+
# },
|
|
1241
|
+
# })
|
|
1242
|
+
#
|
|
1243
|
+
# @example Response structure
|
|
1244
|
+
#
|
|
1245
|
+
# resp.job_id #=> String
|
|
1246
|
+
#
|
|
1247
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/CreateExportJob AWS API Documentation
|
|
1248
|
+
#
|
|
1249
|
+
# @overload create_export_job(params = {})
|
|
1250
|
+
# @param [Hash] params ({})
|
|
1251
|
+
def create_export_job(params = {}, options = {})
|
|
1252
|
+
req = build_request(:create_export_job, params)
|
|
1253
|
+
req.send_request(options)
|
|
1254
|
+
end
|
|
1255
|
+
|
|
1079
1256
|
# Creates an import job for a data destination.
|
|
1080
1257
|
#
|
|
1081
1258
|
# @option params [required, Types::ImportDestination] :import_destination
|
|
@@ -2197,6 +2374,138 @@ module Aws::SESV2
|
|
|
2197
2374
|
req.send_request(options)
|
|
2198
2375
|
end
|
|
2199
2376
|
|
|
2377
|
+
# Provides information about an export job.
|
|
2378
|
+
#
|
|
2379
|
+
# @option params [required, String] :job_id
|
|
2380
|
+
# The export job ID.
|
|
2381
|
+
#
|
|
2382
|
+
# @return [Types::GetExportJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
2383
|
+
#
|
|
2384
|
+
# * {Types::GetExportJobResponse#job_id #job_id} => String
|
|
2385
|
+
# * {Types::GetExportJobResponse#export_source_type #export_source_type} => String
|
|
2386
|
+
# * {Types::GetExportJobResponse#job_status #job_status} => String
|
|
2387
|
+
# * {Types::GetExportJobResponse#export_destination #export_destination} => Types::ExportDestination
|
|
2388
|
+
# * {Types::GetExportJobResponse#export_data_source #export_data_source} => Types::ExportDataSource
|
|
2389
|
+
# * {Types::GetExportJobResponse#created_timestamp #created_timestamp} => Time
|
|
2390
|
+
# * {Types::GetExportJobResponse#completed_timestamp #completed_timestamp} => Time
|
|
2391
|
+
# * {Types::GetExportJobResponse#failure_info #failure_info} => Types::FailureInfo
|
|
2392
|
+
# * {Types::GetExportJobResponse#statistics #statistics} => Types::ExportStatistics
|
|
2393
|
+
#
|
|
2394
|
+
#
|
|
2395
|
+
# @example Example: Get export job
|
|
2396
|
+
#
|
|
2397
|
+
# # Gets the export job with ID ef28cf62-9d8e-4b60-9283-b09816c99a99
|
|
2398
|
+
#
|
|
2399
|
+
# resp = client.get_export_job({
|
|
2400
|
+
# job_id: "ef28cf62-9d8e-4b60-9283-b09816c99a99",
|
|
2401
|
+
# })
|
|
2402
|
+
#
|
|
2403
|
+
# resp.to_h outputs the following:
|
|
2404
|
+
# {
|
|
2405
|
+
# created_timestamp: Time.parse("1685700961057"),
|
|
2406
|
+
# export_data_source: {
|
|
2407
|
+
# metrics_data_source: {
|
|
2408
|
+
# dimensions: {
|
|
2409
|
+
# "ISP" => [
|
|
2410
|
+
# "*",
|
|
2411
|
+
# ],
|
|
2412
|
+
# },
|
|
2413
|
+
# end_date: Time.parse("1675209600000"),
|
|
2414
|
+
# metrics: [
|
|
2415
|
+
# {
|
|
2416
|
+
# aggregation: "VOLUME",
|
|
2417
|
+
# name: "SEND",
|
|
2418
|
+
# },
|
|
2419
|
+
# {
|
|
2420
|
+
# aggregation: "VOLUME",
|
|
2421
|
+
# name: "COMPLAINT",
|
|
2422
|
+
# },
|
|
2423
|
+
# {
|
|
2424
|
+
# aggregation: "RATE",
|
|
2425
|
+
# name: "COMPLAINT",
|
|
2426
|
+
# },
|
|
2427
|
+
# ],
|
|
2428
|
+
# namespace: "VDM",
|
|
2429
|
+
# start_date: Time.parse("1672531200000"),
|
|
2430
|
+
# },
|
|
2431
|
+
# },
|
|
2432
|
+
# export_destination: {
|
|
2433
|
+
# data_format: "CSV",
|
|
2434
|
+
# },
|
|
2435
|
+
# export_source_type: "METRICS_DATA",
|
|
2436
|
+
# job_id: "ef28cf62-9d8e-4b60-9283-b09816c99a99",
|
|
2437
|
+
# job_status: "PROCESSING",
|
|
2438
|
+
# statistics: {
|
|
2439
|
+
# exported_records_count: 5,
|
|
2440
|
+
# processed_records_count: 5,
|
|
2441
|
+
# },
|
|
2442
|
+
# }
|
|
2443
|
+
#
|
|
2444
|
+
# @example Request syntax with placeholder values
|
|
2445
|
+
#
|
|
2446
|
+
# resp = client.get_export_job({
|
|
2447
|
+
# job_id: "JobId", # required
|
|
2448
|
+
# })
|
|
2449
|
+
#
|
|
2450
|
+
# @example Response structure
|
|
2451
|
+
#
|
|
2452
|
+
# resp.job_id #=> String
|
|
2453
|
+
# resp.export_source_type #=> String, one of "METRICS_DATA", "MESSAGE_INSIGHTS"
|
|
2454
|
+
# resp.job_status #=> String, one of "CREATED", "PROCESSING", "COMPLETED", "FAILED", "CANCELLED"
|
|
2455
|
+
# resp.export_destination.data_format #=> String, one of "CSV", "JSON"
|
|
2456
|
+
# resp.export_destination.s3_url #=> String
|
|
2457
|
+
# resp.export_data_source.metrics_data_source.dimensions #=> Hash
|
|
2458
|
+
# resp.export_data_source.metrics_data_source.dimensions["MetricDimensionName"] #=> Array
|
|
2459
|
+
# resp.export_data_source.metrics_data_source.dimensions["MetricDimensionName"][0] #=> String
|
|
2460
|
+
# resp.export_data_source.metrics_data_source.namespace #=> String, one of "VDM"
|
|
2461
|
+
# resp.export_data_source.metrics_data_source.metrics #=> Array
|
|
2462
|
+
# resp.export_data_source.metrics_data_source.metrics[0].name #=> String, one of "SEND", "COMPLAINT", "PERMANENT_BOUNCE", "TRANSIENT_BOUNCE", "OPEN", "CLICK", "DELIVERY", "DELIVERY_OPEN", "DELIVERY_CLICK", "DELIVERY_COMPLAINT"
|
|
2463
|
+
# resp.export_data_source.metrics_data_source.metrics[0].aggregation #=> String, one of "RATE", "VOLUME"
|
|
2464
|
+
# resp.export_data_source.metrics_data_source.start_date #=> Time
|
|
2465
|
+
# resp.export_data_source.metrics_data_source.end_date #=> Time
|
|
2466
|
+
# resp.export_data_source.message_insights_data_source.start_date #=> Time
|
|
2467
|
+
# resp.export_data_source.message_insights_data_source.end_date #=> Time
|
|
2468
|
+
# resp.export_data_source.message_insights_data_source.include.from_email_address #=> Array
|
|
2469
|
+
# resp.export_data_source.message_insights_data_source.include.from_email_address[0] #=> String
|
|
2470
|
+
# resp.export_data_source.message_insights_data_source.include.destination #=> Array
|
|
2471
|
+
# resp.export_data_source.message_insights_data_source.include.destination[0] #=> String
|
|
2472
|
+
# resp.export_data_source.message_insights_data_source.include.subject #=> Array
|
|
2473
|
+
# resp.export_data_source.message_insights_data_source.include.subject[0] #=> String
|
|
2474
|
+
# resp.export_data_source.message_insights_data_source.include.isp #=> Array
|
|
2475
|
+
# resp.export_data_source.message_insights_data_source.include.isp[0] #=> String
|
|
2476
|
+
# resp.export_data_source.message_insights_data_source.include.last_delivery_event #=> Array
|
|
2477
|
+
# resp.export_data_source.message_insights_data_source.include.last_delivery_event[0] #=> String, one of "SEND", "DELIVERY", "TRANSIENT_BOUNCE", "PERMANENT_BOUNCE", "UNDETERMINED_BOUNCE", "COMPLAINT"
|
|
2478
|
+
# resp.export_data_source.message_insights_data_source.include.last_engagement_event #=> Array
|
|
2479
|
+
# resp.export_data_source.message_insights_data_source.include.last_engagement_event[0] #=> String, one of "OPEN", "CLICK"
|
|
2480
|
+
# resp.export_data_source.message_insights_data_source.exclude.from_email_address #=> Array
|
|
2481
|
+
# resp.export_data_source.message_insights_data_source.exclude.from_email_address[0] #=> String
|
|
2482
|
+
# resp.export_data_source.message_insights_data_source.exclude.destination #=> Array
|
|
2483
|
+
# resp.export_data_source.message_insights_data_source.exclude.destination[0] #=> String
|
|
2484
|
+
# resp.export_data_source.message_insights_data_source.exclude.subject #=> Array
|
|
2485
|
+
# resp.export_data_source.message_insights_data_source.exclude.subject[0] #=> String
|
|
2486
|
+
# resp.export_data_source.message_insights_data_source.exclude.isp #=> Array
|
|
2487
|
+
# resp.export_data_source.message_insights_data_source.exclude.isp[0] #=> String
|
|
2488
|
+
# resp.export_data_source.message_insights_data_source.exclude.last_delivery_event #=> Array
|
|
2489
|
+
# resp.export_data_source.message_insights_data_source.exclude.last_delivery_event[0] #=> String, one of "SEND", "DELIVERY", "TRANSIENT_BOUNCE", "PERMANENT_BOUNCE", "UNDETERMINED_BOUNCE", "COMPLAINT"
|
|
2490
|
+
# resp.export_data_source.message_insights_data_source.exclude.last_engagement_event #=> Array
|
|
2491
|
+
# resp.export_data_source.message_insights_data_source.exclude.last_engagement_event[0] #=> String, one of "OPEN", "CLICK"
|
|
2492
|
+
# resp.export_data_source.message_insights_data_source.max_results #=> Integer
|
|
2493
|
+
# resp.created_timestamp #=> Time
|
|
2494
|
+
# resp.completed_timestamp #=> Time
|
|
2495
|
+
# resp.failure_info.failed_records_s3_url #=> String
|
|
2496
|
+
# resp.failure_info.error_message #=> String
|
|
2497
|
+
# resp.statistics.processed_records_count #=> Integer
|
|
2498
|
+
# resp.statistics.exported_records_count #=> Integer
|
|
2499
|
+
#
|
|
2500
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/GetExportJob AWS API Documentation
|
|
2501
|
+
#
|
|
2502
|
+
# @overload get_export_job(params = {})
|
|
2503
|
+
# @param [Hash] params ({})
|
|
2504
|
+
def get_export_job(params = {}, options = {})
|
|
2505
|
+
req = build_request(:get_export_job, params)
|
|
2506
|
+
req.send_request(options)
|
|
2507
|
+
end
|
|
2508
|
+
|
|
2200
2509
|
# Provides information about an import job.
|
|
2201
2510
|
#
|
|
2202
2511
|
# @option params [required, String] :job_id
|
|
@@ -2230,7 +2539,7 @@ module Aws::SESV2
|
|
|
2230
2539
|
# resp.import_data_source.data_format #=> String, one of "CSV", "JSON"
|
|
2231
2540
|
# resp.failure_info.failed_records_s3_url #=> String
|
|
2232
2541
|
# resp.failure_info.error_message #=> String
|
|
2233
|
-
# resp.job_status #=> String, one of "CREATED", "PROCESSING", "COMPLETED", "FAILED"
|
|
2542
|
+
# resp.job_status #=> String, one of "CREATED", "PROCESSING", "COMPLETED", "FAILED", "CANCELLED"
|
|
2234
2543
|
# resp.created_timestamp #=> Time
|
|
2235
2544
|
# resp.completed_timestamp #=> Time
|
|
2236
2545
|
# resp.processed_records_count #=> Integer
|
|
@@ -2245,6 +2554,117 @@ module Aws::SESV2
|
|
|
2245
2554
|
req.send_request(options)
|
|
2246
2555
|
end
|
|
2247
2556
|
|
|
2557
|
+
# Provides information about a specific message, including the from
|
|
2558
|
+
# address, the subject, the recipient address, email tags, as well as
|
|
2559
|
+
# events associated with the message.
|
|
2560
|
+
#
|
|
2561
|
+
# You can execute this operation no more than once per second.
|
|
2562
|
+
#
|
|
2563
|
+
# @option params [required, String] :message_id
|
|
2564
|
+
# A `MessageId` is a unique identifier for a message, and is returned
|
|
2565
|
+
# when sending emails through Amazon SES.
|
|
2566
|
+
#
|
|
2567
|
+
# @return [Types::GetMessageInsightsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
2568
|
+
#
|
|
2569
|
+
# * {Types::GetMessageInsightsResponse#message_id #message_id} => String
|
|
2570
|
+
# * {Types::GetMessageInsightsResponse#from_email_address #from_email_address} => String
|
|
2571
|
+
# * {Types::GetMessageInsightsResponse#subject #subject} => String
|
|
2572
|
+
# * {Types::GetMessageInsightsResponse#email_tags #email_tags} => Array<Types::MessageTag>
|
|
2573
|
+
# * {Types::GetMessageInsightsResponse#insights #insights} => Array<Types::EmailInsights>
|
|
2574
|
+
#
|
|
2575
|
+
#
|
|
2576
|
+
# @example Example: Get Message Insights
|
|
2577
|
+
#
|
|
2578
|
+
# # Provides information about a specific message.
|
|
2579
|
+
#
|
|
2580
|
+
# resp = client.get_message_insights({
|
|
2581
|
+
# message_id: "000000000000ab00-0a000aa0-1234-0a0a-1234-0a0aaa0aa00a-000000",
|
|
2582
|
+
# })
|
|
2583
|
+
#
|
|
2584
|
+
# resp.to_h outputs the following:
|
|
2585
|
+
# {
|
|
2586
|
+
# email_tags: [
|
|
2587
|
+
# {
|
|
2588
|
+
# name: "ses:operation",
|
|
2589
|
+
# value: "SendEmail",
|
|
2590
|
+
# },
|
|
2591
|
+
# {
|
|
2592
|
+
# name: "ses:recipient-isp",
|
|
2593
|
+
# value: "UNKNOWN_ISP",
|
|
2594
|
+
# },
|
|
2595
|
+
# {
|
|
2596
|
+
# name: "ses:source-ip",
|
|
2597
|
+
# value: "0.0.0.0",
|
|
2598
|
+
# },
|
|
2599
|
+
# {
|
|
2600
|
+
# name: "ses:from-domain",
|
|
2601
|
+
# value: "example.com",
|
|
2602
|
+
# },
|
|
2603
|
+
# {
|
|
2604
|
+
# name: "ses:sender-identity",
|
|
2605
|
+
# value: "hello@example.com",
|
|
2606
|
+
# },
|
|
2607
|
+
# {
|
|
2608
|
+
# name: "ses:caller-identity",
|
|
2609
|
+
# value: "Identity",
|
|
2610
|
+
# },
|
|
2611
|
+
# ],
|
|
2612
|
+
# from_email_address: "hello@example.com",
|
|
2613
|
+
# insights: [
|
|
2614
|
+
# {
|
|
2615
|
+
# destination: "recipient@example.com",
|
|
2616
|
+
# events: [
|
|
2617
|
+
# {
|
|
2618
|
+
# timestamp: Time.parse("2023-01-01T00:00:00.000000+01:00"),
|
|
2619
|
+
# type: "SEND",
|
|
2620
|
+
# },
|
|
2621
|
+
# {
|
|
2622
|
+
# timestamp: Time.parse("2023-01-01T00:00:01.000000+01:00"),
|
|
2623
|
+
# type: "DELIVERY",
|
|
2624
|
+
# },
|
|
2625
|
+
# ],
|
|
2626
|
+
# isp: "UNKNOWN_ISP",
|
|
2627
|
+
# },
|
|
2628
|
+
# ],
|
|
2629
|
+
# message_id: "000000000000ab00-0a000aa0-1234-0a0a-1234-0a0aaa0aa00a-000000",
|
|
2630
|
+
# subject: "hello",
|
|
2631
|
+
# }
|
|
2632
|
+
#
|
|
2633
|
+
# @example Request syntax with placeholder values
|
|
2634
|
+
#
|
|
2635
|
+
# resp = client.get_message_insights({
|
|
2636
|
+
# message_id: "OutboundMessageId", # required
|
|
2637
|
+
# })
|
|
2638
|
+
#
|
|
2639
|
+
# @example Response structure
|
|
2640
|
+
#
|
|
2641
|
+
# resp.message_id #=> String
|
|
2642
|
+
# resp.from_email_address #=> String
|
|
2643
|
+
# resp.subject #=> String
|
|
2644
|
+
# resp.email_tags #=> Array
|
|
2645
|
+
# resp.email_tags[0].name #=> String
|
|
2646
|
+
# resp.email_tags[0].value #=> String
|
|
2647
|
+
# resp.insights #=> Array
|
|
2648
|
+
# resp.insights[0].destination #=> String
|
|
2649
|
+
# resp.insights[0].isp #=> String
|
|
2650
|
+
# resp.insights[0].events #=> Array
|
|
2651
|
+
# resp.insights[0].events[0].timestamp #=> Time
|
|
2652
|
+
# resp.insights[0].events[0].type #=> String, one of "SEND", "REJECT", "BOUNCE", "COMPLAINT", "DELIVERY", "OPEN", "CLICK", "RENDERING_FAILURE", "DELIVERY_DELAY", "SUBSCRIPTION"
|
|
2653
|
+
# resp.insights[0].events[0].details.bounce.bounce_type #=> String, one of "UNDETERMINED", "TRANSIENT", "PERMANENT"
|
|
2654
|
+
# resp.insights[0].events[0].details.bounce.bounce_sub_type #=> String
|
|
2655
|
+
# resp.insights[0].events[0].details.bounce.diagnostic_code #=> String
|
|
2656
|
+
# resp.insights[0].events[0].details.complaint.complaint_sub_type #=> String
|
|
2657
|
+
# resp.insights[0].events[0].details.complaint.complaint_feedback_type #=> String
|
|
2658
|
+
#
|
|
2659
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/GetMessageInsights AWS API Documentation
|
|
2660
|
+
#
|
|
2661
|
+
# @overload get_message_insights(params = {})
|
|
2662
|
+
# @param [Hash] params ({})
|
|
2663
|
+
def get_message_insights(params = {}, options = {})
|
|
2664
|
+
req = build_request(:get_message_insights, params)
|
|
2665
|
+
req.send_request(options)
|
|
2666
|
+
end
|
|
2667
|
+
|
|
2248
2668
|
# Retrieves information about a specific email address that's on the
|
|
2249
2669
|
# suppression list for your account.
|
|
2250
2670
|
#
|
|
@@ -2769,6 +3189,84 @@ module Aws::SESV2
|
|
|
2769
3189
|
req.send_request(options)
|
|
2770
3190
|
end
|
|
2771
3191
|
|
|
3192
|
+
# Lists all of the export jobs.
|
|
3193
|
+
#
|
|
3194
|
+
# @option params [String] :next_token
|
|
3195
|
+
# The pagination token returned from a previous call to `ListExportJobs`
|
|
3196
|
+
# to indicate the position in the list of export jobs.
|
|
3197
|
+
#
|
|
3198
|
+
# @option params [Integer] :page_size
|
|
3199
|
+
# Maximum number of export jobs to return at once. Use this parameter to
|
|
3200
|
+
# paginate results. If additional export jobs exist beyond the specified
|
|
3201
|
+
# limit, the `NextToken` element is sent in the response. Use the
|
|
3202
|
+
# `NextToken` value in subsequent calls to `ListExportJobs` to retrieve
|
|
3203
|
+
# additional export jobs.
|
|
3204
|
+
#
|
|
3205
|
+
# @option params [String] :export_source_type
|
|
3206
|
+
# A value used to list export jobs that have a certain
|
|
3207
|
+
# `ExportSourceType`.
|
|
3208
|
+
#
|
|
3209
|
+
# @option params [String] :job_status
|
|
3210
|
+
# A value used to list export jobs that have a certain `JobStatus`.
|
|
3211
|
+
#
|
|
3212
|
+
# @return [Types::ListExportJobsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
3213
|
+
#
|
|
3214
|
+
# * {Types::ListExportJobsResponse#export_jobs #export_jobs} => Array<Types::ExportJobSummary>
|
|
3215
|
+
# * {Types::ListExportJobsResponse#next_token #next_token} => String
|
|
3216
|
+
#
|
|
3217
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
|
3218
|
+
#
|
|
3219
|
+
#
|
|
3220
|
+
# @example Example: List export jobs
|
|
3221
|
+
#
|
|
3222
|
+
# # Lists export jobs of type METRICS_DATA and status PROCESSING
|
|
3223
|
+
#
|
|
3224
|
+
# resp = client.list_export_jobs({
|
|
3225
|
+
# export_source_type: "METRICS_DATA",
|
|
3226
|
+
# job_status: "PROCESSING",
|
|
3227
|
+
# page_size: 25,
|
|
3228
|
+
# })
|
|
3229
|
+
#
|
|
3230
|
+
# resp.to_h outputs the following:
|
|
3231
|
+
# {
|
|
3232
|
+
# export_jobs: [
|
|
3233
|
+
# {
|
|
3234
|
+
# created_timestamp: Time.parse("167697473543"),
|
|
3235
|
+
# export_source_type: "METRICS_DATA",
|
|
3236
|
+
# job_id: "72de83a0-6b49-47ca-9783-8b812576887a",
|
|
3237
|
+
# job_status: "PROCESSING",
|
|
3238
|
+
# },
|
|
3239
|
+
# ],
|
|
3240
|
+
# }
|
|
3241
|
+
#
|
|
3242
|
+
# @example Request syntax with placeholder values
|
|
3243
|
+
#
|
|
3244
|
+
# resp = client.list_export_jobs({
|
|
3245
|
+
# next_token: "NextToken",
|
|
3246
|
+
# page_size: 1,
|
|
3247
|
+
# export_source_type: "METRICS_DATA", # accepts METRICS_DATA, MESSAGE_INSIGHTS
|
|
3248
|
+
# job_status: "CREATED", # accepts CREATED, PROCESSING, COMPLETED, FAILED, CANCELLED
|
|
3249
|
+
# })
|
|
3250
|
+
#
|
|
3251
|
+
# @example Response structure
|
|
3252
|
+
#
|
|
3253
|
+
# resp.export_jobs #=> Array
|
|
3254
|
+
# resp.export_jobs[0].job_id #=> String
|
|
3255
|
+
# resp.export_jobs[0].export_source_type #=> String, one of "METRICS_DATA", "MESSAGE_INSIGHTS"
|
|
3256
|
+
# resp.export_jobs[0].job_status #=> String, one of "CREATED", "PROCESSING", "COMPLETED", "FAILED", "CANCELLED"
|
|
3257
|
+
# resp.export_jobs[0].created_timestamp #=> Time
|
|
3258
|
+
# resp.export_jobs[0].completed_timestamp #=> Time
|
|
3259
|
+
# resp.next_token #=> String
|
|
3260
|
+
#
|
|
3261
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/ListExportJobs AWS API Documentation
|
|
3262
|
+
#
|
|
3263
|
+
# @overload list_export_jobs(params = {})
|
|
3264
|
+
# @param [Hash] params ({})
|
|
3265
|
+
def list_export_jobs(params = {}, options = {})
|
|
3266
|
+
req = build_request(:list_export_jobs, params)
|
|
3267
|
+
req.send_request(options)
|
|
3268
|
+
end
|
|
3269
|
+
|
|
2772
3270
|
# Lists all of the import jobs.
|
|
2773
3271
|
#
|
|
2774
3272
|
# @option params [String] :import_destination_type
|
|
@@ -2810,7 +3308,7 @@ module Aws::SESV2
|
|
|
2810
3308
|
# resp.import_jobs[0].import_destination.suppression_list_destination.suppression_list_import_action #=> String, one of "DELETE", "PUT"
|
|
2811
3309
|
# resp.import_jobs[0].import_destination.contact_list_destination.contact_list_name #=> String
|
|
2812
3310
|
# resp.import_jobs[0].import_destination.contact_list_destination.contact_list_import_action #=> String, one of "DELETE", "PUT"
|
|
2813
|
-
# resp.import_jobs[0].job_status #=> String, one of "CREATED", "PROCESSING", "COMPLETED", "FAILED"
|
|
3311
|
+
# resp.import_jobs[0].job_status #=> String, one of "CREATED", "PROCESSING", "COMPLETED", "FAILED", "CANCELLED"
|
|
2814
3312
|
# resp.import_jobs[0].created_timestamp #=> Time
|
|
2815
3313
|
# resp.import_jobs[0].processed_records_count #=> Integer
|
|
2816
3314
|
# resp.import_jobs[0].failed_records_count #=> Integer
|
|
@@ -4556,7 +5054,7 @@ module Aws::SESV2
|
|
|
4556
5054
|
params: params,
|
|
4557
5055
|
config: config)
|
|
4558
5056
|
context[:gem_name] = 'aws-sdk-sesv2'
|
|
4559
|
-
context[:gem_version] = '1.
|
|
5057
|
+
context[:gem_version] = '1.39.0'
|
|
4560
5058
|
Seahorse::Client::Request.new(handlers, context)
|
|
4561
5059
|
end
|
|
4562
5060
|
|