aws-sdk-pinpointemail 1.35.0 → 1.37.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -59,20 +59,6 @@ module Aws::PinpointEmail
59
59
 
60
60
  # Represents the body of the email message.
61
61
  #
62
- # @note When making an API call, you may pass Body
63
- # data as a hash:
64
- #
65
- # {
66
- # text: {
67
- # data: "MessageData", # required
68
- # charset: "Charset",
69
- # },
70
- # html: {
71
- # data: "MessageData", # required
72
- # charset: "Charset",
73
- # },
74
- # }
75
- #
76
62
  # @!attribute [rw] text
77
63
  # An object that represents the version of the message that is
78
64
  # displayed in email clients that don't support HTML, or clients
@@ -98,19 +84,6 @@ module Aws::PinpointEmail
98
84
  # events. You can use Amazon CloudWatch to monitor and gain insights on
99
85
  # your email sending metrics.
100
86
  #
101
- # @note When making an API call, you may pass CloudWatchDestination
102
- # data as a hash:
103
- #
104
- # {
105
- # dimension_configurations: [ # required
106
- # {
107
- # dimension_name: "DimensionName", # required
108
- # dimension_value_source: "MESSAGE_TAG", # required, accepts MESSAGE_TAG, EMAIL_HEADER, LINK_TAG
109
- # default_dimension_value: "DefaultDimensionValue", # required
110
- # },
111
- # ],
112
- # }
113
- #
114
87
  # @!attribute [rw] dimension_configurations
115
88
  # An array of objects that define the dimensions to use when you send
116
89
  # email events to Amazon CloudWatch.
@@ -127,15 +100,6 @@ module Aws::PinpointEmail
127
100
  # An object that defines the dimension configuration to use when you
128
101
  # send Amazon Pinpoint email events to Amazon CloudWatch.
129
102
  #
130
- # @note When making an API call, you may pass CloudWatchDimensionConfiguration
131
- # data as a hash:
132
- #
133
- # {
134
- # dimension_name: "DimensionName", # required
135
- # dimension_value_source: "MESSAGE_TAG", # required, accepts MESSAGE_TAG, EMAIL_HEADER, LINK_TAG
136
- # default_dimension_value: "DefaultDimensionValue", # required
137
- # }
138
- #
139
103
  # @!attribute [rw] dimension_name
140
104
  # The name of an Amazon CloudWatch dimension associated with an email
141
105
  # sending metric. The name has to meet the following criteria:
@@ -186,14 +150,6 @@ module Aws::PinpointEmail
186
150
  # An object that represents the content of the email, and optionally a
187
151
  # character set specification.
188
152
  #
189
- # @note When making an API call, you may pass Content
190
- # data as a hash:
191
- #
192
- # {
193
- # data: "MessageData", # required
194
- # charset: "Charset",
195
- # }
196
- #
197
153
  # @!attribute [rw] data
198
154
  # The content of the message itself.
199
155
  # @return [String]
@@ -217,37 +173,6 @@ module Aws::PinpointEmail
217
173
 
218
174
  # A request to add an event destination to a configuration set.
219
175
  #
220
- # @note When making an API call, you may pass CreateConfigurationSetEventDestinationRequest
221
- # data as a hash:
222
- #
223
- # {
224
- # configuration_set_name: "ConfigurationSetName", # required
225
- # event_destination_name: "EventDestinationName", # required
226
- # event_destination: { # required
227
- # enabled: false,
228
- # matching_event_types: ["SEND"], # accepts SEND, REJECT, BOUNCE, COMPLAINT, DELIVERY, OPEN, CLICK, RENDERING_FAILURE
229
- # kinesis_firehose_destination: {
230
- # iam_role_arn: "AmazonResourceName", # required
231
- # delivery_stream_arn: "AmazonResourceName", # required
232
- # },
233
- # cloud_watch_destination: {
234
- # dimension_configurations: [ # required
235
- # {
236
- # dimension_name: "DimensionName", # required
237
- # dimension_value_source: "MESSAGE_TAG", # required, accepts MESSAGE_TAG, EMAIL_HEADER, LINK_TAG
238
- # default_dimension_value: "DefaultDimensionValue", # required
239
- # },
240
- # ],
241
- # },
242
- # sns_destination: {
243
- # topic_arn: "AmazonResourceName", # required
244
- # },
245
- # pinpoint_destination: {
246
- # application_arn: "AmazonResourceName",
247
- # },
248
- # },
249
- # }
250
- #
251
176
  # @!attribute [rw] configuration_set_name
252
177
  # The name of the configuration set that you want to add an event
253
178
  # destination to.
@@ -281,33 +206,6 @@ module Aws::PinpointEmail
281
206
 
282
207
  # A request to create a configuration set.
283
208
  #
284
- # @note When making an API call, you may pass CreateConfigurationSetRequest
285
- # data as a hash:
286
- #
287
- # {
288
- # configuration_set_name: "ConfigurationSetName", # required
289
- # tracking_options: {
290
- # custom_redirect_domain: "CustomRedirectDomain", # required
291
- # },
292
- # delivery_options: {
293
- # tls_policy: "REQUIRE", # accepts REQUIRE, OPTIONAL
294
- # sending_pool_name: "PoolName",
295
- # },
296
- # reputation_options: {
297
- # reputation_metrics_enabled: false,
298
- # last_fresh_start: Time.now,
299
- # },
300
- # sending_options: {
301
- # sending_enabled: false,
302
- # },
303
- # tags: [
304
- # {
305
- # key: "TagKey", # required
306
- # value: "TagValue", # required
307
- # },
308
- # ],
309
- # }
310
- #
311
209
  # @!attribute [rw] configuration_set_name
312
210
  # The name of the configuration set.
313
211
  # @return [String]
@@ -360,19 +258,6 @@ module Aws::PinpointEmail
360
258
 
