aws-sdk-pinpointemail 1.1.0 → 1.2.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/lib/aws-sdk-pinpointemail.rb +1 -1
- data/lib/aws-sdk-pinpointemail/client.rb +330 -1
- data/lib/aws-sdk-pinpointemail/client_api.rb +244 -0
- data/lib/aws-sdk-pinpointemail/types.rb +638 -3
- metadata +2 -2
@@ -8,6 +8,33 @@
|
|
8
8
|
module Aws::PinpointEmail
|
9
9
|
module Types
|
10
10
|
|
11
|
+
# An object that contains information about a blacklisting event that
|
12
|
+
# impacts one of the dedicated IP addresses that is associated with your
|
13
|
+
# account.
|
14
|
+
#
|
15
|
+
# @!attribute [rw] rbl_name
|
16
|
+
# The name of the blacklist that the IP address appears on.
|
17
|
+
# @return [String]
|
18
|
+
#
|
19
|
+
# @!attribute [rw] listing_time
|
20
|
+
# The time when the blacklisting event occurred, shown in Unix time
|
21
|
+
# format.
|
22
|
+
# @return [Time]
|
23
|
+
#
|
24
|
+
# @!attribute [rw] description
|
25
|
+
# Additional information about the blacklisting event, as provided by
|
26
|
+
# the blacklist maintainer.
|
27
|
+
# @return [String]
|
28
|
+
#
|
29
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26/BlacklistEntry AWS API Documentation
|
30
|
+
#
|
31
|
+
class BlacklistEntry < Struct.new(
|
32
|
+
:rbl_name,
|
33
|
+
:listing_time,
|
34
|
+
:description)
|
35
|
+
include Aws::Structure
|
36
|
+
end
|
37
|
+
|
11
38
|
# Represents the body of the email message.
|
12
39
|
#
|
13
40
|
# @note When making an API call, you may pass Body
|
@@ -311,6 +338,93 @@ module Aws::PinpointEmail
|
|
311
338
|
#
|
312
339
|
class CreateDedicatedIpPoolResponse < Aws::EmptyStructure; end
|
313
340
|
|
341
|
+
# A request to perform a predictive inbox placement test. Predictive
|
342
|
+
# inbox placement tests can help you predict how your messages will be
|
343
|
+
# handled by various email providers around the world. When you perform
|
344
|
+
# a predictive inbox placement test, you provide a sample message that
|
345
|
+
# contains the content that you plan to send to your customers. Amazon
|
346
|
+
# Pinpoint then sends that message to special email addresses spread
|
347
|
+
# across several major email providers. After about 24 hours, the test
|
348
|
+
# is complete, and you can use the `GetDeliverabilityTestReport`
|
349
|
+
# operation to view the results of the test.
|
350
|
+
#
|
351
|
+
# @note When making an API call, you may pass CreateDeliverabilityTestReportRequest
|
352
|
+
# data as a hash:
|
353
|
+
#
|
354
|
+
# {
|
355
|
+
# report_name: "ReportName",
|
356
|
+
# from_email_address: "EmailAddress", # required
|
357
|
+
# content: { # required
|
358
|
+
# simple: {
|
359
|
+
# subject: { # required
|
360
|
+
# data: "MessageData", # required
|
361
|
+
# charset: "Charset",
|
362
|
+
# },
|
363
|
+
# body: { # required
|
364
|
+
# text: {
|
365
|
+
# data: "MessageData", # required
|
366
|
+
# charset: "Charset",
|
367
|
+
# },
|
368
|
+
# html: {
|
369
|
+
# data: "MessageData", # required
|
370
|
+
# charset: "Charset",
|
371
|
+
# },
|
372
|
+
# },
|
373
|
+
# },
|
374
|
+
# raw: {
|
375
|
+
# data: "data", # required
|
376
|
+
# },
|
377
|
+
# },
|
378
|
+
# }
|
379
|
+
#
|
380
|
+
# @!attribute [rw] report_name
|
381
|
+
# A unique name that helps you to identify the predictive inbox
|
382
|
+
# placement test when you retrieve the results.
|
383
|
+
# @return [String]
|
384
|
+
#
|
385
|
+
# @!attribute [rw] from_email_address
|
386
|
+
# The email address that the predictive inbox placement test email was
|
387
|
+
# sent from.
|
388
|
+
# @return [String]
|
389
|
+
#
|
390
|
+
# @!attribute [rw] content
|
391
|
+
# The HTML body of the message that you sent when you performed the
|
392
|
+
# predictive inbox placement test.
|
393
|
+
# @return [Types::EmailContent]
|
394
|
+
#
|
395
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26/CreateDeliverabilityTestReportRequest AWS API Documentation
|
396
|
+
#
|
397
|
+
class CreateDeliverabilityTestReportRequest < Struct.new(
|
398
|
+
:report_name,
|
399
|
+
:from_email_address,
|
400
|
+
:content)
|
401
|
+
include Aws::Structure
|
402
|
+
end
|
403
|
+
|
404
|
+
# Information about the predictive inbox placement test that you
|
405
|
+
# created.
|
406
|
+
#
|
407
|
+
# @!attribute [rw] report_id
|
408
|
+
# A unique string that identifies the predictive inbox placement test.
|
409
|
+
# @return [String]
|
410
|
+
#
|
411
|
+
# @!attribute [rw] deliverability_test_status
|
412
|
+
# The status of the predictive inbox placement test. If the status is
|
413
|
+
# `IN_PROGRESS`, then the predictive inbox placement test is currently
|
414
|
+
# running. Predictive inbox placement tests are usually complete
|
415
|
+
# within 24 hours of creating the test. If the status is `COMPLETE`,
|
416
|
+
# then the test is finished, and you can use the
|
417
|
+
# `GetDeliverabilityTestReport` to view the results of the test.
|
418
|
+
# @return [String]
|
419
|
+
#
|
420
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26/CreateDeliverabilityTestReportResponse AWS API Documentation
|
421
|
+
#
|
422
|
+
class CreateDeliverabilityTestReportResponse < Struct.new(
|
423
|
+
:report_id,
|
424
|
+
:deliverability_test_status)
|
425
|
+
include Aws::Structure
|
426
|
+
end
|
427
|
+
|
314
428
|
# A request to begin the verification process for an email identity (an
|
315
429
|
# email address or domain).
|
316
430
|
#
|
@@ -370,6 +484,33 @@ module Aws::PinpointEmail
|
|
370
484
|
include Aws::Structure
|
371
485
|
end
|
372
486
|
|
487
|
+
# An object that contains information about the volume of email sent on
|
488
|
+
# each day of the analysis period.
|
489
|
+
#
|
490
|
+
# @!attribute [rw] start_date
|
491
|
+
# The date that the DailyVolume metrics apply to, in Unix time.
|
492
|
+
# @return [Time]
|
493
|
+
#
|
494
|
+
# @!attribute [rw] volume_statistics
|
495
|
+
# An object that contains inbox placement metrics for a specific day
|
496
|
+
# in the analysis period.
|
497
|
+
# @return [Types::VolumeStatistics]
|
498
|
+
#
|
499
|
+
# @!attribute [rw] domain_isp_placements
|
500
|
+
# An object that contains inbox placement metrics for a specifid day
|
501
|
+
# in the analysis period, broken out by the recipient's email
|
502
|
+
# provider.
|
503
|
+
# @return [Array<Types::DomainIspPlacement>]
|
504
|
+
#
|
505
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26/DailyVolume AWS API Documentation
|
506
|
+
#
|
507
|
+
class DailyVolume < Struct.new(
|
508
|
+
:start_date,
|
509
|
+
:volume_statistics,
|
510
|
+
:domain_isp_placements)
|
511
|
+
include Aws::Structure
|
512
|
+
end
|
513
|
+
|
373
514
|
# Contains information about a dedicated IP address that is associated
|
374
515
|
# with your Amazon Pinpoint account.
|
375
516
|
#
|
@@ -529,6 +670,54 @@ module Aws::PinpointEmail
|
|
529
670
|
#
|
530
671
|
class DeleteEmailIdentityResponse < Aws::EmptyStructure; end
|
531
672
|
|
673
|
+
# An object that contains metadata related to a predictive inbox
|
674
|
+
# placement test.
|
675
|
+
#
|
676
|
+
# @!attribute [rw] report_id
|
677
|
+
# A unique string that identifies the predictive inbox placement test.
|
678
|
+
# @return [String]
|
679
|
+
#
|
680
|
+
# @!attribute [rw] report_name
|
681
|
+
# A name that helps you identify a predictive inbox placement test
|
682
|
+
# report.
|
683
|
+
# @return [String]
|
684
|
+
#
|
685
|
+
# @!attribute [rw] subject
|
686
|
+
# The subject line for an email that you submitted in a predictive
|
687
|
+
# inbox placement test.
|
688
|
+
# @return [String]
|
689
|
+
#
|
690
|
+
# @!attribute [rw] from_email_address
|
691
|
+
# The sender address that you specified for the predictive inbox
|
692
|
+
# placement test.
|
693
|
+
# @return [String]
|
694
|
+
#
|
695
|
+
# @!attribute [rw] create_date
|
696
|
+
# The date and time when the predictive inbox placement test was
|
697
|
+
# created, in Unix time format.
|
698
|
+
# @return [Time]
|
699
|
+
#
|
700
|
+
# @!attribute [rw] deliverability_test_status
|
701
|
+
# The status of the predictive inbox placement test. If the status is
|
702
|
+
# `IN_PROGRESS`, then the predictive inbox placement test is currently
|
703
|
+
# running. Predictive inbox placement tests are usually complete
|
704
|
+
# within 24 hours of creating the test. If the status is `COMPLETE`,
|
705
|
+
# then the test is finished, and you can use the
|
706
|
+
# `GetDeliverabilityTestReport` to view the results of the test.
|
707
|
+
# @return [String]
|
708
|
+
#
|
709
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26/DeliverabilityTestReport AWS API Documentation
|
710
|
+
#
|
711
|
+
class DeliverabilityTestReport < Struct.new(
|
712
|
+
:report_id,
|
713
|
+
:report_name,
|
714
|
+
:subject,
|
715
|
+
:from_email_address,
|
716
|
+
:create_date,
|
717
|
+
:deliverability_test_status)
|
718
|
+
include Aws::Structure
|
719
|
+
end
|
720
|
+
|
532
721
|
# Used to associate a configuration set with a dedicated IP pool.
|
533
722
|
#
|
534
723
|
# @note When making an API call, you may pass DeliveryOptions
|
@@ -637,6 +826,49 @@ module Aws::PinpointEmail
|
|
637
826
|
include Aws::Structure
|
638
827
|
end
|
639
828
|
|
829
|
+
# An object that contains inbox placement data for email sent from one
|
830
|
+
# of your email domains to a specific email provider.
|
831
|
+
#
|
832
|
+
# @!attribute [rw] isp_name
|
833
|
+
# The name of the email provider that the inbox placement data applies
|
834
|
+
# to.
|
835
|
+
# @return [String]
|
836
|
+
#
|
837
|
+
# @!attribute [rw] inbox_raw_count
|
838
|
+
# The total number of messages that were sent from the selected domain
|
839
|
+
# to the specified email provider that arrived in recipients'
|
840
|
+
# inboxes.
|
841
|
+
# @return [Integer]
|
842
|
+
#
|
843
|
+
# @!attribute [rw] spam_raw_count
|
844
|
+
# The total number of messages that were sent from the selected domain
|
845
|
+
# to the specified email provider that arrived in recipients' spam or
|
846
|
+
# junk mail folders.
|
847
|
+
# @return [Integer]
|
848
|
+
#
|
849
|
+
# @!attribute [rw] inbox_percentage
|
850
|
+
# The percentage of messages that were sent from the selected domain
|
851
|
+
# to the specified email provider that arrived in recipients'
|
852
|
+
# inboxes.
|
853
|
+
# @return [Float]
|
854
|
+
#
|
855
|
+
# @!attribute [rw] spam_percentage
|
856
|
+
# The percentage of messages that were sent from the selected domain
|
857
|
+
# to the specified email provider that arrived in recipients' spam or
|
858
|
+
# junk mail folders.
|
859
|
+
# @return [Float]
|
860
|
+
#
|
861
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26/DomainIspPlacement AWS API Documentation
|
862
|
+
#
|
863
|
+
class DomainIspPlacement < Struct.new(
|
864
|
+
:isp_name,
|
865
|
+
:inbox_raw_count,
|
866
|
+
:spam_raw_count,
|
867
|
+
:inbox_percentage,
|
868
|
+
:spam_percentage)
|
869
|
+
include Aws::Structure
|
870
|
+
end
|
871
|
+
|
640
872
|
# An object that defines the entire content of the email, including the
|
641
873
|
# message headers and the body content. You can create a simple email
|
642
874
|
# message, in which you specify the subject and the text and HTML
|
@@ -932,6 +1164,43 @@ module Aws::PinpointEmail
|
|
932
1164
|
include Aws::Structure
|
933
1165
|
end
|
934
1166
|
|
1167
|
+
# A request to retrieve a list of the blacklists that your dedicated IP
|
1168
|
+
# addresses appear on.
|
1169
|
+
#
|
1170
|
+
# @note When making an API call, you may pass GetBlacklistReportsRequest
|
1171
|
+
# data as a hash:
|
1172
|
+
#
|
1173
|
+
# {
|
1174
|
+
# blacklist_item_names: ["BlacklistItemName"], # required
|
1175
|
+
# }
|
1176
|
+
#
|
1177
|
+
# @!attribute [rw] blacklist_item_names
|
1178
|
+
# A list of IP addresses that you want to retrieve blacklist
|
1179
|
+
# information about. You can only specify the dedicated IP addresses
|
1180
|
+
# that you use to send email using Amazon Pinpoint or Amazon SES.
|
1181
|
+
# @return [Array<String>]
|
1182
|
+
#
|
1183
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26/GetBlacklistReportsRequest AWS API Documentation
|
1184
|
+
#
|
1185
|
+
class GetBlacklistReportsRequest < Struct.new(
|
1186
|
+
:blacklist_item_names)
|
1187
|
+
include Aws::Structure
|
1188
|
+
end
|
1189
|
+
|
1190
|
+
# An object that contains information about blacklist events.
|
1191
|
+
#
|
1192
|
+
# @!attribute [rw] blacklist_report
|
1193
|
+
# An object that contains information about a blacklist that one of
|
1194
|
+
# your dedicated IP addresses appears on.
|
1195
|
+
# @return [Hash<String,Array<Types::BlacklistEntry>>]
|
1196
|
+
#
|
1197
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26/GetBlacklistReportsResponse AWS API Documentation
|
1198
|
+
#
|
1199
|
+
class GetBlacklistReportsResponse < Struct.new(
|
1200
|
+
:blacklist_report)
|
1201
|
+
include Aws::Structure
|
1202
|
+
end
|
1203
|
+
|
935
1204
|
# A request to obtain information about the event destinations for a
|
936
1205
|
# configuration set.
|
937
1206
|
#
|
@@ -1124,6 +1393,152 @@ module Aws::PinpointEmail
|
|
1124
1393
|
include Aws::Structure
|
1125
1394
|
end
|
1126
1395
|
|
1396
|
+
# A request to retrieve the status of the Deliverability dashboard for
|
1397
|
+
# your account. When the Deliverability dashboard is enabled, you gain
|
1398
|
+
# access to reputation metrics for the domains that you use to send
|
1399
|
+
# email using Amazon Pinpoint. You also gain the ability to perform
|
1400
|
+
# predictive inbox placement tests.
|
1401
|
+
#
|
1402
|
+
# When you use the Deliverability dashboard, you pay a monthly charge of
|
1403
|
+
# USD$1,250.00, in addition to any other fees that you accrue by using
|
1404
|
+
# Amazon Pinpoint. If you enable the Deliverability dashboard after the
|
1405
|
+
# first day of a calendar month, AWS prorates the monthly charge based
|
1406
|
+
# on how many days have elapsed in the current calendar month.
|
1407
|
+
#
|
1408
|
+
# @api private
|
1409
|
+
#
|
1410
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26/GetDeliverabilityDashboardOptionsRequest AWS API Documentation
|
1411
|
+
#
|
1412
|
+
class GetDeliverabilityDashboardOptionsRequest < Aws::EmptyStructure; end
|
1413
|
+
|
1414
|
+
# An object that shows the status of the Deliverability dashboard for
|
1415
|
+
# your Amazon Pinpoint account.
|
1416
|
+
#
|
1417
|
+
# @!attribute [rw] dashboard_enabled
|
1418
|
+
# Indicates whether the Deliverability dashboard is enabled. If the
|
1419
|
+
# value is `true`, then the dashboard is enabled.
|
1420
|
+
# @return [Boolean]
|
1421
|
+
#
|
1422
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26/GetDeliverabilityDashboardOptionsResponse AWS API Documentation
|
1423
|
+
#
|
1424
|
+
class GetDeliverabilityDashboardOptionsResponse < Struct.new(
|
1425
|
+
:dashboard_enabled)
|
1426
|
+
include Aws::Structure
|
1427
|
+
end
|
1428
|
+
|
1429
|
+
# A request to retrieve the results of a predictive inbox placement
|
1430
|
+
# test.
|
1431
|
+
#
|
1432
|
+
# @note When making an API call, you may pass GetDeliverabilityTestReportRequest
|
1433
|
+
# data as a hash:
|
1434
|
+
#
|
1435
|
+
# {
|
1436
|
+
# report_id: "ReportId", # required
|
1437
|
+
# }
|
1438
|
+
#
|
1439
|
+
# @!attribute [rw] report_id
|
1440
|
+
# A unique string that identifies the predictive inbox placement test.
|
1441
|
+
# @return [String]
|
1442
|
+
#
|
1443
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26/GetDeliverabilityTestReportRequest AWS API Documentation
|
1444
|
+
#
|
1445
|
+
class GetDeliverabilityTestReportRequest < Struct.new(
|
1446
|
+
:report_id)
|
1447
|
+
include Aws::Structure
|
1448
|
+
end
|
1449
|
+
|
1450
|
+
# The results of the predictive inbox placement test.
|
1451
|
+
#
|
1452
|
+
# @!attribute [rw] deliverability_test_report
|
1453
|
+
# An object that contains the results of the predictive inbox
|
1454
|
+
# placement test.
|
1455
|
+
# @return [Types::DeliverabilityTestReport]
|
1456
|
+
#
|
1457
|
+
# @!attribute [rw] overall_placement
|
1458
|
+
# An object that specifies how many test messages that were sent
|
1459
|
+
# during the predictive inbox placement test were delivered to
|
1460
|
+
# recipients' inboxes, how many were sent to recipients' spam
|
1461
|
+
# folders, and how many weren't delivered.
|
1462
|
+
# @return [Types::PlacementStatistics]
|
1463
|
+
#
|
1464
|
+
# @!attribute [rw] isp_placements
|
1465
|
+
# An object that describes how the test email was handled by several
|
1466
|
+
# email providers, including Gmail, Hotmail, Yahoo, AOL, and others.
|
1467
|
+
# @return [Array<Types::IspPlacement>]
|
1468
|
+
#
|
1469
|
+
# @!attribute [rw] message
|
1470
|
+
# An object that contains the message that you sent when you performed
|
1471
|
+
# this predictive inbox placement test.
|
1472
|
+
# @return [String]
|
1473
|
+
#
|
1474
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26/GetDeliverabilityTestReportResponse AWS API Documentation
|
1475
|
+
#
|
1476
|
+
class GetDeliverabilityTestReportResponse < Struct.new(
|
1477
|
+
:deliverability_test_report,
|
1478
|
+
:overall_placement,
|
1479
|
+
:isp_placements,
|
1480
|
+
:message)
|
1481
|
+
include Aws::Structure
|
1482
|
+
end
|
1483
|
+
|
1484
|
+
# A request to obtain deliverability metrics for a domain.
|
1485
|
+
#
|
1486
|
+
# @note When making an API call, you may pass GetDomainStatisticsReportRequest
|
1487
|
+
# data as a hash:
|
1488
|
+
#
|
1489
|
+
# {
|
1490
|
+
# domain: "Identity", # required
|
1491
|
+
# start_date: Time.now, # required
|
1492
|
+
# end_date: Time.now, # required
|
1493
|
+
# }
|
1494
|
+
#
|
1495
|
+
# @!attribute [rw] domain
|
1496
|
+
# The domain that you want to obtain deliverability metrics for.
|
1497
|
+
# @return [String]
|
1498
|
+
#
|
1499
|
+
# @!attribute [rw] start_date
|
1500
|
+
# The first day (in Unix time) that you want to obtain domain
|
1501
|
+
# deliverability metrics for.
|
1502
|
+
# @return [Time]
|
1503
|
+
#
|
1504
|
+
# @!attribute [rw] end_date
|
1505
|
+
# The last day (in Unix time) that you want to obtain domain
|
1506
|
+
# deliverability metrics for. The `EndDate` that you specify has to be
|
1507
|
+
# less than or equal to 30 days after the `StartDate`.
|
1508
|
+
# @return [Time]
|
1509
|
+
#
|
1510
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26/GetDomainStatisticsReportRequest AWS API Documentation
|
1511
|
+
#
|
1512
|
+
class GetDomainStatisticsReportRequest < Struct.new(
|
1513
|
+
:domain,
|
1514
|
+
:start_date,
|
1515
|
+
:end_date)
|
1516
|
+
include Aws::Structure
|
1517
|
+
end
|
1518
|
+
|
1519
|
+
# An object that includes statistics that are related to the domain that
|
1520
|
+
# you specified.
|
1521
|
+
#
|
1522
|
+
# @!attribute [rw] overall_volume
|
1523
|
+
# An object that contains deliverability metrics for the domain that
|
1524
|
+
# you specified. The data in this object is a summary of all of the
|
1525
|
+
# data that was collected from the `StartDate` to the `EndDate`.
|
1526
|
+
# @return [Types::OverallVolume]
|
1527
|
+
#
|
1528
|
+
# @!attribute [rw] daily_volumes
|
1529
|
+
# An object that contains deliverability metrics for the domain that
|
1530
|
+
# you specified. This object contains data for each day, starting on
|
1531
|
+
# the `StartDate` and ending on the `EndDate`.
|
1532
|
+
# @return [Array<Types::DailyVolume>]
|
1533
|
+
#
|
1534
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26/GetDomainStatisticsReportResponse AWS API Documentation
|
1535
|
+
#
|
1536
|
+
class GetDomainStatisticsReportResponse < Struct.new(
|
1537
|
+
:overall_volume,
|
1538
|
+
:daily_volumes)
|
1539
|
+
include Aws::Structure
|
1540
|
+
end
|
1541
|
+
|
1127
1542
|
# A request to return details about an email identity.
|
1128
1543
|
#
|
1129
1544
|
# @note When making an API call, you may pass GetEmailIdentityRequest
|
@@ -1237,6 +1652,27 @@ module Aws::PinpointEmail
|
|
1237
1652
|
include Aws::Structure
|
1238
1653
|
end
|
1239
1654
|
|
1655
|
+
# An object that describes how email sent during the predictive inbox
|
1656
|
+
# placement test was handled by a certain email provider.
|
1657
|
+
#
|
1658
|
+
# @!attribute [rw] isp_name
|
1659
|
+
# The name of the email provider that the inbox placement data applies
|
1660
|
+
# to.
|
1661
|
+
# @return [String]
|
1662
|
+
#
|
1663
|
+
# @!attribute [rw] placement_statistics
|
1664
|
+
# An object that contains inbox placement metrics for a specific email
|
1665
|
+
# provider.
|
1666
|
+
# @return [Types::PlacementStatistics]
|
1667
|
+
#
|
1668
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26/IspPlacement AWS API Documentation
|
1669
|
+
#
|
1670
|
+
class IspPlacement < Struct.new(
|
1671
|
+
:isp_name,
|
1672
|
+
:placement_statistics)
|
1673
|
+
include Aws::Structure
|
1674
|
+
end
|
1675
|
+
|
1240
1676
|
# An object that defines an Amazon Kinesis Data Firehose destination for
|
1241
1677
|
# email events. You can use Amazon Kinesis Data Firehose to stream data
|
1242
1678
|
# to other services, such as Amazon S3 and Amazon Redshift.
|
@@ -1374,6 +1810,67 @@ module Aws::PinpointEmail
|
|
1374
1810
|
include Aws::Structure
|
1375
1811
|
end
|
1376
1812
|
|
1813
|
+
# A request to list all of the predictive inbox placement tests that
|
1814
|
+
# you've performed.
|
1815
|
+
#
|
1816
|
+
# @note When making an API call, you may pass ListDeliverabilityTestReportsRequest
|
1817
|
+
# data as a hash:
|
1818
|
+
#
|
1819
|
+
# {
|
1820
|
+
# next_token: "NextToken",
|
1821
|
+
# page_size: 1,
|
1822
|
+
# }
|
1823
|
+
#
|
1824
|
+
# @!attribute [rw] next_token
|
1825
|
+
# A token returned from a previous call to
|
1826
|
+
# `ListDeliverabilityTestReports` to indicate the position in the list
|
1827
|
+
# of predictive inbox placement tests.
|
1828
|
+
# @return [String]
|
1829
|
+
#
|
1830
|
+
# @!attribute [rw] page_size
|
1831
|
+
# The number of results to show in a single call to
|
1832
|
+
# `ListDeliverabilityTestReports`. If the number of results is larger
|
1833
|
+
# than the number you specified in this parameter, then the response
|
1834
|
+
# includes a `NextToken` element, which you can use to obtain
|
1835
|
+
# additional results.
|
1836
|
+
#
|
1837
|
+
# The value you specify has to be at least 0, and can be no more than
|
1838
|
+
# 1000.
|
1839
|
+
# @return [Integer]
|
1840
|
+
#
|
1841
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26/ListDeliverabilityTestReportsRequest AWS API Documentation
|
1842
|
+
#
|
1843
|
+
class ListDeliverabilityTestReportsRequest < Struct.new(
|
1844
|
+
:next_token,
|
1845
|
+
:page_size)
|
1846
|
+
include Aws::Structure
|
1847
|
+
end
|
1848
|
+
|
1849
|
+
# A list of the predictive inbox placement test reports that are
|
1850
|
+
# available for your account, regardless of whether or not those tests
|
1851
|
+
# are complete.
|
1852
|
+
#
|
1853
|
+
# @!attribute [rw] deliverability_test_reports
|
1854
|
+
# An object that contains a lists of predictive inbox placement tests
|
1855
|
+
# that you've performed.
|
1856
|
+
# @return [Array<Types::DeliverabilityTestReport>]
|
1857
|
+
#
|
1858
|
+
# @!attribute [rw] next_token
|
1859
|
+
# A token that indicates that there are additional predictive inbox
|
1860
|
+
# placement tests to list. To view additional predictive inbox
|
1861
|
+
# placement tests, issue another request to
|
1862
|
+
# `ListDeliverabilityTestReports`, and pass this token in the
|
1863
|
+
# `NextToken` parameter.
|
1864
|
+
# @return [String]
|
1865
|
+
#
|
1866
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26/ListDeliverabilityTestReportsResponse AWS API Documentation
|
1867
|
+
#
|
1868
|
+
class ListDeliverabilityTestReportsResponse < Struct.new(
|
1869
|
+
:deliverability_test_reports,
|
1870
|
+
:next_token)
|
1871
|
+
include Aws::Structure
|
1872
|
+
end
|
1873
|
+
|
1377
1874
|
# A request to list all of the email identities associated with your
|
1378
1875
|
# Amazon Pinpoint account. This list includes identities that you've
|
1379
1876
|
# already verified, identities that are unverified, and identities that
|
@@ -1567,6 +2064,33 @@ module Aws::PinpointEmail
|
|
1567
2064
|
include Aws::Structure
|
1568
2065
|
end
|
1569
2066
|
|
2067
|
+
# An object that contains information about email that was sent from the
|
2068
|
+
# selected domain.
|
2069
|
+
#
|
2070
|
+
# @!attribute [rw] volume_statistics
|
2071
|
+
# An object that contains information about the numbers of messages
|
2072
|
+
# that arrived in recipients' inboxes and junk mail folders.
|
2073
|
+
# @return [Types::VolumeStatistics]
|
2074
|
+
#
|
2075
|
+
# @!attribute [rw] read_rate_percent
|
2076
|
+
# The percentage of emails that were sent from the domain that were
|
2077
|
+
# read by their recipients.
|
2078
|
+
# @return [Float]
|
2079
|
+
#
|
2080
|
+
# @!attribute [rw] domain_isp_placements
|
2081
|
+
# An object that contains inbox and junk mail placement metrics for
|
2082
|
+
# individual email providers.
|
2083
|
+
# @return [Array<Types::DomainIspPlacement>]
|
2084
|
+
#
|
2085
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26/OverallVolume AWS API Documentation
|
2086
|
+
#
|
2087
|
+
class OverallVolume < Struct.new(
|
2088
|
+
:volume_statistics,
|
2089
|
+
:read_rate_percent,
|
2090
|
+
:domain_isp_placements)
|
2091
|
+
include Aws::Structure
|
2092
|
+
end
|
2093
|
+
|
1570
2094
|
# An object that defines a Amazon Pinpoint destination for email events.
|
1571
2095
|
# You can use Amazon Pinpoint events to create attributes in Amazon
|
1572
2096
|
# Pinpoint projects. You can use these attributes to create segments for
|
@@ -1591,6 +2115,44 @@ module Aws::PinpointEmail
|
|
1591
2115
|
include Aws::Structure
|
1592
2116
|
end
|
1593
2117
|
|
2118
|
+
# An object that contains inbox placement data for an email provider.
|
2119
|
+
#
|
2120
|
+
# @!attribute [rw] inbox_percentage
|
2121
|
+
# The percentage of emails that arrived in recipients' inboxes during
|
2122
|
+
# the predictive inbox placement test.
|
2123
|
+
# @return [Float]
|
2124
|
+
#
|
2125
|
+
# @!attribute [rw] spam_percentage
|
2126
|
+
# The percentage of emails that arrived in recipients' spam or junk
|
2127
|
+
# mail folders during the predictive inbox placement test.
|
2128
|
+
# @return [Float]
|
2129
|
+
#
|
2130
|
+
# @!attribute [rw] missing_percentage
|
2131
|
+
# The percentage of emails that didn't arrive in recipients' inboxes
|
2132
|
+
# at all during the predictive inbox placement test.
|
2133
|
+
# @return [Float]
|
2134
|
+
#
|
2135
|
+
# @!attribute [rw] spf_percentage
|
2136
|
+
# The percentage of emails that were authenticated by using Sender
|
2137
|
+
# Policy Framework (SPF) during the predictive inbox placement test.
|
2138
|
+
# @return [Float]
|
2139
|
+
#
|
2140
|
+
# @!attribute [rw] dkim_percentage
|
2141
|
+
# The percentage of emails that were authenticated by using DomainKeys
|
2142
|
+
# Identified Mail (DKIM) during the predictive inbox placement test.
|
2143
|
+
# @return [Float]
|
2144
|
+
#
|
2145
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26/PlacementStatistics AWS API Documentation
|
2146
|
+
#
|
2147
|
+
class PlacementStatistics < Struct.new(
|
2148
|
+
:inbox_percentage,
|
2149
|
+
:spam_percentage,
|
2150
|
+
:missing_percentage,
|
2151
|
+
:spf_percentage,
|
2152
|
+
:dkim_percentage)
|
2153
|
+
include Aws::Structure
|
2154
|
+
end
|
2155
|
+
|
1594
2156
|
# A request to enable or disable the automatic IP address warm-up
|
1595
2157
|
# feature.
|
1596
2158
|
#
|
@@ -1828,6 +2390,9 @@ module Aws::PinpointEmail
|
|
1828
2390
|
include Aws::Structure
|
1829
2391
|
end
|
1830
2392
|
|
2393
|
+
# An HTTP 200 response if the request succeeds, or an error message if
|
2394
|
+
# the request fails.
|
2395
|
+
#
|
1831
2396
|
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26/PutDedicatedIpInPoolResponse AWS API Documentation
|
1832
2397
|
#
|
1833
2398
|
class PutDedicatedIpInPoolResponse < Aws::EmptyStructure; end
|
@@ -1869,6 +2434,44 @@ module Aws::PinpointEmail
|
|
1869
2434
|
#
|
1870
2435
|
class PutDedicatedIpWarmupAttributesResponse < Aws::EmptyStructure; end
|
1871
2436
|
|
2437
|
+
# A request to enable or disable the Deliverability dashboard. When you
|
2438
|
+
# enable the Deliverability dashboard, you gain access to reputation
|
2439
|
+
# metrics for the domains that you use to send email using Amazon
|
2440
|
+
# Pinpoint. You also gain the ability to perform predictive inbox
|
2441
|
+
# placement tests.
|
2442
|
+
#
|
2443
|
+
# When you use the Deliverability dashboard, you pay a monthly charge of
|
2444
|
+
# USD$1,250.00, in addition to any other fees that you accrue by using
|
2445
|
+
# Amazon Pinpoint. If you enable the Deliverability dashboard after the
|
2446
|
+
# first day of a calendar month, we prorate the monthly charge based on
|
2447
|
+
# how many days have elapsed in the current calendar month.
|
2448
|
+
#
|
2449
|
+
# @note When making an API call, you may pass PutDeliverabilityDashboardOptionRequest
|
2450
|
+
# data as a hash:
|
2451
|
+
#
|
2452
|
+
# {
|
2453
|
+
# dashboard_enabled: false, # required
|
2454
|
+
# }
|
2455
|
+
#
|
2456
|
+
# @!attribute [rw] dashboard_enabled
|
2457
|
+
# Indicates whether the Deliverability dashboard is enabled. If the
|
2458
|
+
# value is `true`, then the dashboard is enabled.
|
2459
|
+
# @return [Boolean]
|
2460
|
+
#
|
2461
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26/PutDeliverabilityDashboardOptionRequest AWS API Documentation
|
2462
|
+
#
|
2463
|
+
class PutDeliverabilityDashboardOptionRequest < Struct.new(
|
2464
|
+
:dashboard_enabled)
|
2465
|
+
include Aws::Structure
|
2466
|
+
end
|
2467
|
+
|
2468
|
+
# A response that indicates whether the Deliverability dashboard is
|
2469
|
+
# enabled for your Amazon Pinpoint account.
|
2470
|
+
#
|
2471
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26/PutDeliverabilityDashboardOptionResponse AWS API Documentation
|
2472
|
+
#
|
2473
|
+
class PutDeliverabilityDashboardOptionResponse < Aws::EmptyStructure; end
|
2474
|
+
|
1872
2475
|
# A request to enable or disable DKIM signing of email that you send
|
1873
2476
|
# from an email identity.
|
1874
2477
|
#
|
@@ -2077,9 +2680,9 @@ module Aws::PinpointEmail
|
|
2077
2680
|
# @return [Boolean]
|
2078
2681
|
#
|
2079
2682
|
# @!attribute [rw] last_fresh_start
|
2080
|
-
# The date and time when the reputation metrics were
|
2081
|
-
# fresh start. When your account is given a fresh start,
|
2082
|
-
# reputation metrics are calculated starting from the date of the
|
2683
|
+
# The date and time (in Unix time) when the reputation metrics were
|
2684
|
+
# last given a fresh start. When your account is given a fresh start,
|
2685
|
+
# your reputation metrics are calculated starting from the date of the
|
2083
2686
|
# fresh start.
|
2084
2687
|
# @return [Time]
|
2085
2688
|
#
|
@@ -2378,5 +2981,37 @@ module Aws::PinpointEmail
|
|
2378
2981
|
#
|
2379
2982
|
class UpdateConfigurationSetEventDestinationResponse < Aws::EmptyStructure; end
|
2380
2983
|
|
2984
|
+
# An object that contains information about the amount of email that was
|
2985
|
+
# delivered to recipients.
|
2986
|
+
#
|
2987
|
+
# @!attribute [rw] inbox_raw_count
|
2988
|
+
# The total number of emails that arrived in recipients' inboxes.
|
2989
|
+
# @return [Integer]
|
2990
|
+
#
|
2991
|
+
# @!attribute [rw] spam_raw_count
|
2992
|
+
# The total number of emails that arrived in recipients' spam or junk
|
2993
|
+
# mail folders.
|
2994
|
+
# @return [Integer]
|
2995
|
+
#
|
2996
|
+
# @!attribute [rw] projected_inbox
|
2997
|
+
# An estimate of the percentage of emails sent from the current domain
|
2998
|
+
# that will arrive in recipients' inboxes.
|
2999
|
+
# @return [Integer]
|
3000
|
+
#
|
3001
|
+
# @!attribute [rw] projected_spam
|
3002
|
+
# An estimate of the percentage of emails sent from the current domain
|
3003
|
+
# that will arrive in recipients' spam or junk mail folders.
|
3004
|
+
# @return [Integer]
|
3005
|
+
#
|
3006
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26/VolumeStatistics AWS API Documentation
|
3007
|
+
#
|
3008
|
+
class VolumeStatistics < Struct.new(
|
3009
|
+
:inbox_raw_count,
|
3010
|
+
:spam_raw_count,
|
3011
|
+
:projected_inbox,
|
3012
|
+
:projected_spam)
|
3013
|
+
include Aws::Structure
|
3014
|
+
end
|
3015
|
+
|
2381
3016
|
end
|
2382
3017
|
end
|