aws-sdk-pinpointemail 1.9.0 → 1.10.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 +214 -35
- data/lib/aws-sdk-pinpointemail/client_api.rb +122 -16
- data/lib/aws-sdk-pinpointemail/types.rb +422 -47
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA1:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: bac656725cf131b8490caf35525d71ccca833059
|
4
|
+
data.tar.gz: 65c201f8f5a6275d8e1e27fbf6853469f30fe679
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 5efc63382c04a735649804452b24c882f902e646cbdc0bca0596770b954b4f6dfb2520b326b459354df36a1a10b84d712b992ee473ab6012b82fad0144b97e90
|
7
|
+
data.tar.gz: 2da9192ec41769085fce31111472784ccdcb182271e1ce3feddad85c22b025ee1d411d7d23a3ec0fae2868306726671351c4a05866a6b75e395dc52cd64137e2
|
@@ -257,7 +257,7 @@ module Aws::PinpointEmail
|
|
257
257
|
# configuration set to an email, all of the rules in that configuration
|
258
258
|
# set are applied to the email.
|
259
259
|
#
|
260
|
-
# @option params [String] :configuration_set_name
|
260
|
+
# @option params [required, String] :configuration_set_name
|
261
261
|
# The name of the configuration set.
|
262
262
|
#
|
263
263
|
# @option params [Types::TrackingOptions] :tracking_options
|
@@ -278,15 +278,15 @@ module Aws::PinpointEmail
|
|
278
278
|
# that you send using the configuration set.
|
279
279
|
#
|
280
280
|
# @option params [Array<Types::Tag>] :tags
|
281
|
-
# An
|
282
|
-
# associate with the configuration set.
|
281
|
+
# An array of objects that define the tags (keys and values) that you
|
282
|
+
# want to associate with the configuration set.
|
283
283
|
#
|
284
284
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
285
285
|
#
|
286
286
|
# @example Request syntax with placeholder values
|
287
287
|
#
|
288
288
|
# resp = client.create_configuration_set({
|
289
|
-
# configuration_set_name: "ConfigurationSetName",
|
289
|
+
# configuration_set_name: "ConfigurationSetName", # required
|
290
290
|
# tracking_options: {
|
291
291
|
# custom_redirect_domain: "CustomRedirectDomain", # required
|
292
292
|
# },
|
@@ -439,8 +439,8 @@ module Aws::PinpointEmail
|
|
439
439
|
# predictive inbox placement test.
|
440
440
|
#
|
441
441
|
# @option params [Array<Types::Tag>] :tags
|
442
|
-
# An
|
443
|
-
# associate with the predictive inbox placement test.
|
442
|
+
# An array of objects that define the tags (keys and values) that you
|
443
|
+
# want to associate with the predictive inbox placement test.
|
444
444
|
#
|
445
445
|
# @return [Types::CreateDeliverabilityTestReportResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
446
446
|
#
|
@@ -518,8 +518,8 @@ module Aws::PinpointEmail
|
|
518
518
|
# The email address or domain that you want to verify.
|
519
519
|
#
|
520
520
|
# @option params [Array<Types::Tag>] :tags
|
521
|
-
# An
|
522
|
-
# associate with the email identity.
|
521
|
+
# An array of objects that define the tags (keys and values) that you
|
522
|
+
# want to associate with the email identity.
|
523
523
|
#
|
524
524
|
# @return [Types::CreateEmailIdentityResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
525
525
|
#
|
@@ -752,6 +752,7 @@ module Aws::PinpointEmail
|
|
752
752
|
# * {Types::GetConfigurationSetResponse#delivery_options #delivery_options} => Types::DeliveryOptions
|
753
753
|
# * {Types::GetConfigurationSetResponse#reputation_options #reputation_options} => Types::ReputationOptions
|
754
754
|
# * {Types::GetConfigurationSetResponse#sending_options #sending_options} => Types::SendingOptions
|
755
|
+
# * {Types::GetConfigurationSetResponse#tags #tags} => Array<Types::Tag>
|
755
756
|
#
|
756
757
|
# @example Request syntax with placeholder values
|
757
758
|
#
|
@@ -767,6 +768,9 @@ module Aws::PinpointEmail
|
|
767
768
|
# resp.reputation_options.reputation_metrics_enabled #=> Boolean
|
768
769
|
# resp.reputation_options.last_fresh_start #=> Time
|
769
770
|
# resp.sending_options.sending_enabled #=> Boolean
|
771
|
+
# resp.tags #=> Array
|
772
|
+
# resp.tags[0].key #=> String
|
773
|
+
# resp.tags[0].value #=> String
|
770
774
|
#
|
771
775
|
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26/GetConfigurationSet AWS API Documentation
|
772
776
|
#
|
@@ -908,25 +912,48 @@ module Aws::PinpointEmail
|
|
908
912
|
req.send_request(options)
|
909
913
|
end
|
910
914
|
|
911
|
-
#
|
912
|
-
#
|
915
|
+
# Retrieve information about the status of the Deliverability dashboard
|
916
|
+
# for your Amazon Pinpoint account. When the Deliverability dashboard is
|
917
|
+
# enabled, you gain access to reputation, deliverability, and other
|
913
918
|
# metrics for the domains that you use to send email using Amazon
|
914
919
|
# Pinpoint. You also gain the ability to perform predictive inbox
|
915
920
|
# placement tests.
|
916
921
|
#
|
917
|
-
# When you use the Deliverability dashboard, you pay a monthly
|
918
|
-
#
|
919
|
-
# Amazon Pinpoint.
|
920
|
-
#
|
921
|
-
#
|
922
|
+
# When you use the Deliverability dashboard, you pay a monthly
|
923
|
+
# subscription charge, in addition to any other fees that you accrue by
|
924
|
+
# using Amazon Pinpoint. For more information about the features and
|
925
|
+
# cost of a Deliverability dashboard subscription, see [Amazon Pinpoint
|
926
|
+
# Pricing][1].
|
927
|
+
#
|
928
|
+
#
|
929
|
+
#
|
930
|
+
# [1]: http://aws.amazon.com/pinpoint/pricing/
|
922
931
|
#
|
923
932
|
# @return [Types::GetDeliverabilityDashboardOptionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
924
933
|
#
|
925
934
|
# * {Types::GetDeliverabilityDashboardOptionsResponse#dashboard_enabled #dashboard_enabled} => Boolean
|
935
|
+
# * {Types::GetDeliverabilityDashboardOptionsResponse#subscription_expiry_date #subscription_expiry_date} => Time
|
936
|
+
# * {Types::GetDeliverabilityDashboardOptionsResponse#account_status #account_status} => String
|
937
|
+
# * {Types::GetDeliverabilityDashboardOptionsResponse#active_subscribed_domains #active_subscribed_domains} => Array<Types::DomainDeliverabilityTrackingOption>
|
938
|
+
# * {Types::GetDeliverabilityDashboardOptionsResponse#pending_expiration_subscribed_domains #pending_expiration_subscribed_domains} => Array<Types::DomainDeliverabilityTrackingOption>
|
926
939
|
#
|
927
940
|
# @example Response structure
|
928
941
|
#
|
929
942
|
# resp.dashboard_enabled #=> Boolean
|
943
|
+
# resp.subscription_expiry_date #=> Time
|
944
|
+
# resp.account_status #=> String, one of "ACTIVE", "PENDING_EXPIRATION", "DISABLED"
|
945
|
+
# resp.active_subscribed_domains #=> Array
|
946
|
+
# resp.active_subscribed_domains[0].domain #=> String
|
947
|
+
# resp.active_subscribed_domains[0].subscription_start_date #=> Time
|
948
|
+
# resp.active_subscribed_domains[0].inbox_placement_tracking_option.global #=> Boolean
|
949
|
+
# resp.active_subscribed_domains[0].inbox_placement_tracking_option.tracked_isps #=> Array
|
950
|
+
# resp.active_subscribed_domains[0].inbox_placement_tracking_option.tracked_isps[0] #=> String
|
951
|
+
# resp.pending_expiration_subscribed_domains #=> Array
|
952
|
+
# resp.pending_expiration_subscribed_domains[0].domain #=> String
|
953
|
+
# resp.pending_expiration_subscribed_domains[0].subscription_start_date #=> Time
|
954
|
+
# resp.pending_expiration_subscribed_domains[0].inbox_placement_tracking_option.global #=> Boolean
|
955
|
+
# resp.pending_expiration_subscribed_domains[0].inbox_placement_tracking_option.tracked_isps #=> Array
|
956
|
+
# resp.pending_expiration_subscribed_domains[0].inbox_placement_tracking_option.tracked_isps[0] #=> String
|
930
957
|
#
|
931
958
|
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26/GetDeliverabilityDashboardOptions AWS API Documentation
|
932
959
|
#
|
@@ -948,6 +975,7 @@ module Aws::PinpointEmail
|
|
948
975
|
# * {Types::GetDeliverabilityTestReportResponse#overall_placement #overall_placement} => Types::PlacementStatistics
|
949
976
|
# * {Types::GetDeliverabilityTestReportResponse#isp_placements #isp_placements} => Array<Types::IspPlacement>
|
950
977
|
# * {Types::GetDeliverabilityTestReportResponse#message #message} => String
|
978
|
+
# * {Types::GetDeliverabilityTestReportResponse#tags #tags} => Array<Types::Tag>
|
951
979
|
#
|
952
980
|
# @example Request syntax with placeholder values
|
953
981
|
#
|
@@ -976,6 +1004,9 @@ module Aws::PinpointEmail
|
|
976
1004
|
# resp.isp_placements[0].placement_statistics.spf_percentage #=> Float
|
977
1005
|
# resp.isp_placements[0].placement_statistics.dkim_percentage #=> Float
|
978
1006
|
# resp.message #=> String
|
1007
|
+
# resp.tags #=> Array
|
1008
|
+
# resp.tags[0].key #=> String
|
1009
|
+
# resp.tags[0].value #=> String
|
979
1010
|
#
|
980
1011
|
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26/GetDeliverabilityTestReport AWS API Documentation
|
981
1012
|
#
|
@@ -986,6 +1017,56 @@ module Aws::PinpointEmail
|
|
986
1017
|
req.send_request(options)
|
987
1018
|
end
|
988
1019
|
|
1020
|
+
# Retrieve all the deliverability data for a specific campaign. This
|
1021
|
+
# data is available for a campaign only if the campaign sent email by
|
1022
|
+
# using a domain that the Deliverability dashboard is enabled for
|
1023
|
+
# (`PutDeliverabilityDashboardOption` operation).
|
1024
|
+
#
|
1025
|
+
# @option params [required, String] :campaign_id
|
1026
|
+
# The unique identifier for the campaign. Amazon Pinpoint automatically
|
1027
|
+
# generates and assigns this identifier to a campaign. This value is not
|
1028
|
+
# the same as the campaign identifier that Amazon Pinpoint assigns to
|
1029
|
+
# campaigns that you create and manage by using the Amazon Pinpoint API
|
1030
|
+
# or the Amazon Pinpoint console.
|
1031
|
+
#
|
1032
|
+
# @return [Types::GetDomainDeliverabilityCampaignResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1033
|
+
#
|
1034
|
+
# * {Types::GetDomainDeliverabilityCampaignResponse#domain_deliverability_campaign #domain_deliverability_campaign} => Types::DomainDeliverabilityCampaign
|
1035
|
+
#
|
1036
|
+
# @example Request syntax with placeholder values
|
1037
|
+
#
|
1038
|
+
# resp = client.get_domain_deliverability_campaign({
|
1039
|
+
# campaign_id: "CampaignId", # required
|
1040
|
+
# })
|
1041
|
+
#
|
1042
|
+
# @example Response structure
|
1043
|
+
#
|
1044
|
+
# resp.domain_deliverability_campaign.campaign_id #=> String
|
1045
|
+
# resp.domain_deliverability_campaign.image_url #=> String
|
1046
|
+
# resp.domain_deliverability_campaign.subject #=> String
|
1047
|
+
# resp.domain_deliverability_campaign.from_address #=> String
|
1048
|
+
# resp.domain_deliverability_campaign.sending_ips #=> Array
|
1049
|
+
# resp.domain_deliverability_campaign.sending_ips[0] #=> String
|
1050
|
+
# resp.domain_deliverability_campaign.first_seen_date_time #=> Time
|
1051
|
+
# resp.domain_deliverability_campaign.last_seen_date_time #=> Time
|
1052
|
+
# resp.domain_deliverability_campaign.inbox_count #=> Integer
|
1053
|
+
# resp.domain_deliverability_campaign.spam_count #=> Integer
|
1054
|
+
# resp.domain_deliverability_campaign.read_rate #=> Float
|
1055
|
+
# resp.domain_deliverability_campaign.delete_rate #=> Float
|
1056
|
+
# resp.domain_deliverability_campaign.read_delete_rate #=> Float
|
1057
|
+
# resp.domain_deliverability_campaign.projected_volume #=> Integer
|
1058
|
+
# resp.domain_deliverability_campaign.esps #=> Array
|
1059
|
+
# resp.domain_deliverability_campaign.esps[0] #=> String
|
1060
|
+
#
|
1061
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26/GetDomainDeliverabilityCampaign AWS API Documentation
|
1062
|
+
#
|
1063
|
+
# @overload get_domain_deliverability_campaign(params = {})
|
1064
|
+
# @param [Hash] params ({})
|
1065
|
+
def get_domain_deliverability_campaign(params = {}, options = {})
|
1066
|
+
req = build_request(:get_domain_deliverability_campaign, params)
|
1067
|
+
req.send_request(options)
|
1068
|
+
end
|
1069
|
+
|
989
1070
|
# Retrieve inbox placement and engagement rates for the domains that you
|
990
1071
|
# use to send email.
|
991
1072
|
#
|
@@ -1064,6 +1145,7 @@ module Aws::PinpointEmail
|
|
1064
1145
|
# * {Types::GetEmailIdentityResponse#verified_for_sending_status #verified_for_sending_status} => Boolean
|
1065
1146
|
# * {Types::GetEmailIdentityResponse#dkim_attributes #dkim_attributes} => Types::DkimAttributes
|
1066
1147
|
# * {Types::GetEmailIdentityResponse#mail_from_attributes #mail_from_attributes} => Types::MailFromAttributes
|
1148
|
+
# * {Types::GetEmailIdentityResponse#tags #tags} => Array<Types::Tag>
|
1067
1149
|
#
|
1068
1150
|
# @example Request syntax with placeholder values
|
1069
1151
|
#
|
@@ -1083,6 +1165,9 @@ module Aws::PinpointEmail
|
|
1083
1165
|
# resp.mail_from_attributes.mail_from_domain #=> String
|
1084
1166
|
# resp.mail_from_attributes.mail_from_domain_status #=> String, one of "PENDING", "SUCCESS", "FAILED", "TEMPORARY_FAILURE"
|
1085
1167
|
# resp.mail_from_attributes.behavior_on_mx_failure #=> String, one of "USE_DEFAULT_VALUE", "REJECT_MESSAGE"
|
1168
|
+
# resp.tags #=> Array
|
1169
|
+
# resp.tags[0].key #=> String
|
1170
|
+
# resp.tags[0].value #=> String
|
1086
1171
|
#
|
1087
1172
|
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26/GetEmailIdentity AWS API Documentation
|
1088
1173
|
#
|
@@ -1231,6 +1316,81 @@ module Aws::PinpointEmail
|
|
1231
1316
|
req.send_request(options)
|
1232
1317
|
end
|
1233
1318
|
|
1319
|
+
# Retrieve deliverability data for all the campaigns that used a
|
1320
|
+
# specific domain to send email during a specified time range. This data
|
1321
|
+
# is available for a domain only if you enabled the Deliverability
|
1322
|
+
# dashboard (`PutDeliverabilityDashboardOption` operation) for the
|
1323
|
+
# domain.
|
1324
|
+
#
|
1325
|
+
# @option params [required, Time,DateTime,Date,Integer,String] :start_date
|
1326
|
+
# The first day, in Unix time format, that you want to obtain
|
1327
|
+
# deliverability data for.
|
1328
|
+
#
|
1329
|
+
# @option params [required, Time,DateTime,Date,Integer,String] :end_date
|
1330
|
+
# The last day, in Unix time format, that you want to obtain
|
1331
|
+
# deliverability data for. This value has to be less than or equal to 30
|
1332
|
+
# days after the value of the `StartDate` parameter.
|
1333
|
+
#
|
1334
|
+
# @option params [required, String] :subscribed_domain
|
1335
|
+
# The domain to obtain deliverability data for.
|
1336
|
+
#
|
1337
|
+
# @option params [String] :next_token
|
1338
|
+
# A token that’s returned from a previous call to the
|
1339
|
+
# `ListDomainDeliverabilityCampaigns` operation. This token indicates
|
1340
|
+
# the position of a campaign in the list of campaigns.
|
1341
|
+
#
|
1342
|
+
# @option params [Integer] :page_size
|
1343
|
+
# The maximum number of results to include in response to a single call
|
1344
|
+
# to the `ListDomainDeliverabilityCampaigns` operation. If the number of
|
1345
|
+
# results is larger than the number that you specify in this parameter,
|
1346
|
+
# the response includes a `NextToken` element, which you can use to
|
1347
|
+
# obtain additional results.
|
1348
|
+
#
|
1349
|
+
# @return [Types::ListDomainDeliverabilityCampaignsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1350
|
+
#
|
1351
|
+
# * {Types::ListDomainDeliverabilityCampaignsResponse#domain_deliverability_campaigns #domain_deliverability_campaigns} => Array<Types::DomainDeliverabilityCampaign>
|
1352
|
+
# * {Types::ListDomainDeliverabilityCampaignsResponse#next_token #next_token} => String
|
1353
|
+
#
|
1354
|
+
# @example Request syntax with placeholder values
|
1355
|
+
#
|
1356
|
+
# resp = client.list_domain_deliverability_campaigns({
|
1357
|
+
# start_date: Time.now, # required
|
1358
|
+
# end_date: Time.now, # required
|
1359
|
+
# subscribed_domain: "Domain", # required
|
1360
|
+
# next_token: "NextToken",
|
1361
|
+
# page_size: 1,
|
1362
|
+
# })
|
1363
|
+
#
|
1364
|
+
# @example Response structure
|
1365
|
+
#
|
1366
|
+
# resp.domain_deliverability_campaigns #=> Array
|
1367
|
+
# resp.domain_deliverability_campaigns[0].campaign_id #=> String
|
1368
|
+
# resp.domain_deliverability_campaigns[0].image_url #=> String
|
1369
|
+
# resp.domain_deliverability_campaigns[0].subject #=> String
|
1370
|
+
# resp.domain_deliverability_campaigns[0].from_address #=> String
|
1371
|
+
# resp.domain_deliverability_campaigns[0].sending_ips #=> Array
|
1372
|
+
# resp.domain_deliverability_campaigns[0].sending_ips[0] #=> String
|
1373
|
+
# resp.domain_deliverability_campaigns[0].first_seen_date_time #=> Time
|
1374
|
+
# resp.domain_deliverability_campaigns[0].last_seen_date_time #=> Time
|
1375
|
+
# resp.domain_deliverability_campaigns[0].inbox_count #=> Integer
|
1376
|
+
# resp.domain_deliverability_campaigns[0].spam_count #=> Integer
|
1377
|
+
# resp.domain_deliverability_campaigns[0].read_rate #=> Float
|
1378
|
+
# resp.domain_deliverability_campaigns[0].delete_rate #=> Float
|
1379
|
+
# resp.domain_deliverability_campaigns[0].read_delete_rate #=> Float
|
1380
|
+
# resp.domain_deliverability_campaigns[0].projected_volume #=> Integer
|
1381
|
+
# resp.domain_deliverability_campaigns[0].esps #=> Array
|
1382
|
+
# resp.domain_deliverability_campaigns[0].esps[0] #=> String
|
1383
|
+
# resp.next_token #=> String
|
1384
|
+
#
|
1385
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26/ListDomainDeliverabilityCampaigns AWS API Documentation
|
1386
|
+
#
|
1387
|
+
# @overload list_domain_deliverability_campaigns(params = {})
|
1388
|
+
# @param [Hash] params ({})
|
1389
|
+
def list_domain_deliverability_campaigns(params = {}, options = {})
|
1390
|
+
req = build_request(:list_domain_deliverability_campaigns, params)
|
1391
|
+
req.send_request(options)
|
1392
|
+
end
|
1393
|
+
|
1234
1394
|
# Returns a list of all of the email identities that are associated with
|
1235
1395
|
# your Amazon Pinpoint account. An identity can be either an email
|
1236
1396
|
# address or a domain. This operation returns identities that are
|
@@ -1279,9 +1439,9 @@ module Aws::PinpointEmail
|
|
1279
1439
|
end
|
1280
1440
|
|
1281
1441
|
# Retrieve a list of the tags (keys and values) that are associated with
|
1282
|
-
# a
|
1283
|
-
# associate with a resource in Amazon Pinpoint. Each tag consists of
|
1284
|
-
# required *tag key* and an optional associated *tag value*. A tag key
|
1442
|
+
# a specified resource. A *tag* is a label that you optionally define
|
1443
|
+
# and associate with a resource in Amazon Pinpoint. Each tag consists of
|
1444
|
+
# a required *tag key* and an optional associated *tag value*. A tag key
|
1285
1445
|
# is a general label that acts as a category for more specific tag
|
1286
1446
|
# values. A tag value acts as a descriptor within a tag key.
|
1287
1447
|
#
|
@@ -1549,20 +1709,30 @@ module Aws::PinpointEmail
|
|
1549
1709
|
req.send_request(options)
|
1550
1710
|
end
|
1551
1711
|
|
1552
|
-
# Enable or disable the Deliverability dashboard
|
1553
|
-
#
|
1554
|
-
#
|
1712
|
+
# Enable or disable the Deliverability dashboard for your Amazon
|
1713
|
+
# Pinpoint account. When you enable the Deliverability dashboard, you
|
1714
|
+
# gain access to reputation, deliverability, and other metrics for the
|
1715
|
+
# domains that you use to send email using Amazon Pinpoint. You also
|
1555
1716
|
# gain the ability to perform predictive inbox placement tests.
|
1556
1717
|
#
|
1557
|
-
# When you use the Deliverability dashboard, you pay a monthly
|
1558
|
-
#
|
1559
|
-
# Amazon Pinpoint.
|
1560
|
-
#
|
1561
|
-
#
|
1718
|
+
# When you use the Deliverability dashboard, you pay a monthly
|
1719
|
+
# subscription charge, in addition to any other fees that you accrue by
|
1720
|
+
# using Amazon Pinpoint. For more information about the features and
|
1721
|
+
# cost of a Deliverability dashboard subscription, see [Amazon Pinpoint
|
1722
|
+
# Pricing][1].
|
1723
|
+
#
|
1724
|
+
#
|
1725
|
+
#
|
1726
|
+
# [1]: http://aws.amazon.com/pinpoint/pricing/
|
1562
1727
|
#
|
1563
1728
|
# @option params [required, Boolean] :dashboard_enabled
|
1564
|
-
#
|
1565
|
-
#
|
1729
|
+
# Specifies whether to enable the Deliverability dashboard for your
|
1730
|
+
# Amazon Pinpoint account. To enable the dashboard, set this value to
|
1731
|
+
# `true`.
|
1732
|
+
#
|
1733
|
+
# @option params [Array<Types::DomainDeliverabilityTrackingOption>] :subscribed_domains
|
1734
|
+
# An array of objects, one for each verified domain that you use to send
|
1735
|
+
# email and enabled the Deliverability dashboard for.
|
1566
1736
|
#
|
1567
1737
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1568
1738
|
#
|
@@ -1570,6 +1740,16 @@ module Aws::PinpointEmail
|
|
1570
1740
|
#
|
1571
1741
|
# resp = client.put_deliverability_dashboard_option({
|
1572
1742
|
# dashboard_enabled: false, # required
|
1743
|
+
# subscribed_domains: [
|
1744
|
+
# {
|
1745
|
+
# domain: "Domain",
|
1746
|
+
# subscription_start_date: Time.now,
|
1747
|
+
# inbox_placement_tracking_option: {
|
1748
|
+
# global: false,
|
1749
|
+
# tracked_isps: ["IspName"],
|
1750
|
+
# },
|
1751
|
+
# },
|
1752
|
+
# ],
|
1573
1753
|
# })
|
1574
1754
|
#
|
1575
1755
|
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26/PutDeliverabilityDashboardOption AWS API Documentation
|
@@ -1816,12 +1996,11 @@ module Aws::PinpointEmail
|
|
1816
1996
|
req.send_request(options)
|
1817
1997
|
end
|
1818
1998
|
|
1819
|
-
# Add one or more tags (keys and values) to
|
1820
|
-
#
|
1821
|
-
#
|
1822
|
-
#
|
1823
|
-
#
|
1824
|
-
# tags.
|
1999
|
+
# Add one or more tags (keys and values) to a specified resource. A
|
2000
|
+
# *tag* is a label that you optionally define and associate with a
|
2001
|
+
# resource in Amazon Pinpoint. Tags can help you categorize and manage
|
2002
|
+
# resources in different ways, such as by purpose, owner, environment,
|
2003
|
+
# or other criteria. A resource can have as many as 50 tags.
|
1825
2004
|
#
|
1826
2005
|
# Each tag consists of a required *tag key* and an associated *tag
|
1827
2006
|
# value*, both of which you define. A tag key is a general label that
|
@@ -1969,7 +2148,7 @@ module Aws::PinpointEmail
|
|
1969
2148
|
params: params,
|
1970
2149
|
config: config)
|
1971
2150
|
context[:gem_name] = 'aws-sdk-pinpointemail'
|
1972
|
-
context[:gem_version] = '1.
|
2151
|
+
context[:gem_version] = '1.10.0'
|
1973
2152
|
Seahorse::Client::Request.new(handlers, context)
|
1974
2153
|
end
|
1975
2154
|
|
@@ -23,6 +23,7 @@ module Aws::PinpointEmail
|
|
23
23
|
BlacklistReport = Shapes::MapShape.new(name: 'BlacklistReport')
|
24
24
|
BlacklistingDescription = Shapes::StringShape.new(name: 'BlacklistingDescription')
|
25
25
|
Body = Shapes::StructureShape.new(name: 'Body')
|
26
|
+
CampaignId = Shapes::StringShape.new(name: 'CampaignId')
|
26
27
|
Charset = Shapes::StringShape.new(name: 'Charset')
|
27
28
|
CloudWatchDestination = Shapes::StructureShape.new(name: 'CloudWatchDestination')
|
28
29
|
CloudWatchDimensionConfiguration = Shapes::StructureShape.new(name: 'CloudWatchDimensionConfiguration')
|
@@ -55,6 +56,7 @@ module Aws::PinpointEmail
|
|
55
56
|
DeleteDedicatedIpPoolResponse = Shapes::StructureShape.new(name: 'DeleteDedicatedIpPoolResponse')
|
56
57
|
DeleteEmailIdentityRequest = Shapes::StructureShape.new(name: 'DeleteEmailIdentityRequest')
|
57
58
|
DeleteEmailIdentityResponse = Shapes::StructureShape.new(name: 'DeleteEmailIdentityResponse')
|
59
|
+
DeliverabilityDashboardAccountStatus = Shapes::StringShape.new(name: 'DeliverabilityDashboardAccountStatus')
|
58
60
|
DeliverabilityTestReport = Shapes::StructureShape.new(name: 'DeliverabilityTestReport')
|
59
61
|
DeliverabilityTestReports = Shapes::ListShape.new(name: 'DeliverabilityTestReports')
|
60
62
|
DeliverabilityTestStatus = Shapes::StringShape.new(name: 'DeliverabilityTestStatus')
|
@@ -67,12 +69,19 @@ module Aws::PinpointEmail
|
|
67
69
|
DkimStatus = Shapes::StringShape.new(name: 'DkimStatus')
|
68
70
|
DnsToken = Shapes::StringShape.new(name: 'DnsToken')
|
69
71
|
DnsTokenList = Shapes::ListShape.new(name: 'DnsTokenList')
|
72
|
+
Domain = Shapes::StringShape.new(name: 'Domain')
|
73
|
+
DomainDeliverabilityCampaign = Shapes::StructureShape.new(name: 'DomainDeliverabilityCampaign')
|
74
|
+
DomainDeliverabilityCampaignList = Shapes::ListShape.new(name: 'DomainDeliverabilityCampaignList')
|
75
|
+
DomainDeliverabilityTrackingOption = Shapes::StructureShape.new(name: 'DomainDeliverabilityTrackingOption')
|
76
|
+
DomainDeliverabilityTrackingOptions = Shapes::ListShape.new(name: 'DomainDeliverabilityTrackingOptions')
|
70
77
|
DomainIspPlacement = Shapes::StructureShape.new(name: 'DomainIspPlacement')
|
71
78
|
DomainIspPlacements = Shapes::ListShape.new(name: 'DomainIspPlacements')
|
72
79
|
EmailAddress = Shapes::StringShape.new(name: 'EmailAddress')
|
73
80
|
EmailAddressList = Shapes::ListShape.new(name: 'EmailAddressList')
|
74
81
|
EmailContent = Shapes::StructureShape.new(name: 'EmailContent')
|
75
82
|
Enabled = Shapes::BooleanShape.new(name: 'Enabled')
|
83
|
+
Esp = Shapes::StringShape.new(name: 'Esp')
|
84
|
+
Esps = Shapes::ListShape.new(name: 'Esps')
|
76
85
|
EventDestination = Shapes::StructureShape.new(name: 'EventDestination')
|
77
86
|
EventDestinationDefinition = Shapes::StructureShape.new(name: 'EventDestinationDefinition')
|
78
87
|
EventDestinationName = Shapes::StringShape.new(name: 'EventDestinationName')
|
@@ -96,6 +105,8 @@ module Aws::PinpointEmail
|
|
96
105
|
GetDeliverabilityDashboardOptionsResponse = Shapes::StructureShape.new(name: 'GetDeliverabilityDashboardOptionsResponse')
|
97
106
|
GetDeliverabilityTestReportRequest = Shapes::StructureShape.new(name: 'GetDeliverabilityTestReportRequest')
|
98
107
|
GetDeliverabilityTestReportResponse = Shapes::StructureShape.new(name: 'GetDeliverabilityTestReportResponse')
|
108
|
+
GetDomainDeliverabilityCampaignRequest = Shapes::StructureShape.new(name: 'GetDomainDeliverabilityCampaignRequest')
|
109
|
+
GetDomainDeliverabilityCampaignResponse = Shapes::StructureShape.new(name: 'GetDomainDeliverabilityCampaignResponse')
|
99
110
|
GetDomainStatisticsReportRequest = Shapes::StructureShape.new(name: 'GetDomainStatisticsReportRequest')
|
100
111
|
GetDomainStatisticsReportResponse = Shapes::StructureShape.new(name: 'GetDomainStatisticsReportResponse')
|
101
112
|
GetEmailIdentityRequest = Shapes::StructureShape.new(name: 'GetEmailIdentityRequest')
|
@@ -104,8 +115,12 @@ module Aws::PinpointEmail
|
|
104
115
|
IdentityInfo = Shapes::StructureShape.new(name: 'IdentityInfo')
|
105
116
|
IdentityInfoList = Shapes::ListShape.new(name: 'IdentityInfoList')
|
106
117
|
IdentityType = Shapes::StringShape.new(name: 'IdentityType')
|
118
|
+
ImageUrl = Shapes::StringShape.new(name: 'ImageUrl')
|
119
|
+
InboxPlacementTrackingOption = Shapes::StructureShape.new(name: 'InboxPlacementTrackingOption')
|
107
120
|
Ip = Shapes::StringShape.new(name: 'Ip')
|
121
|
+
IpList = Shapes::ListShape.new(name: 'IpList')
|
108
122
|
IspName = Shapes::StringShape.new(name: 'IspName')
|
123
|
+
IspNameList = Shapes::ListShape.new(name: 'IspNameList')
|
109
124
|
IspPlacement = Shapes::StructureShape.new(name: 'IspPlacement')
|
110
125
|
IspPlacements = Shapes::ListShape.new(name: 'IspPlacements')
|
111
126
|
KinesisFirehoseDestination = Shapes::StructureShape.new(name: 'KinesisFirehoseDestination')
|
@@ -117,6 +132,8 @@ module Aws::PinpointEmail
|
|
117
132
|
ListDedicatedIpPoolsResponse = Shapes::StructureShape.new(name: 'ListDedicatedIpPoolsResponse')
|
118
133
|
ListDeliverabilityTestReportsRequest = Shapes::StructureShape.new(name: 'ListDeliverabilityTestReportsRequest')
|
119
134
|
ListDeliverabilityTestReportsResponse = Shapes::StructureShape.new(name: 'ListDeliverabilityTestReportsResponse')
|
135
|
+
ListDomainDeliverabilityCampaignsRequest = Shapes::StructureShape.new(name: 'ListDomainDeliverabilityCampaignsRequest')
|
136
|
+
ListDomainDeliverabilityCampaignsResponse = Shapes::StructureShape.new(name: 'ListDomainDeliverabilityCampaignsResponse')
|
120
137
|
ListEmailIdentitiesRequest = Shapes::StructureShape.new(name: 'ListEmailIdentitiesRequest')
|
121
138
|
ListEmailIdentitiesResponse = Shapes::StructureShape.new(name: 'ListEmailIdentitiesResponse')
|
122
139
|
ListOfDedicatedIpPools = Shapes::ListShape.new(name: 'ListOfDedicatedIpPools')
|
@@ -184,6 +201,7 @@ module Aws::PinpointEmail
|
|
184
201
|
SendingPoolName = Shapes::StringShape.new(name: 'SendingPoolName')
|
185
202
|
SentLast24Hours = Shapes::FloatShape.new(name: 'SentLast24Hours')
|
186
203
|
SnsDestination = Shapes::StructureShape.new(name: 'SnsDestination')
|
204
|
+
Subject = Shapes::StringShape.new(name: 'Subject')
|
187
205
|
Tag = Shapes::StructureShape.new(name: 'Tag')
|
188
206
|
TagKey = Shapes::StringShape.new(name: 'TagKey')
|
189
207
|
TagKeyList = Shapes::ListShape.new(name: 'TagKeyList')
|
@@ -241,7 +259,7 @@ module Aws::PinpointEmail
|
|
241
259
|
|
242
260
|
CreateConfigurationSetEventDestinationResponse.struct_class = Types::CreateConfigurationSetEventDestinationResponse
|
243
261
|
|
244
|
-
CreateConfigurationSetRequest.add_member(:configuration_set_name, Shapes::ShapeRef.new(shape: ConfigurationSetName, location_name: "ConfigurationSetName"))
|
262
|
+
CreateConfigurationSetRequest.add_member(:configuration_set_name, Shapes::ShapeRef.new(shape: ConfigurationSetName, required: true, location_name: "ConfigurationSetName"))
|
245
263
|
CreateConfigurationSetRequest.add_member(:tracking_options, Shapes::ShapeRef.new(shape: TrackingOptions, location_name: "TrackingOptions"))
|
246
264
|
CreateConfigurationSetRequest.add_member(:delivery_options, Shapes::ShapeRef.new(shape: DeliveryOptions, location_name: "DeliveryOptions"))
|
247
265
|
CreateConfigurationSetRequest.add_member(:reputation_options, Shapes::ShapeRef.new(shape: ReputationOptions, location_name: "ReputationOptions"))
|
@@ -337,6 +355,31 @@ module Aws::PinpointEmail
|
|
337
355
|
|
338
356
|
DnsTokenList.member = Shapes::ShapeRef.new(shape: DnsToken)
|
339
357
|
|
358
|
+
DomainDeliverabilityCampaign.add_member(:campaign_id, Shapes::ShapeRef.new(shape: CampaignId, location_name: "CampaignId"))
|
359
|
+
DomainDeliverabilityCampaign.add_member(:image_url, Shapes::ShapeRef.new(shape: ImageUrl, location_name: "ImageUrl"))
|
360
|
+
DomainDeliverabilityCampaign.add_member(:subject, Shapes::ShapeRef.new(shape: Subject, location_name: "Subject"))
|
361
|
+
DomainDeliverabilityCampaign.add_member(:from_address, Shapes::ShapeRef.new(shape: Identity, location_name: "FromAddress"))
|
362
|
+
DomainDeliverabilityCampaign.add_member(:sending_ips, Shapes::ShapeRef.new(shape: IpList, location_name: "SendingIps"))
|
363
|
+
DomainDeliverabilityCampaign.add_member(:first_seen_date_time, Shapes::ShapeRef.new(shape: Timestamp, location_name: "FirstSeenDateTime"))
|
364
|
+
DomainDeliverabilityCampaign.add_member(:last_seen_date_time, Shapes::ShapeRef.new(shape: Timestamp, location_name: "LastSeenDateTime"))
|
365
|
+
DomainDeliverabilityCampaign.add_member(:inbox_count, Shapes::ShapeRef.new(shape: Volume, location_name: "InboxCount"))
|
366
|
+
DomainDeliverabilityCampaign.add_member(:spam_count, Shapes::ShapeRef.new(shape: Volume, location_name: "SpamCount"))
|
367
|
+
DomainDeliverabilityCampaign.add_member(:read_rate, Shapes::ShapeRef.new(shape: Percentage, location_name: "ReadRate"))
|
368
|
+
DomainDeliverabilityCampaign.add_member(:delete_rate, Shapes::ShapeRef.new(shape: Percentage, location_name: "DeleteRate"))
|
369
|
+
DomainDeliverabilityCampaign.add_member(:read_delete_rate, Shapes::ShapeRef.new(shape: Percentage, location_name: "ReadDeleteRate"))
|
370
|
+
DomainDeliverabilityCampaign.add_member(:projected_volume, Shapes::ShapeRef.new(shape: Volume, location_name: "ProjectedVolume"))
|
371
|
+
DomainDeliverabilityCampaign.add_member(:esps, Shapes::ShapeRef.new(shape: Esps, location_name: "Esps"))
|
372
|
+
DomainDeliverabilityCampaign.struct_class = Types::DomainDeliverabilityCampaign
|
373
|
+
|
374
|
+
DomainDeliverabilityCampaignList.member = Shapes::ShapeRef.new(shape: DomainDeliverabilityCampaign)
|
375
|
+
|
376
|
+
DomainDeliverabilityTrackingOption.add_member(:domain, Shapes::ShapeRef.new(shape: Domain, location_name: "Domain"))
|
377
|
+
DomainDeliverabilityTrackingOption.add_member(:subscription_start_date, Shapes::ShapeRef.new(shape: Timestamp, location_name: "SubscriptionStartDate"))
|
378
|
+
DomainDeliverabilityTrackingOption.add_member(:inbox_placement_tracking_option, Shapes::ShapeRef.new(shape: InboxPlacementTrackingOption, location_name: "InboxPlacementTrackingOption"))
|
379
|
+
DomainDeliverabilityTrackingOption.struct_class = Types::DomainDeliverabilityTrackingOption
|
380
|
+
|
381
|
+
DomainDeliverabilityTrackingOptions.member = Shapes::ShapeRef.new(shape: DomainDeliverabilityTrackingOption)
|
382
|
+
|
340
383
|
DomainIspPlacement.add_member(:isp_name, Shapes::ShapeRef.new(shape: IspName, location_name: "IspName"))
|
341
384
|
DomainIspPlacement.add_member(:inbox_raw_count, Shapes::ShapeRef.new(shape: Volume, location_name: "InboxRawCount"))
|
342
385
|
DomainIspPlacement.add_member(:spam_raw_count, Shapes::ShapeRef.new(shape: Volume, location_name: "SpamRawCount"))
|
@@ -352,6 +395,8 @@ module Aws::PinpointEmail
|
|
352
395
|
EmailContent.add_member(:raw, Shapes::ShapeRef.new(shape: RawMessage, location_name: "Raw"))
|
353
396
|
EmailContent.struct_class = Types::EmailContent
|
354
397
|
|
398
|
+
Esps.member = Shapes::ShapeRef.new(shape: Esp)
|
399
|
+
|
355
400
|
EventDestination.add_member(:name, Shapes::ShapeRef.new(shape: EventDestinationName, required: true, location_name: "Name"))
|
356
401
|
EventDestination.add_member(:enabled, Shapes::ShapeRef.new(shape: Enabled, location_name: "Enabled"))
|
357
402
|
EventDestination.add_member(:matching_event_types, Shapes::ShapeRef.new(shape: EventTypes, required: true, location_name: "MatchingEventTypes"))
|
@@ -382,7 +427,7 @@ module Aws::PinpointEmail
|
|
382
427
|
GetAccountResponse.add_member(:production_access_enabled, Shapes::ShapeRef.new(shape: Enabled, location_name: "ProductionAccessEnabled"))
|
383
428
|
GetAccountResponse.struct_class = Types::GetAccountResponse
|
384
429
|
|
385
|
-
GetBlacklistReportsRequest.add_member(:blacklist_item_names, Shapes::ShapeRef.new(shape: BlacklistItemNames, required: true, location_name: "BlacklistItemNames"))
|
430
|
+
GetBlacklistReportsRequest.add_member(:blacklist_item_names, Shapes::ShapeRef.new(shape: BlacklistItemNames, required: true, location: "querystring", location_name: "BlacklistItemNames"))
|
386
431
|
GetBlacklistReportsRequest.struct_class = Types::GetBlacklistReportsRequest
|
387
432
|
|
388
433
|
GetBlacklistReportsResponse.add_member(:blacklist_report, Shapes::ShapeRef.new(shape: BlacklistReport, required: true, location_name: "BlacklistReport"))
|
@@ -402,6 +447,7 @@ module Aws::PinpointEmail
|
|
402
447
|
GetConfigurationSetResponse.add_member(:delivery_options, Shapes::ShapeRef.new(shape: DeliveryOptions, location_name: "DeliveryOptions"))
|
403
448
|
GetConfigurationSetResponse.add_member(:reputation_options, Shapes::ShapeRef.new(shape: ReputationOptions, location_name: "ReputationOptions"))
|
404
449
|
GetConfigurationSetResponse.add_member(:sending_options, Shapes::ShapeRef.new(shape: SendingOptions, location_name: "SendingOptions"))
|
450
|
+
GetConfigurationSetResponse.add_member(:tags, Shapes::ShapeRef.new(shape: TagList, location_name: "Tags"))
|
405
451
|
GetConfigurationSetResponse.struct_class = Types::GetConfigurationSetResponse
|
406
452
|
|
407
453
|
GetDedicatedIpRequest.add_member(:ip, Shapes::ShapeRef.new(shape: Ip, required: true, location: "uri", location_name: "IP"))
|
@@ -410,9 +456,9 @@ module Aws::PinpointEmail
|
|
410
456
|
GetDedicatedIpResponse.add_member(:dedicated_ip, Shapes::ShapeRef.new(shape: DedicatedIp, location_name: "DedicatedIp"))
|
411
457
|
GetDedicatedIpResponse.struct_class = Types::GetDedicatedIpResponse
|
412
458
|
|
413
|
-
GetDedicatedIpsRequest.add_member(:pool_name, Shapes::ShapeRef.new(shape: PoolName, location_name: "PoolName"))
|
414
|
-
GetDedicatedIpsRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "NextToken"))
|
415
|
-
GetDedicatedIpsRequest.add_member(:page_size, Shapes::ShapeRef.new(shape: MaxItems, location_name: "PageSize"))
|
459
|
+
GetDedicatedIpsRequest.add_member(:pool_name, Shapes::ShapeRef.new(shape: PoolName, location: "querystring", location_name: "PoolName"))
|
460
|
+
GetDedicatedIpsRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location: "querystring", location_name: "NextToken"))
|
461
|
+
GetDedicatedIpsRequest.add_member(:page_size, Shapes::ShapeRef.new(shape: MaxItems, location: "querystring", location_name: "PageSize"))
|
416
462
|
GetDedicatedIpsRequest.struct_class = Types::GetDedicatedIpsRequest
|
417
463
|
|
418
464
|
GetDedicatedIpsResponse.add_member(:dedicated_ips, Shapes::ShapeRef.new(shape: DedicatedIpList, location_name: "DedicatedIps"))
|
@@ -422,6 +468,10 @@ module Aws::PinpointEmail
|
|
422
468
|
GetDeliverabilityDashboardOptionsRequest.struct_class = Types::GetDeliverabilityDashboardOptionsRequest
|
423
469
|
|
424
470
|
GetDeliverabilityDashboardOptionsResponse.add_member(:dashboard_enabled, Shapes::ShapeRef.new(shape: Enabled, required: true, location_name: "DashboardEnabled"))
|
471
|
+
GetDeliverabilityDashboardOptionsResponse.add_member(:subscription_expiry_date, Shapes::ShapeRef.new(shape: Timestamp, location_name: "SubscriptionExpiryDate"))
|
472
|
+
GetDeliverabilityDashboardOptionsResponse.add_member(:account_status, Shapes::ShapeRef.new(shape: DeliverabilityDashboardAccountStatus, location_name: "AccountStatus"))
|
473
|
+
GetDeliverabilityDashboardOptionsResponse.add_member(:active_subscribed_domains, Shapes::ShapeRef.new(shape: DomainDeliverabilityTrackingOptions, location_name: "ActiveSubscribedDomains"))
|
474
|
+
GetDeliverabilityDashboardOptionsResponse.add_member(:pending_expiration_subscribed_domains, Shapes::ShapeRef.new(shape: DomainDeliverabilityTrackingOptions, location_name: "PendingExpirationSubscribedDomains"))
|
425
475
|
GetDeliverabilityDashboardOptionsResponse.struct_class = Types::GetDeliverabilityDashboardOptionsResponse
|
426
476
|
|
427
477
|
GetDeliverabilityTestReportRequest.add_member(:report_id, Shapes::ShapeRef.new(shape: ReportId, required: true, location: "uri", location_name: "ReportId"))
|
@@ -431,11 +481,18 @@ module Aws::PinpointEmail
|
|
431
481
|
GetDeliverabilityTestReportResponse.add_member(:overall_placement, Shapes::ShapeRef.new(shape: PlacementStatistics, required: true, location_name: "OverallPlacement"))
|
432
482
|
GetDeliverabilityTestReportResponse.add_member(:isp_placements, Shapes::ShapeRef.new(shape: IspPlacements, required: true, location_name: "IspPlacements"))
|
433
483
|
GetDeliverabilityTestReportResponse.add_member(:message, Shapes::ShapeRef.new(shape: MessageContent, location_name: "Message"))
|
484
|
+
GetDeliverabilityTestReportResponse.add_member(:tags, Shapes::ShapeRef.new(shape: TagList, location_name: "Tags"))
|
434
485
|
GetDeliverabilityTestReportResponse.struct_class = Types::GetDeliverabilityTestReportResponse
|
435
486
|
|
487
|
+
GetDomainDeliverabilityCampaignRequest.add_member(:campaign_id, Shapes::ShapeRef.new(shape: CampaignId, required: true, location: "uri", location_name: "CampaignId"))
|
488
|
+
GetDomainDeliverabilityCampaignRequest.struct_class = Types::GetDomainDeliverabilityCampaignRequest
|
489
|
+
|
490
|
+
GetDomainDeliverabilityCampaignResponse.add_member(:domain_deliverability_campaign, Shapes::ShapeRef.new(shape: DomainDeliverabilityCampaign, required: true, location_name: "DomainDeliverabilityCampaign"))
|
491
|
+
GetDomainDeliverabilityCampaignResponse.struct_class = Types::GetDomainDeliverabilityCampaignResponse
|
492
|
+
|
436
493
|
GetDomainStatisticsReportRequest.add_member(:domain, Shapes::ShapeRef.new(shape: Identity, required: true, location: "uri", location_name: "Domain"))
|
437
|
-
GetDomainStatisticsReportRequest.add_member(:start_date, Shapes::ShapeRef.new(shape: Timestamp, required: true, location_name: "StartDate"))
|
438
|
-
GetDomainStatisticsReportRequest.add_member(:end_date, Shapes::ShapeRef.new(shape: Timestamp, required: true, location_name: "EndDate"))
|
494
|
+
GetDomainStatisticsReportRequest.add_member(:start_date, Shapes::ShapeRef.new(shape: Timestamp, required: true, location: "querystring", location_name: "StartDate"))
|
495
|
+
GetDomainStatisticsReportRequest.add_member(:end_date, Shapes::ShapeRef.new(shape: Timestamp, required: true, location: "querystring", location_name: "EndDate"))
|
439
496
|
GetDomainStatisticsReportRequest.struct_class = Types::GetDomainStatisticsReportRequest
|
440
497
|
|
441
498
|
GetDomainStatisticsReportResponse.add_member(:overall_volume, Shapes::ShapeRef.new(shape: OverallVolume, required: true, location_name: "OverallVolume"))
|
@@ -450,6 +507,7 @@ module Aws::PinpointEmail
|
|
450
507
|
GetEmailIdentityResponse.add_member(:verified_for_sending_status, Shapes::ShapeRef.new(shape: Enabled, location_name: "VerifiedForSendingStatus"))
|
451
508
|
GetEmailIdentityResponse.add_member(:dkim_attributes, Shapes::ShapeRef.new(shape: DkimAttributes, location_name: "DkimAttributes"))
|
452
509
|
GetEmailIdentityResponse.add_member(:mail_from_attributes, Shapes::ShapeRef.new(shape: MailFromAttributes, location_name: "MailFromAttributes"))
|
510
|
+
GetEmailIdentityResponse.add_member(:tags, Shapes::ShapeRef.new(shape: TagList, location_name: "Tags"))
|
453
511
|
GetEmailIdentityResponse.struct_class = Types::GetEmailIdentityResponse
|
454
512
|
|
455
513
|
IdentityInfo.add_member(:identity_type, Shapes::ShapeRef.new(shape: IdentityType, location_name: "IdentityType"))
|
@@ -459,6 +517,14 @@ module Aws::PinpointEmail
|
|
459
517
|
|
460
518
|
IdentityInfoList.member = Shapes::ShapeRef.new(shape: IdentityInfo)
|
461
519
|
|
520
|
+
InboxPlacementTrackingOption.add_member(:global, Shapes::ShapeRef.new(shape: Enabled, location_name: "Global"))
|
521
|
+
InboxPlacementTrackingOption.add_member(:tracked_isps, Shapes::ShapeRef.new(shape: IspNameList, location_name: "TrackedIsps"))
|
522
|
+
InboxPlacementTrackingOption.struct_class = Types::InboxPlacementTrackingOption
|
523
|
+
|
524
|
+
IpList.member = Shapes::ShapeRef.new(shape: Ip)
|
525
|
+
|
526
|
+
IspNameList.member = Shapes::ShapeRef.new(shape: IspName)
|
527
|
+
|
462
528
|
IspPlacement.add_member(:isp_name, Shapes::ShapeRef.new(shape: IspName, location_name: "IspName"))
|
463
529
|
IspPlacement.add_member(:placement_statistics, Shapes::ShapeRef.new(shape: PlacementStatistics, location_name: "PlacementStatistics"))
|
464
530
|
IspPlacement.struct_class = Types::IspPlacement
|
@@ -469,32 +535,43 @@ module Aws::PinpointEmail
|
|
469
535
|
KinesisFirehoseDestination.add_member(:delivery_stream_arn, Shapes::ShapeRef.new(shape: AmazonResourceName, required: true, location_name: "DeliveryStreamArn"))
|
470
536
|
KinesisFirehoseDestination.struct_class = Types::KinesisFirehoseDestination
|
471
537
|
|
472
|
-
ListConfigurationSetsRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "NextToken"))
|
473
|
-
ListConfigurationSetsRequest.add_member(:page_size, Shapes::ShapeRef.new(shape: MaxItems, location_name: "PageSize"))
|
538
|
+
ListConfigurationSetsRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location: "querystring", location_name: "NextToken"))
|
539
|
+
ListConfigurationSetsRequest.add_member(:page_size, Shapes::ShapeRef.new(shape: MaxItems, location: "querystring", location_name: "PageSize"))
|
474
540
|
ListConfigurationSetsRequest.struct_class = Types::ListConfigurationSetsRequest
|
475
541
|
|
476
542
|
ListConfigurationSetsResponse.add_member(:configuration_sets, Shapes::ShapeRef.new(shape: ConfigurationSetNameList, location_name: "ConfigurationSets"))
|
477
543
|
ListConfigurationSetsResponse.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "NextToken"))
|
478
544
|
ListConfigurationSetsResponse.struct_class = Types::ListConfigurationSetsResponse
|
479
545
|
|
480
|
-
ListDedicatedIpPoolsRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "NextToken"))
|
481
|
-
ListDedicatedIpPoolsRequest.add_member(:page_size, Shapes::ShapeRef.new(shape: MaxItems, location_name: "PageSize"))
|
546
|
+
ListDedicatedIpPoolsRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location: "querystring", location_name: "NextToken"))
|
547
|
+
ListDedicatedIpPoolsRequest.add_member(:page_size, Shapes::ShapeRef.new(shape: MaxItems, location: "querystring", location_name: "PageSize"))
|
482
548
|
ListDedicatedIpPoolsRequest.struct_class = Types::ListDedicatedIpPoolsRequest
|
483
549
|
|
484
550
|
ListDedicatedIpPoolsResponse.add_member(:dedicated_ip_pools, Shapes::ShapeRef.new(shape: ListOfDedicatedIpPools, location_name: "DedicatedIpPools"))
|
485
551
|
ListDedicatedIpPoolsResponse.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "NextToken"))
|
486
552
|
ListDedicatedIpPoolsResponse.struct_class = Types::ListDedicatedIpPoolsResponse
|
487
553
|
|
488
|
-
ListDeliverabilityTestReportsRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "NextToken"))
|
489
|
-
ListDeliverabilityTestReportsRequest.add_member(:page_size, Shapes::ShapeRef.new(shape: MaxItems, location_name: "PageSize"))
|
554
|
+
ListDeliverabilityTestReportsRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location: "querystring", location_name: "NextToken"))
|
555
|
+
ListDeliverabilityTestReportsRequest.add_member(:page_size, Shapes::ShapeRef.new(shape: MaxItems, location: "querystring", location_name: "PageSize"))
|
490
556
|
ListDeliverabilityTestReportsRequest.struct_class = Types::ListDeliverabilityTestReportsRequest
|
491
557
|
|
492
558
|
ListDeliverabilityTestReportsResponse.add_member(:deliverability_test_reports, Shapes::ShapeRef.new(shape: DeliverabilityTestReports, required: true, location_name: "DeliverabilityTestReports"))
|
493
559
|
ListDeliverabilityTestReportsResponse.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "NextToken"))
|
494
560
|
ListDeliverabilityTestReportsResponse.struct_class = Types::ListDeliverabilityTestReportsResponse
|
495
561
|
|
496
|
-
|
497
|
-
|
562
|
+
ListDomainDeliverabilityCampaignsRequest.add_member(:start_date, Shapes::ShapeRef.new(shape: Timestamp, required: true, location: "querystring", location_name: "StartDate"))
|
563
|
+
ListDomainDeliverabilityCampaignsRequest.add_member(:end_date, Shapes::ShapeRef.new(shape: Timestamp, required: true, location: "querystring", location_name: "EndDate"))
|
564
|
+
ListDomainDeliverabilityCampaignsRequest.add_member(:subscribed_domain, Shapes::ShapeRef.new(shape: Domain, required: true, location: "uri", location_name: "SubscribedDomain"))
|
565
|
+
ListDomainDeliverabilityCampaignsRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location: "querystring", location_name: "NextToken"))
|
566
|
+
ListDomainDeliverabilityCampaignsRequest.add_member(:page_size, Shapes::ShapeRef.new(shape: MaxItems, location: "querystring", location_name: "PageSize"))
|
567
|
+
ListDomainDeliverabilityCampaignsRequest.struct_class = Types::ListDomainDeliverabilityCampaignsRequest
|
568
|
+
|
569
|
+
ListDomainDeliverabilityCampaignsResponse.add_member(:domain_deliverability_campaigns, Shapes::ShapeRef.new(shape: DomainDeliverabilityCampaignList, required: true, location_name: "DomainDeliverabilityCampaigns"))
|
570
|
+
ListDomainDeliverabilityCampaignsResponse.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "NextToken"))
|
571
|
+
ListDomainDeliverabilityCampaignsResponse.struct_class = Types::ListDomainDeliverabilityCampaignsResponse
|
572
|
+
|
573
|
+
ListEmailIdentitiesRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location: "querystring", location_name: "NextToken"))
|
574
|
+
ListEmailIdentitiesRequest.add_member(:page_size, Shapes::ShapeRef.new(shape: MaxItems, location: "querystring", location_name: "PageSize"))
|
498
575
|
ListEmailIdentitiesRequest.struct_class = Types::ListEmailIdentitiesRequest
|
499
576
|
|
500
577
|
ListEmailIdentitiesResponse.add_member(:email_identities, Shapes::ShapeRef.new(shape: IdentityInfoList, location_name: "EmailIdentities"))
|
@@ -503,7 +580,7 @@ module Aws::PinpointEmail
|
|
503
580
|
|
504
581
|
ListOfDedicatedIpPools.member = Shapes::ShapeRef.new(shape: PoolName)
|
505
582
|
|
506
|
-
ListTagsForResourceRequest.add_member(:resource_arn, Shapes::ShapeRef.new(shape: AmazonResourceName, required: true, location_name: "ResourceArn"))
|
583
|
+
ListTagsForResourceRequest.add_member(:resource_arn, Shapes::ShapeRef.new(shape: AmazonResourceName, required: true, location: "querystring", location_name: "ResourceArn"))
|
507
584
|
ListTagsForResourceRequest.struct_class = Types::ListTagsForResourceRequest
|
508
585
|
|
509
586
|
ListTagsForResourceResponse.add_member(:tags, Shapes::ShapeRef.new(shape: TagList, required: true, location_name: "Tags"))
|
@@ -586,6 +663,7 @@ module Aws::PinpointEmail
|
|
586
663
|
PutDedicatedIpWarmupAttributesResponse.struct_class = Types::PutDedicatedIpWarmupAttributesResponse
|
587
664
|
|
588
665
|
PutDeliverabilityDashboardOptionRequest.add_member(:dashboard_enabled, Shapes::ShapeRef.new(shape: Enabled, required: true, location_name: "DashboardEnabled"))
|
666
|
+
PutDeliverabilityDashboardOptionRequest.add_member(:subscribed_domains, Shapes::ShapeRef.new(shape: DomainDeliverabilityTrackingOptions, location_name: "SubscribedDomains"))
|
589
667
|
PutDeliverabilityDashboardOptionRequest.struct_class = Types::PutDeliverabilityDashboardOptionRequest
|
590
668
|
|
591
669
|
PutDeliverabilityDashboardOptionResponse.struct_class = Types::PutDeliverabilityDashboardOptionResponse
|
@@ -904,6 +982,17 @@ module Aws::PinpointEmail
|
|
904
982
|
o.errors << Shapes::ShapeRef.new(shape: BadRequestException)
|
905
983
|
end)
|
906
984
|
|
985
|
+
api.add_operation(:get_domain_deliverability_campaign, Seahorse::Model::Operation.new.tap do |o|
|
986
|
+
o.name = "GetDomainDeliverabilityCampaign"
|
987
|
+
o.http_method = "GET"
|
988
|
+
o.http_request_uri = "/v1/email/deliverability-dashboard/campaigns/{CampaignId}"
|
989
|
+
o.input = Shapes::ShapeRef.new(shape: GetDomainDeliverabilityCampaignRequest)
|
990
|
+
o.output = Shapes::ShapeRef.new(shape: GetDomainDeliverabilityCampaignResponse)
|
991
|
+
o.errors << Shapes::ShapeRef.new(shape: TooManyRequestsException)
|
992
|
+
o.errors << Shapes::ShapeRef.new(shape: BadRequestException)
|
993
|
+
o.errors << Shapes::ShapeRef.new(shape: NotFoundException)
|
994
|
+
end)
|
995
|
+
|
907
996
|
api.add_operation(:get_domain_statistics_report, Seahorse::Model::Operation.new.tap do |o|
|
908
997
|
o.name = "GetDomainStatisticsReport"
|
909
998
|
o.http_method = "GET"
|
@@ -975,6 +1064,23 @@ module Aws::PinpointEmail
|
|
975
1064
|
)
|
976
1065
|
end)
|
977
1066
|
|
1067
|
+
api.add_operation(:list_domain_deliverability_campaigns, Seahorse::Model::Operation.new.tap do |o|
|
1068
|
+
o.name = "ListDomainDeliverabilityCampaigns"
|
1069
|
+
o.http_method = "GET"
|
1070
|
+
o.http_request_uri = "/v1/email/deliverability-dashboard/domains/{SubscribedDomain}/campaigns"
|
1071
|
+
o.input = Shapes::ShapeRef.new(shape: ListDomainDeliverabilityCampaignsRequest)
|
1072
|
+
o.output = Shapes::ShapeRef.new(shape: ListDomainDeliverabilityCampaignsResponse)
|
1073
|
+
o.errors << Shapes::ShapeRef.new(shape: TooManyRequestsException)
|
1074
|
+
o.errors << Shapes::ShapeRef.new(shape: BadRequestException)
|
1075
|
+
o.errors << Shapes::ShapeRef.new(shape: NotFoundException)
|
1076
|
+
o[:pager] = Aws::Pager.new(
|
1077
|
+
limit_key: "page_size",
|
1078
|
+
tokens: {
|
1079
|
+
"next_token" => "next_token"
|
1080
|
+
}
|
1081
|
+
)
|
1082
|
+
end)
|
1083
|
+
|
978
1084
|
api.add_operation(:list_email_identities, Seahorse::Model::Operation.new.tap do |o|
|
979
1085
|
o.name = "ListEmailIdentities"
|
980
1086
|
o.http_method = "GET"
|