361
259
  # A request to create a new dedicated IP pool.
362
260
  #
363
- # @note When making an API call, you may pass CreateDedicatedIpPoolRequest
364
- # data as a hash:
365
- #
366
- # {
367
- # pool_name: "PoolName", # required
368
- # tags: [
369
- # {
370
- # key: "TagKey", # required
371
- # value: "TagValue", # required
372
- # },
373
- # ],
374
- # }
375
- #
376
261
  # @!attribute [rw] pool_name
377
262
  # The name of the dedicated IP pool.
378
263
  # @return [String]
@@ -408,45 +293,6 @@ module Aws::PinpointEmail
408
293
  # is complete, and you can use the `GetDeliverabilityTestReport`
409
294
  # operation to view the results of the test.
410
295
  #
411
- # @note When making an API call, you may pass CreateDeliverabilityTestReportRequest
412
- # data as a hash:
413
- #
414
- # {
415
- # report_name: "ReportName",
416
- # from_email_address: "EmailAddress", # required
417
- # content: { # required
418
- # simple: {
419
- # subject: { # required
420
- # data: "MessageData", # required
421
- # charset: "Charset",
422
- # },
423
- # body: { # required
424
- # text: {
425
- # data: "MessageData", # required
426
- # charset: "Charset",
427
- # },
428
- # html: {
429
- # data: "MessageData", # required
430
- # charset: "Charset",
431
- # },
432
- # },
433
- # },
434
- # raw: {
435
- # data: "data", # required
436
- # },
437
- # template: {
438
- # template_arn: "TemplateArn",
439
- # template_data: "TemplateData",
440
- # },
441
- # },
442
- # tags: [
443
- # {
444
- # key: "TagKey", # required
445
- # value: "TagValue", # required
446
- # },
447
- # ],
448
- # }
449
- #
450
296
  # @!attribute [rw] report_name
451
297
  # A unique name that helps you to identify the predictive inbox
452
298
  # placement test when you retrieve the results.
@@ -506,19 +352,6 @@ module Aws::PinpointEmail
506
352
  # A request to begin the verification process for an email identity (an
507
353
  # email address or domain).
508
354
  #
509
- # @note When making an API call, you may pass CreateEmailIdentityRequest
510
- # data as a hash:
511
- #
512
- # {
513
- # email_identity: "Identity", # required
514
- # tags: [
515
- # {
516
- # key: "TagKey", # required
517
- # value: "TagValue", # required
518
- # },
519
- # ],
520
- # }
521
- #
522
355
  # @!attribute [rw] email_identity
523
356
  # The email address or domain that you want to verify.
524
357
  # @return [String]
@@ -647,14 +480,6 @@ module Aws::PinpointEmail
647
480
 
648
481
  # A request to delete an event destination from a configuration set.
649
482
  #
650
- # @note When making an API call, you may pass DeleteConfigurationSetEventDestinationRequest
651
- # data as a hash:
652
- #
653
- # {
654
- # configuration_set_name: "ConfigurationSetName", # required
655
- # event_destination_name: "EventDestinationName", # required
656
- # }
657
- #
658
483
  # @!attribute [rw] configuration_set_name
659
484
  # The name of the configuration set that contains the event
660
485
  # destination that you want to delete.
@@ -682,13 +507,6 @@ module Aws::PinpointEmail
682
507
 
683
508
  # A request to delete a configuration set.
684
509
  #
685
- # @note When making an API call, you may pass DeleteConfigurationSetRequest
686
- # data as a hash:
687
- #
688
- # {
689
- # configuration_set_name: "ConfigurationSetName", # required
690
- # }
691
- #
692
510
  # @!attribute [rw] configuration_set_name
693
511
  # The name of the configuration set that you want to delete.
694
512
  # @return [String]
@@ -710,13 +528,6 @@ module Aws::PinpointEmail
710
528
 
711
529
  # A request to delete a dedicated IP pool.
712
530
  #
713
- # @note When making an API call, you may pass DeleteDedicatedIpPoolRequest
714
- # data as a hash:
715
- #
716
- # {
717
- # pool_name: "PoolName", # required
718
- # }
719
- #
720
531
  # @!attribute [rw] pool_name
721
532
  # The name of the dedicated IP pool that you want to delete.
722
533
  # @return [String]
@@ -741,13 +552,6 @@ module Aws::PinpointEmail
741
552
  # from that identity. You can restore your ability to send email by
742
553
  # completing the verification process for the identity again.
743
554
  #
744
- # @note When making an API call, you may pass DeleteEmailIdentityRequest
745
- # data as a hash:
746
- #
747
- # {
748
- # email_identity: "Identity", # required
749
- # }
750
- #
751
555
  # @!attribute [rw] email_identity
752
556
  # The identity (that is, the email address or domain) that you want to
753
557
  # delete from your Amazon Pinpoint account.
@@ -819,14 +623,6 @@ module Aws::PinpointEmail
819
623
 
820
624
  # Used to associate a configuration set with a dedicated IP pool.
821
625
  #
822
- # @note When making an API call, you may pass DeliveryOptions
823
- # data as a hash:
824
- #
825
- # {
826
- # tls_policy: "REQUIRE", # accepts REQUIRE, OPTIONAL
827
- # sending_pool_name: "PoolName",
828
- # }
829
- #
830
626
  # @!attribute [rw] tls_policy
831
627
  # Specifies whether messages that use the configuration set are
832
628
  # required to use Transport Layer Security (TLS). If the value is
@@ -851,15 +647,6 @@ module Aws::PinpointEmail
851
647
 
852
648
  # An object that describes the recipients for an email.
853
649
  #
854
- # @note When making an API call, you may pass Destination
855
- # data as a hash:
856
- #
857
- # {
858
- # to_addresses: ["EmailAddress"],
859
- # cc_addresses: ["EmailAddress"],
860
- # bcc_addresses: ["EmailAddress"],
861
- # }
862
- #
863
650
  # @!attribute [rw] to_addresses
864
651
  # An array that contains the email addresses of the "To" recipients
865
652
  # for the email.
@@ -1049,18 +836,6 @@ module Aws::PinpointEmail
1049
836
  # access to reputation, inbox placement, and other metrics for the
1050
837
  # domain.
1051
838
  #
1052
- # @note When making an API call, you may pass DomainDeliverabilityTrackingOption
1053
- # data as a hash:
1054
- #
1055
- # {
1056
- # domain: "Domain",
1057
- # subscription_start_date: Time.now,
1058
- # inbox_placement_tracking_option: {
1059
- # global: false,
1060
- # tracked_isps: ["IspName"],
1061
- # },
1062
- # }
1063
- #
1064
839
  # @!attribute [rw] domain
1065
840
  # A verified domain that’s associated with your AWS account and
1066
841
  # currently has an active Deliverability dashboard subscription.
@@ -1137,35 +912,6 @@ module Aws::PinpointEmail
1137
912
  # which you specify a complete MIME-formatted message. Raw messages can
1138
913
  # include attachments and custom headers.
1139
914
  #
1140
- # @note When making an API call, you may pass EmailContent
1141
- # data as a hash:
1142
- #
1143
- # {
1144
- # simple: {
1145
- # subject: { # required
1146
- # data: "MessageData", # required
1147
- # charset: "Charset",
1148
- # },
1149
- # body: { # required
1150
- # text: {
1151
- # data: "MessageData", # required
1152
- # charset: "Charset",
1153
- # },
1154
- # html: {
1155
- # data: "MessageData", # required
1156
- # charset: "Charset",
1157
- # },
1158
- # },
1159
- # },
1160
- # raw: {
1161
- # data: "data", # required
1162
- # },
1163
- # template: {
1164
- # template_arn: "TemplateArn",
1165
- # template_data: "TemplateData",
1166
- # },
1167
- # }
1168
- #
1169
915
  # @!attribute [rw] simple
1170
916
  # The simple email message. The message consists of a subject and a
1171
917
  # message body.
@@ -1284,33 +1030,6 @@ module Aws::PinpointEmail
1284
1030
  # set that the event destination is associated with. Also defines the
1285
1031
  # types of events that are sent to the event destination.
1286
1032
  #
1287
- # @note When making an API call, you may pass EventDestinationDefinition
1288
- # data as a hash:
1289
- #
1290
- # {
1291
- # enabled: false,
1292
- # matching_event_types: ["SEND"], # accepts SEND, REJECT, BOUNCE, COMPLAINT, DELIVERY, OPEN, CLICK, RENDERING_FAILURE
1293
- # kinesis_firehose_destination: {
1294
- # iam_role_arn: "AmazonResourceName", # required
1295
- # delivery_stream_arn: "AmazonResourceName", # required
1296
- # },
1297
- # cloud_watch_destination: {
1298
- # dimension_configurations: [ # required
1299
- # {
1300
- # dimension_name: "DimensionName", # required
1301
- # dimension_value_source: "MESSAGE_TAG", # required, accepts MESSAGE_TAG, EMAIL_HEADER, LINK_TAG
1302
- # default_dimension_value: "DefaultDimensionValue", # required
1303
- # },
1304
- # ],
1305
- # },
1306
- # sns_destination: {
1307
- # topic_arn: "AmazonResourceName", # required
1308
- # },
1309
- # pinpoint_destination: {
1310
- # application_arn: "AmazonResourceName",
1311
- # },
1312
- # }
1313
- #
1314
1033
  # @!attribute [rw] enabled
1315
1034
  # If `true`, the event destination is enabled. When the event
1316
1035
  # destination is enabled, the specified event types are sent to the
@@ -1441,13 +1160,6 @@ module Aws::PinpointEmail
1441
1160
  # A request to retrieve a list of the blacklists that your dedicated IP
1442
1161
  # addresses appear on.
1443
1162
  #
1444
- # @note When making an API call, you may pass GetBlacklistReportsRequest
1445
- # data as a hash:
1446
- #
1447
- # {
1448
- # blacklist_item_names: ["BlacklistItemName"], # required
1449
- # }
1450
- #
1451
1163
  # @!attribute [rw] blacklist_item_names
1452
1164
  # A list of IP addresses that you want to retrieve blacklist
1453
1165
  # information about. You can only specify the dedicated IP addresses
@@ -1480,13 +1192,6 @@ module Aws::PinpointEmail
1480
1192
  # A request to obtain information about the event destinations for a
1481
1193
  # configuration set.
1482
1194
  #
1483
- # @note When making an API call, you may pass GetConfigurationSetEventDestinationsRequest
1484
- # data as a hash:
1485
- #
1486
- # {
1487
- # configuration_set_name: "ConfigurationSetName", # required
1488
- # }
1489
- #
1490
1195
  # @!attribute [rw] configuration_set_name
1491
1196
  # The name of the configuration set that contains the event
1492
1197
  # destination.
@@ -1517,13 +1222,6 @@ module Aws::PinpointEmail
1517
1222
 
1518
1223
  # A request to obtain information about a configuration set.
1519
1224
  #
1520
- # @note When making an API call, you may pass GetConfigurationSetRequest
1521
- # data as a hash:
1522
- #
1523
- # {
1524
- # configuration_set_name: "ConfigurationSetName", # required
1525
- # }
1526
- #
1527
1225
  # @!attribute [rw] configuration_set_name
1528
1226
  # The name of the configuration set that you want to obtain more
1529
1227
  # information about.
@@ -1584,13 +1282,6 @@ module Aws::PinpointEmail
1584
1282
 
1585
1283
  # A request to obtain more information about a dedicated IP address.
1586
1284
  #
1587
- # @note When making an API call, you may pass GetDedicatedIpRequest
1588
- # data as a hash:
1589
- #
1590
- # {
1591
- # ip: "Ip", # required
1592
- # }
1593
- #
1594
1285
  # @!attribute [rw] ip
1595
1286
  # The IP address that you want to obtain more information about. The
1596
1287
  # value you specify has to be a dedicated IP address that's
@@ -1621,15 +1312,6 @@ module Aws::PinpointEmail
1621
1312
 
1622
1313
  # A request to obtain more information about dedicated IP pools.
1623
1314
  #
1624
- # @note When making an API call, you may pass GetDedicatedIpsRequest
1625
- # data as a hash:
1626
- #
1627
- # {
1628
- # pool_name: "PoolName",
1629
- # next_token: "NextToken",
1630
- # page_size: 1,
1631
- # }
1632
- #
1633
1315
  # @!attribute [rw] pool_name
1634
1316
  # The name of the IP pool that the dedicated IP address is associated
1635
1317
  # with.
@@ -1758,13 +1440,6 @@ module Aws::PinpointEmail
1758
1440
  # A request to retrieve the results of a predictive inbox placement
1759
1441
  # test.
1760
1442
  #
1761
- # @note When making an API call, you may pass GetDeliverabilityTestReportRequest
1762
- # data as a hash:
1763
- #
1764
- # {
1765
- # report_id: "ReportId", # required
1766
- # }
1767
- #
1768
1443
  # @!attribute [rw] report_id
1769
1444
  # A unique string that identifies the predictive inbox placement test.
1770
1445
  # @return [String]
@@ -1823,13 +1498,6 @@ module Aws::PinpointEmail
1823
1498
  # using a domain that the Deliverability dashboard is enabled for
1824
1499
  # (`PutDeliverabilityDashboardOption` operation).
1825
1500
  #
1826
- # @note When making an API call, you may pass GetDomainDeliverabilityCampaignRequest
1827
- # data as a hash:
1828
- #
1829
- # {
1830
- # campaign_id: "CampaignId", # required
1831
- # }
1832
- #
1833
1501
  # @!attribute [rw] campaign_id
1834
1502
  # The unique identifier for the campaign. Amazon Pinpoint
1835
1503
  # automatically generates and assigns this identifier to a campaign.
@@ -1865,15 +1533,6 @@ module Aws::PinpointEmail
1865
1533
 
1866
1534
  # A request to obtain deliverability metrics for a domain.
1867
1535
  #
1868
- # @note When making an API call, you may pass GetDomainStatisticsReportRequest
1869
- # data as a hash:
1870
- #
1871
- # {
1872
- # domain: "Identity", # required
1873
- # start_date: Time.now, # required
1874
- # end_date: Time.now, # required
1875
- # }
1876
- #
1877
1536
  # @!attribute [rw] domain
1878
1537
  # The domain that you want to obtain deliverability metrics for.
1879
1538
  # @return [String]
@@ -1925,13 +1584,6 @@ module Aws::PinpointEmail
1925
1584
 
1926
1585
  # A request to return details about an email identity.
1927
1586
  #
1928
- # @note When making an API call, you may pass GetEmailIdentityRequest
1929
- # data as a hash:
1930
- #
1931
- # {
1932
- # email_identity: "Identity", # required
1933
- # }
1934
- #
1935
1587
  # @!attribute [rw] email_identity
1936
1588
  # The email identity that you want to retrieve details for.
1937
1589
  # @return [String]
@@ -2051,14 +1703,6 @@ module Aws::PinpointEmail
2051
1703
  # dashboard for the domain (`PutDeliverabilityDashboardOption`
2052
1704
  # operation).
2053
1705
  #
2054
- # @note When making an API call, you may pass InboxPlacementTrackingOption
2055
- # data as a hash:
2056
- #
2057
- # {
2058
- # global: false,
2059
- # tracked_isps: ["IspName"],
2060
- # }
2061
- #
2062
1706
  # @!attribute [rw] global
2063
1707
  # Specifies whether inbox placement data is being tracked for the
2064
1708
  # domain.
@@ -2104,14 +1748,6 @@ module Aws::PinpointEmail
2104
1748
  # email events. You can use Amazon Kinesis Data Firehose to stream data
2105
1749
  # to other services, such as Amazon S3 and Amazon Redshift.
2106
1750
  #
2107
- # @note When making an API call, you may pass KinesisFirehoseDestination
2108
- # data as a hash:
2109
- #
2110
- # {
2111
- # iam_role_arn: "AmazonResourceName", # required
2112
- # delivery_stream_arn: "AmazonResourceName", # required
2113
- # }
2114
- #
2115
1751
  # @!attribute [rw] iam_role_arn
2116
1752
  # The Amazon Resource Name (ARN) of the IAM role that Amazon Pinpoint
2117
1753
  # uses when sending email events to the Amazon Kinesis Data Firehose
@@ -2141,14 +1777,6 @@ module Aws::PinpointEmail
2141
1777
  # A request to obtain a list of configuration sets for your Amazon
2142
1778
  # Pinpoint account in the current AWS Region.
2143
1779
  #
2144
- # @note When making an API call, you may pass ListConfigurationSetsRequest
2145
- # data as a hash:
2146
- #
2147
- # {
2148
- # next_token: "NextToken",
2149
- # page_size: 1,
2150
- # }
2151
- #
2152
1780
  # @!attribute [rw] next_token
2153
1781
  # A token returned from a previous call to `ListConfigurationSets` to
2154
1782
  # indicate the position in the list of configuration sets.
@@ -2196,14 +1824,6 @@ module Aws::PinpointEmail
2196
1824
 
2197
1825
  # A request to obtain a list of dedicated IP pools.
2198
1826
  #
2199
- # @note When making an API call, you may pass ListDedicatedIpPoolsRequest
2200
- # data as a hash:
2201
- #
2202
- # {
2203
- # next_token: "NextToken",
2204
- # page_size: 1,
2205
- # }
2206
- #
2207
1827
  # @!attribute [rw] next_token
2208
1828
  # A token returned from a previous call to `ListDedicatedIpPools` to
2209
1829
  # indicate the position in the list of dedicated IP pools.
@@ -2251,14 +1871,6 @@ module Aws::PinpointEmail
2251
1871
  # A request to list all of the predictive inbox placement tests that
2252
1872
  # you've performed.
2253
1873
  #
2254
- # @note When making an API call, you may pass ListDeliverabilityTestReportsRequest
2255
- # data as a hash:
2256
- #
2257
- # {
2258
- # next_token: "NextToken",
2259
- # page_size: 1,
2260
- # }
2261
- #
2262
1874
  # @!attribute [rw] next_token
2263
1875
  # A token returned from a previous call to
2264
1876
  # `ListDeliverabilityTestReports` to indicate the position in the list
@@ -2317,17 +1929,6 @@ module Aws::PinpointEmail
2317
1929
  # dashboard (`PutDeliverabilityDashboardOption` operation) for the
2318
1930
  # domain.
2319
1931
  #
2320
- # @note When making an API call, you may pass ListDomainDeliverabilityCampaignsRequest
2321
- # data as a hash:
2322
- #
2323
- # {
2324
- # start_date: Time.now, # required
2325
- # end_date: Time.now, # required
2326
- # subscribed_domain: "Domain", # required
2327
- # next_token: "NextToken",
2328
- # page_size: 1,
2329
- # }
2330
- #
2331
1932
  # @!attribute [rw] start_date
2332
1933
  # The first day, in Unix time format, that you want to obtain
2333
1934
  # deliverability data for.
@@ -2400,14 +2001,6 @@ module Aws::PinpointEmail
2400
2001
  # already verified, identities that are unverified, and identities that
2401
2002
  # were verified in the past, but are no longer verified.
2402
2003
  #
2403
- # @note When making an API call, you may pass ListEmailIdentitiesRequest
2404
- # data as a hash:
2405
- #
2406
- # {
2407
- # next_token: "NextToken",
2408
- # page_size: 1,
2409
- # }
2410
- #
2411
2004
  # @!attribute [rw] next_token
2412
2005
  # A token returned from a previous call to `ListEmailIdentities` to
2413
2006
  # indicate the position in the list of identities.
@@ -2457,13 +2050,6 @@ module Aws::PinpointEmail
2457
2050
  include Aws::Structure
2458
2051
  end
2459
2052
 
2460
- # @note When making an API call, you may pass ListTagsForResourceRequest
2461
- # data as a hash:
2462
- #
2463
- # {
2464
- # resource_arn: "AmazonResourceName", # required
2465
- # }
2466
- #
2467
2053
  # @!attribute [rw] resource_arn
2468
2054
  # The Amazon Resource Name (ARN) of the resource that you want to
2469
2055
  # retrieve tag information for.
@@ -2548,26 +2134,6 @@ module Aws::PinpointEmail
2548
2134
  # Represents the email message that you're sending. The `Message`
2549
2135
  # object consists of a subject line and a message body.
2550
2136
  #
2551
- # @note When making an API call, you may pass Message
2552
- # data as a hash:
2553
- #
2554
- # {
2555
- # subject: { # required
2556
- # data: "MessageData", # required
2557
- # charset: "Charset",
2558
- # },
2559
- # body: { # required
2560
- # text: {
2561
- # data: "MessageData", # required
2562
- # charset: "Charset",
2563
- # },
2564
- # html: {
2565
- # data: "MessageData", # required
2566
- # charset: "Charset",
2567
- # },
2568
- # },
2569
- # }
2570
- #
2571
2137
  # @!attribute [rw] subject
2572
2138
  # The subject line of the email. The subject line can only contain
2573
2139
  # 7-bit ASCII characters. However, you can specify non-ASCII
@@ -2602,14 +2168,6 @@ module Aws::PinpointEmail
2602
2168
  # Contains the name and value of a tag that you apply to an email. You
2603
2169
  # can use message tags when you publish email sending events.
2604
2170
  #
2605
- # @note When making an API call, you may pass MessageTag
2606
- # data as a hash:
2607
- #
2608
- # {
2609
- # name: "MessageTagName", # required
2610
- # value: "MessageTagValue", # required
2611
- # }
2612
- #
2613
2171
  # @!attribute [rw] name
2614
2172
  # The name of the message tag. The message tag name has to meet the
2615
2173
  # following criteria:
@@ -2678,13 +2236,6 @@ module Aws::PinpointEmail
2678
2236
  # Pinpoint projects. You can use these attributes to create segments for
2679
2237
  # your campaigns.
2680
2238
  #
2681
- # @note When making an API call, you may pass PinpointDestination
2682
- # data as a hash:
2683
- #
2684
- # {
2685
- # application_arn: "AmazonResourceName",
2686
- # }
2687
- #
2688
2239
  # @!attribute [rw] application_arn
2689
2240
  # The Amazon Resource Name (ARN) of the Amazon Pinpoint project that
2690
2241
  # you want to send email events to.
@@ -2740,13 +2291,6 @@ module Aws::PinpointEmail
2740
2291
  # A request to enable or disable the automatic IP address warm-up
2741
2292
  # feature.
2742
2293
  #
2743
- # @note When making an API call, you may pass PutAccountDedicatedIpWarmupAttributesRequest
2744
- # data as a hash:
2745
- #
2746
- # {
2747
- # auto_warmup_enabled: false,
2748
- # }
2749
- #
2750
2294
  # @!attribute [rw] auto_warmup_enabled
2751
2295
  # Enables or disables the automatic warm-up feature for dedicated IP
2752
2296
  # addresses that are associated with your Amazon Pinpoint account in
@@ -2771,13 +2315,6 @@ module Aws::PinpointEmail
2771
2315
 
2772
2316
  # A request to change the ability of your account to send email.
2773
2317
  #
2774
- # @note When making an API call, you may pass PutAccountSendingAttributesRequest
2775
- # data as a hash:
2776
- #
2777
- # {
2778
- # sending_enabled: false,
2779
- # }
2780
- #
2781
2318
  # @!attribute [rw] sending_enabled
2782
2319
  # Enables or disables your account's ability to send email. Set to
2783
2320
  # `true` to enable email sending, or set to `false` to disable email
@@ -2806,15 +2343,6 @@ module Aws::PinpointEmail
2806
2343
 
2807
2344
  # A request to associate a configuration set with a dedicated IP pool.
2808
2345
  #
2809
- # @note When making an API call, you may pass PutConfigurationSetDeliveryOptionsRequest
2810
- # data as a hash:
2811
- #
2812
- # {
2813
- # configuration_set_name: "ConfigurationSetName", # required
2814
- # tls_policy: "REQUIRE", # accepts REQUIRE, OPTIONAL
2815
- # sending_pool_name: "SendingPoolName",
2816
- # }
2817
- #
2818
2346
  # @!attribute [rw] configuration_set_name
2819
2347
  # The name of the configuration set that you want to associate with a
2820
2348
  # dedicated IP pool.
@@ -2853,14 +2381,6 @@ module Aws::PinpointEmail
2853
2381
  # A request to enable or disable tracking of reputation metrics for a
2854
2382
  # configuration set.
2855
2383
  #
2856
- # @note When making an API call, you may pass PutConfigurationSetReputationOptionsRequest
2857
- # data as a hash:
2858
- #
2859
- # {
2860
- # configuration_set_name: "ConfigurationSetName", # required
2861
- # reputation_metrics_enabled: false,
2862
- # }
2863
- #
2864
2384
  # @!attribute [rw] configuration_set_name
2865
2385
  # The name of the configuration set that you want to enable or disable
2866
2386
  # reputation metric tracking for.
@@ -2891,14 +2411,6 @@ module Aws::PinpointEmail
2891
2411
  # A request to enable or disable the ability of Amazon Pinpoint to send
2892
2412
  # emails that use a specific configuration set.
2893
2413
  #
2894
- # @note When making an API call, you may pass PutConfigurationSetSendingOptionsRequest
2895
- # data as a hash:
2896
- #
2897
- # {
2898
- # configuration_set_name: "ConfigurationSetName", # required
2899
- # sending_enabled: false,
2900
- # }
2901
- #
2902
2414
  # @!attribute [rw] configuration_set_name
2903
2415
  # The name of the configuration set that you want to enable or disable
2904
2416
  # email sending for.
@@ -2928,14 +2440,6 @@ module Aws::PinpointEmail
2928
2440
  # A request to add a custom domain for tracking open and click events to
2929
2441
  # a configuration set.
2930
2442
  #
2931
- # @note When making an API call, you may pass PutConfigurationSetTrackingOptionsRequest
2932
- # data as a hash:
2933
- #
2934
- # {
2935
- # configuration_set_name: "ConfigurationSetName", # required
2936
- # custom_redirect_domain: "CustomRedirectDomain",
2937
- # }
2938
- #
2939
2443
  # @!attribute [rw] configuration_set_name
2940
2444
  # The name of the configuration set that you want to add a custom
2941
2445
  # tracking domain to.
@@ -2963,14 +2467,6 @@ module Aws::PinpointEmail
2963
2467
 
2964
2468
  # A request to move a dedicated IP address to a dedicated IP pool.
2965
2469
  #
2966
- # @note When making an API call, you may pass PutDedicatedIpInPoolRequest
2967
- # data as a hash:
2968
- #
2969
- # {
2970
- # ip: "Ip", # required
2971
- # destination_pool_name: "PoolName", # required
2972
- # }
2973
- #
2974
2470
  # @!attribute [rw] ip
2975
2471
  # The IP address that you want to move to the dedicated IP pool. The
2976
2472
  # value you specify has to be a dedicated IP address that's
@@ -3002,14 +2498,6 @@ module Aws::PinpointEmail
3002
2498
  # This operation is useful when you want to resume the warm-up process
3003
2499
  # for an existing IP address.
3004
2500
  #
3005
- # @note When making an API call, you may pass PutDedicatedIpWarmupAttributesRequest
3006
- # data as a hash:
3007
- #
3008
- # {
3009
- # ip: "Ip", # required
3010
- # warmup_percentage: 1, # required
3011
- # }
3012
- #
3013
2501
  # @!attribute [rw] ip
3014
2502
  # The dedicated IP address that you want to update the warm-up
3015
2503
  # attributes for.
@@ -3052,23 +2540,6 @@ module Aws::PinpointEmail
3052
2540
  #
3053
2541
  # [1]: http://aws.amazon.com/pinpoint/pricing/
3054
2542
  #
3055
- # @note When making an API call, you may pass PutDeliverabilityDashboardOptionRequest
3056
- # data as a hash:
3057
- #
3058
- # {
3059
- # dashboard_enabled: false, # required
3060
- # subscribed_domains: [
3061
- # {
3062
- # domain: "Domain",
3063
- # subscription_start_date: Time.now,
3064
- # inbox_placement_tracking_option: {
3065
- # global: false,
3066
- # tracked_isps: ["IspName"],
3067
- # },
3068
- # },
3069
- # ],
3070
- # }
3071
- #
3072
2543
  # @!attribute [rw] dashboard_enabled
3073
2544
  # Specifies whether to enable the Deliverability dashboard for your
3074
2545
  # Amazon Pinpoint account. To enable the dashboard, set this value to
@@ -3099,14 +2570,6 @@ module Aws::PinpointEmail
3099
2570
  # A request to enable or disable DKIM signing of email that you send
3100
2571
  # from an email identity.
3101
2572
  #
3102
- # @note When making an API call, you may pass PutEmailIdentityDkimAttributesRequest
3103
- # data as a hash:
3104
- #
3105
- # {
3106
- # email_identity: "Identity", # required
3107
- # signing_enabled: false,
3108
- # }
3109
- #
3110
2573
  # @!attribute [rw] email_identity
3111
2574
  # The email identity that you want to change the DKIM settings for.
3112
2575
  # @return [String]
@@ -3139,14 +2602,6 @@ module Aws::PinpointEmail
3139
2602
  # A request to set the attributes that control how bounce and complaint
3140
2603
  # events are processed.
3141
2604
  #
3142
- # @note When making an API call, you may pass PutEmailIdentityFeedbackAttributesRequest
3143
- # data as a hash:
3144
- #
3145
- # {
3146
- # email_identity: "Identity", # required
3147
- # email_forwarding_enabled: false,
3148
- # }
3149
- #
3150
2605
  # @!attribute [rw] email_identity
3151
2606
  # The email identity that you want to configure bounce and complaint
3152
2607
  # feedback forwarding for.
@@ -3188,15 +2643,6 @@ module Aws::PinpointEmail
3188
2643
  # A request to configure the custom MAIL FROM domain for a verified
3189
2644
  # identity.
3190
2645
  #
3191
- # @note When making an API call, you may pass PutEmailIdentityMailFromAttributesRequest
3192
- # data as a hash:
3193
- #
3194
- # {
3195
- # email_identity: "Identity", # required
3196
- # mail_from_domain: "MailFromDomainName",
3197
- # behavior_on_mx_failure: "USE_DEFAULT_VALUE", # accepts USE_DEFAULT_VALUE, REJECT_MESSAGE
3198
- # }
3199
- #
3200
2646
  # @!attribute [rw] email_identity
3201
2647
  # The verified email identity that you want to set up the custom MAIL
3202
2648
  # FROM domain for.
@@ -3246,13 +2692,6 @@ module Aws::PinpointEmail
3246
2692
 
3247
2693
  # The raw email message.
3248
2694
  #
3249
- # @note When making an API call, you may pass RawMessage
3250
- # data as a hash:
3251
- #
3252
- # {
3253
- # data: "data", # required
3254
- # }
3255
- #
3256
2695
  # @!attribute [rw] data
3257
2696
  # The raw email message. The message has to meet the following
3258
2697
  # criteria:
@@ -3293,14 +2732,6 @@ module Aws::PinpointEmail
3293
2732
  # Enable or disable collection of reputation metrics for emails that you
3294
2733
  # send using this configuration set in the current AWS Region.
3295
2734
  #
3296
- # @note When making an API call, you may pass ReputationOptions
3297
- # data as a hash:
3298
- #
3299
- # {
3300
- # reputation_metrics_enabled: false,
3301
- # last_fresh_start: Time.now,
3302
- # }
3303
- #
3304
2735
  # @!attribute [rw] reputation_metrics_enabled
3305
2736
  # If `true`, tracking of reputation metrics is enabled for the
3306
2737
  # configuration set. If `false`, tracking of reputation metrics is
@@ -3325,52 +2756,6 @@ module Aws::PinpointEmail
3325
2756
 
3326
2757
  # A request to send an email message.
3327
2758
  #
3328
- # @note When making an API call, you may pass SendEmailRequest
3329
- # data as a hash:
3330
- #
3331
- # {
3332
- # from_email_address: "EmailAddress",
3333
- # destination: { # required
3334
- # to_addresses: ["EmailAddress"],
3335
- # cc_addresses: ["EmailAddress"],
3336
- # bcc_addresses: ["EmailAddress"],
3337
- # },
3338
- # reply_to_addresses: ["EmailAddress"],
3339
- # feedback_forwarding_email_address: "EmailAddress",
3340
- # content: { # required
3341
- # simple: {
3342
- # subject: { # required
3343
- # data: "MessageData", # required
3344
- # charset: "Charset",
3345
- # },
3346
- # body: { # required
3347
- # text: {
3348
- # data: "MessageData", # required
3349
- # charset: "Charset",
3350
- # },
3351
- # html: {
3352
- # data: "MessageData", # required
3353
- # charset: "Charset",
3354
- # },
3355
- # },
3356
- # },
3357
- # raw: {
3358
- # data: "data", # required
3359
- # },
3360
- # template: {
3361
- # template_arn: "TemplateArn",
3362
- # template_data: "TemplateData",
3363
- # },
3364
- # },
3365
- # email_tags: [
3366
- # {
3367
- # name: "MessageTagName", # required
3368
- # value: "MessageTagValue", # required
3369
- # },
3370
- # ],
3371
- # configuration_set_name: "ConfigurationSetName",
3372
- # }
3373
- #
3374
2759
  # @!attribute [rw] from_email_address
3375
2760
  # The email address that you want to use as the "From" address for
3376
2761
  # the email. The address that you specify has to be verified.
@@ -3479,13 +2864,6 @@ module Aws::PinpointEmail
3479
2864
  # Used to enable or disable email sending for messages that use this
3480
2865
  # configuration set in the current AWS Region.
3481
2866
  #
3482
- # @note When making an API call, you may pass SendingOptions
3483
- # data as a hash:
3484
- #
3485
- # {
3486
- # sending_enabled: false,
3487
- # }
3488
- #
3489
2867
  # @!attribute [rw] sending_enabled
3490
2868
  # If `true`, email sending is enabled for the configuration set. If
3491
2869
  # `false`, email sending is disabled for the configuration set.
@@ -3510,13 +2888,6 @@ module Aws::PinpointEmail
3510
2888
  # can use Amazon SNS to send notification when certain email events
3511
2889
  # occur.
3512
2890
  #
3513
- # @note When making an API call, you may pass SnsDestination
3514
- # data as a hash:
3515
- #
3516
- # {
3517
- # topic_arn: "AmazonResourceName", # required
3518
- # }
3519
- #
3520
2891
  # @!attribute [rw] topic_arn
3521
2892
  # The Amazon Resource Name (ARN) of the Amazon SNS topic that you want
3522
2893
  # to publish email events to. For more information about Amazon SNS
@@ -3566,14 +2937,6 @@ module Aws::PinpointEmail
3566
2937
  # resources that are located in the specified AWS Region for your AWS
3567
2938
  # account.
3568
2939
  #
3569
- # @note When making an API call, you may pass Tag
3570
- # data as a hash:
3571
- #
3572
- # {
3573
- # key: "TagKey", # required
3574
- # value: "TagValue", # required
3575
- # }
3576
- #
3577
2940
  # @!attribute [rw] key
3578
2941
  # One part of a key-value pair that defines a tag. The maximum length
3579
2942
  # of a tag key is 128 characters. The minimum length is 1 character.
@@ -3596,19 +2959,6 @@ module Aws::PinpointEmail
3596
2959
  include Aws::Structure
3597
2960
  end
3598
2961
 
3599
- # @note When making an API call, you may pass TagResourceRequest
3600
- # data as a hash:
3601
- #
3602
- # {
3603
- # resource_arn: "AmazonResourceName", # required
3604
- # tags: [ # required
3605
- # {
3606
- # key: "TagKey", # required
3607
- # value: "TagValue", # required
3608
- # },
3609
- # ],
3610
- # }
3611
- #
3612
2962
  # @!attribute [rw] resource_arn
3613
2963
  # The Amazon Resource Name (ARN) of the resource that you want to add
3614
2964
  # one or more tags to.
@@ -3634,14 +2984,6 @@ module Aws::PinpointEmail
3634
2984
  #
3635
2985
  class TagResourceResponse < Aws::EmptyStructure; end
3636
2986
 
3637
- # @note When making an API call, you may pass Template
3638
- # data as a hash:
3639
- #
3640
- # {
3641
- # template_arn: "TemplateArn",
3642
- # template_data: "TemplateData",
3643
- # }
3644
- #
3645
2987
  # @!attribute [rw] template_arn
3646
2988
  # The Amazon Resource Name (ARN) of the template.
3647
2989
  # @return [String]
@@ -3678,13 +3020,6 @@ module Aws::PinpointEmail
3678
3020
  # You can optionally configure Amazon Pinpoint to use a domain that you
3679
3021
  # operate for these images and links.
3680
3022
  #
3681
- # @note When making an API call, you may pass TrackingOptions
3682
- # data as a hash:
3683
- #
3684
- # {
3685
- # custom_redirect_domain: "CustomRedirectDomain", # required
3686
- # }
3687
- #
3688
3023
  # @!attribute [rw] custom_redirect_domain
3689
3024
  # The domain that you want to use for tracking open and click events.
3690
3025
  # @return [String]
@@ -3697,14 +3032,6 @@ module Aws::PinpointEmail
3697
3032
  include Aws::Structure
3698
3033
  end
3699
3034
 
3700
- # @note When making an API call, you may pass UntagResourceRequest
3701
- # data as a hash:
3702
- #
3703
- # {
3704
- # resource_arn: "AmazonResourceName", # required
3705
- # tag_keys: ["TagKey"], # required
3706
- # }
3707
- #
3708
3035
  # @!attribute [rw] resource_arn
3709
3036
  # The Amazon Resource Name (ARN) of the resource that you want to
3710
3037
  # remove one or more tags from.
@@ -3737,37 +3064,6 @@ module Aws::PinpointEmail
3737
3064
  # A request to change the settings for an event destination for a
3738
3065
  # configuration set.
3739
3066
  #
3740
- # @note When making an API call, you may pass UpdateConfigurationSetEventDestinationRequest
3741
- # data as a hash:
3742
- #
3743
- # {
3744
- # configuration_set_name: "ConfigurationSetName", # required
3745
- # event_destination_name: "EventDestinationName", # required
3746
- # event_destination: { # required
3747
- # enabled: false,
3748
- # matching_event_types: ["SEND"], # accepts SEND, REJECT, BOUNCE, COMPLAINT, DELIVERY, OPEN, CLICK, RENDERING_FAILURE
3749
- # kinesis_firehose_destination: {
3750
- # iam_role_arn: "AmazonResourceName", # required
3751
- # delivery_stream_arn: "AmazonResourceName", # required
3752
- # },
3753
- # cloud_watch_destination: {
3754
- # dimension_configurations: [ # required
3755
- # {
3756
- # dimension_name: "DimensionName", # required
3757
- # dimension_value_source: "MESSAGE_TAG", # required, accepts MESSAGE_TAG, EMAIL_HEADER, LINK_TAG
3758
- # default_dimension_value: "DefaultDimensionValue", # required
3759
- # },
3760
- # ],
3761
- # },
3762
- # sns_destination: {
3763
- # topic_arn: "AmazonResourceName", # required
3764
- # },
3765
- # pinpoint_destination: {
3766
- # application_arn: "AmazonResourceName",
3767
- # },
3768
- # },
3769
- # }
3770
- #
3771
3067
  # @!attribute [rw] configuration_set_name
3772
3068
  # The name of the configuration set that contains the event
3773
3069
  # destination that you want to modify.