aws-sdk-sesv2 1.30.0 → 1.31.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.
@@ -80,20 +80,6 @@ module Aws::SESV2
80
80
 
81
81
  # Represents a single metric data query to include in a batch.
82
82
  #
83
- # @note When making an API call, you may pass BatchGetMetricDataQuery
84
- # data as a hash:
85
- #
86
- # {
87
- # id: "QueryIdentifier", # required
88
- # namespace: "VDM", # required, accepts VDM
89
- # metric: "SEND", # required, accepts SEND, COMPLAINT, PERMANENT_BOUNCE, TRANSIENT_BOUNCE, OPEN, CLICK, DELIVERY, DELIVERY_OPEN, DELIVERY_CLICK, DELIVERY_COMPLAINT
90
- # dimensions: {
91
- # "EMAIL_IDENTITY" => "MetricDimensionValue",
92
- # },
93
- # start_date: Time.now, # required
94
- # end_date: Time.now, # required
95
- # }
96
- #
97
83
  # @!attribute [rw] id
98
84
  # The query identifier.
99
85
  # @return [String]
@@ -180,24 +166,6 @@ module Aws::SESV2
180
166
 
181
167
  # Represents a request to retrieve a batch of metric data.
182
168
  #
183
- # @note When making an API call, you may pass BatchGetMetricDataRequest
184
- # data as a hash:
185
- #
186
- # {
187
- # queries: [ # required
188
- # {
189
- # id: "QueryIdentifier", # required
190
- # namespace: "VDM", # required, accepts VDM
191
- # metric: "SEND", # required, accepts SEND, COMPLAINT, PERMANENT_BOUNCE, TRANSIENT_BOUNCE, OPEN, CLICK, DELIVERY, DELIVERY_OPEN, DELIVERY_CLICK, DELIVERY_COMPLAINT
192
- # dimensions: {
193
- # "EMAIL_IDENTITY" => "MetricDimensionValue",
194
- # },
195
- # start_date: Time.now, # required
196
- # end_date: Time.now, # required
197
- # },
198
- # ],
199
- # }
200
- #
201
169
  # @!attribute [rw] queries
202
170
  # A list of queries for metrics to be retrieved.
203
171
  # @return [Array<Types::BatchGetMetricDataQuery>]
@@ -259,20 +227,6 @@ module Aws::SESV2
259
227
 
260
228
  # Represents the body of the email message.
261
229
  #
262
- # @note When making an API call, you may pass Body
263
- # data as a hash:
264
- #
265
- # {
266
- # text: {
267
- # data: "MessageData", # required
268
- # charset: "Charset",
269
- # },
270
- # html: {
271
- # data: "MessageData", # required
272
- # charset: "Charset",
273
- # },
274
- # }
275
- #
276
230
  # @!attribute [rw] text
277
231
  # An object that represents the version of the message that is
278
232
  # displayed in email clients that don't support HTML, or clients
@@ -297,17 +251,6 @@ module Aws::SESV2
297
251
  # An object that contains the body of the message. You can specify a
298
252
  # template message.
299
253
  #
300
- # @note When making an API call, you may pass BulkEmailContent
301
- # data as a hash:
302
- #
303
- # {
304
- # template: {
305
- # template_name: "EmailTemplateName",
306
- # template_arn: "AmazonResourceName",
307
- # template_data: "EmailTemplateData",
308
- # },
309
- # }
310
- #
311
254
  # @!attribute [rw] template
312
255
  # The template to use for the bulk email message.
313
256
  # @return [Types::Template]
@@ -320,28 +263,6 @@ module Aws::SESV2
320
263
  include Aws::Structure
321
264
  end
322
265
 
323
- # @note When making an API call, you may pass BulkEmailEntry
324
- # data as a hash:
325
- #
326
- # {
327
- # destination: { # required
328
- # to_addresses: ["EmailAddress"],
329
- # cc_addresses: ["EmailAddress"],
330
- # bcc_addresses: ["EmailAddress"],
331
- # },
332
- # replacement_tags: [
333
- # {
334
- # name: "MessageTagName", # required
335
- # value: "MessageTagValue", # required
336
- # },
337
- # ],
338
- # replacement_email_content: {
339
- # replacement_template: {
340
- # replacement_template_data: "EmailTemplateData",
341
- # },
342
- # },
343
- # }
344
- #
345
266
  # @!attribute [rw] destination
346
267
  # Represents the destination of the message, consisting of To:, CC:,
347
268
  # and BCC: fields.
@@ -468,19 +389,6 @@ module Aws::SESV2
468
389
  # events. You can use Amazon CloudWatch to monitor and gain insights on
469
390
  # your email sending metrics.
470
391
  #
471
- # @note When making an API call, you may pass CloudWatchDestination
472
- # data as a hash:
473
- #
474
- # {
475
- # dimension_configurations: [ # required
476
- # {
477
- # dimension_name: "DimensionName", # required
478
- # dimension_value_source: "MESSAGE_TAG", # required, accepts MESSAGE_TAG, EMAIL_HEADER, LINK_TAG
479
- # default_dimension_value: "DefaultDimensionValue", # required
480
- # },
481
- # ],
482
- # }
483
- #
484
392
  # @!attribute [rw] dimension_configurations
485
393
  # An array of objects that define the dimensions to use when you send
486
394
  # email events to Amazon CloudWatch.
@@ -497,15 +405,6 @@ module Aws::SESV2
497
405
  # An object that defines the dimension configuration to use when you
498
406
  # send email events to Amazon CloudWatch.
499
407
  #
500
- # @note When making an API call, you may pass CloudWatchDimensionConfiguration
501
- # data as a hash:
502
- #
503
- # {
504
- # dimension_name: "DimensionName", # required
505
- # dimension_value_source: "MESSAGE_TAG", # required, accepts MESSAGE_TAG, EMAIL_HEADER, LINK_TAG
506
- # default_dimension_value: "DefaultDimensionValue", # required
507
- # }
508
- #
509
408
  # @!attribute [rw] dimension_name
510
409
  # The name of an Amazon CloudWatch dimension associated with an email
511
410
  # sending metric. The name has to meet the following criteria:
@@ -617,14 +516,6 @@ module Aws::SESV2
617
516
 
618
517
  # An object that contains details about the action of a contact list.
619
518
  #
620
- # @note When making an API call, you may pass ContactListDestination
621
- # data as a hash:
622
- #
623
- # {
624
- # contact_list_name: "ContactListName", # required
625
- # contact_list_import_action: "DELETE", # required, accepts DELETE, PUT
626
- # }
627
- #
628
519
  # @!attribute [rw] contact_list_name
629
520
  # The name of the contact list.
630
521
  # @return [String]
@@ -651,14 +542,6 @@ module Aws::SESV2
651
542
  # An object that represents the content of the email, and optionally a
652
543
  # character set specification.
653
544
  #
654
- # @note When making an API call, you may pass Content
655
- # data as a hash:
656
- #
657
- # {
658
- # data: "MessageData", # required
659
- # charset: "Charset",
660
- # }
661
- #
662
545
  # @!attribute [rw] data
663
546
  # The content of the message itself.
664
547
  # @return [String]
@@ -682,37 +565,6 @@ module Aws::SESV2
682
565
 
683
566
  # A request to add an event destination to a configuration set.
684
567
  #
685
- # @note When making an API call, you may pass CreateConfigurationSetEventDestinationRequest
686
- # data as a hash:
687
- #
688
- # {
689
- # configuration_set_name: "ConfigurationSetName", # required
690
- # event_destination_name: "EventDestinationName", # required
691
- # event_destination: { # required
692
- # enabled: false,
693
- # matching_event_types: ["SEND"], # accepts SEND, REJECT, BOUNCE, COMPLAINT, DELIVERY, OPEN, CLICK, RENDERING_FAILURE, DELIVERY_DELAY, SUBSCRIPTION
694
- # kinesis_firehose_destination: {
695
- # iam_role_arn: "AmazonResourceName", # required
696
- # delivery_stream_arn: "AmazonResourceName", # required
697
- # },
698
- # cloud_watch_destination: {
699
- # dimension_configurations: [ # required
700
- # {
701
- # dimension_name: "DimensionName", # required
702
- # dimension_value_source: "MESSAGE_TAG", # required, accepts MESSAGE_TAG, EMAIL_HEADER, LINK_TAG
703
- # default_dimension_value: "DefaultDimensionValue", # required
704
- # },
705
- # ],
706
- # },
707
- # sns_destination: {
708
- # topic_arn: "AmazonResourceName", # required
709
- # },
710
- # pinpoint_destination: {
711
- # application_arn: "AmazonResourceName",
712
- # },
713
- # },
714
- # }
715
- #
716
568
  # @!attribute [rw] configuration_set_name
717
569
  # The name of the configuration set .
718
570
  # @return [String]
@@ -745,44 +597,6 @@ module Aws::SESV2
745
597
 
746
598
  # A request to create a configuration set.
747
599
  #
748
- # @note When making an API call, you may pass CreateConfigurationSetRequest
749
- # data as a hash:
750
- #
751
- # {
752
- # configuration_set_name: "ConfigurationSetName", # required
753
- # tracking_options: {
754
- # custom_redirect_domain: "CustomRedirectDomain", # required
755
- # },
756
- # delivery_options: {
757
- # tls_policy: "REQUIRE", # accepts REQUIRE, OPTIONAL
758
- # sending_pool_name: "PoolName",
759
- # },
760
- # reputation_options: {
761
- # reputation_metrics_enabled: false,
762
- # last_fresh_start: Time.now,
763
- # },
764
- # sending_options: {
765
- # sending_enabled: false,
766
- # },
767
- # tags: [
768
- # {
769
- # key: "TagKey", # required
770
- # value: "TagValue", # required
771
- # },
772
- # ],
773
- # suppression_options: {
774
- # suppressed_reasons: ["BOUNCE"], # accepts BOUNCE, COMPLAINT
775
- # },
776
- # vdm_options: {
777
- # dashboard_options: {
778
- # engagement_metrics: "ENABLED", # accepts ENABLED, DISABLED
779
- # },
780
- # guardian_options: {
781
- # optimized_shared_delivery: "ENABLED", # accepts ENABLED, DISABLED
782
- # },
783
- # },
784
- # }
785
- #
786
600
  # @!attribute [rw] configuration_set_name
787
601
  # The name of the configuration set. The name can contain up to 64
788
602
  # alphanumeric characters, including letters, numbers, hyphens (-) and
@@ -846,28 +660,6 @@ module Aws::SESV2
846
660
  #
847
661
  class CreateConfigurationSetResponse < Aws::EmptyStructure; end
848
662
 
849
- # @note When making an API call, you may pass CreateContactListRequest
850
- # data as a hash:
851
- #
852
- # {
853
- # contact_list_name: "ContactListName", # required
854
- # topics: [
855
- # {
856
- # topic_name: "TopicName", # required
857
- # display_name: "DisplayName", # required
858
- # description: "Description",
859
- # default_subscription_status: "OPT_IN", # required, accepts OPT_IN, OPT_OUT
860
- # },
861
- # ],
862
- # description: "Description",
863
- # tags: [
864
- # {
865
- # key: "TagKey", # required
866
- # value: "TagValue", # required
867
- # },
868
- # ],
869
- # }
870
- #
871
663
  # @!attribute [rw] contact_list_name
872
664
  # The name of the contact list.
873
665
  # @return [String]
@@ -900,22 +692,6 @@ module Aws::SESV2
900
692
  #
901
693
  class CreateContactListResponse < Aws::EmptyStructure; end
902
694
 
903
- # @note When making an API call, you may pass CreateContactRequest
904
- # data as a hash:
905
- #
906
- # {
907
- # contact_list_name: "ContactListName", # required
908
- # email_address: "EmailAddress", # required
909
- # topic_preferences: [
910
- # {
911
- # topic_name: "TopicName", # required
912
- # subscription_status: "OPT_IN", # required, accepts OPT_IN, OPT_OUT
913
- # },
914
- # ],
915
- # unsubscribe_all: false,
916
- # attributes_data: "AttributesData",
917
- # }
918
- #
919
695
  # @!attribute [rw] contact_list_name
920
696
  # The name of the contact list to which the contact should be added.
921
697
  # @return [String]
@@ -956,18 +732,6 @@ module Aws::SESV2
956
732
 
957
733
  # Represents a request to create a custom verification email template.
958
734
  #
959
- # @note When making an API call, you may pass CreateCustomVerificationEmailTemplateRequest
960
- # data as a hash:
961
- #
962
- # {
963
- # template_name: "EmailTemplateName", # required
964
- # from_email_address: "EmailAddress", # required
965
- # template_subject: "EmailTemplateSubject", # required
966
- # template_content: "TemplateContent", # required
967
- # success_redirection_url: "SuccessRedirectionURL", # required
968
- # failure_redirection_url: "FailureRedirectionURL", # required
969
- # }
970
- #
971
735
  # @!attribute [rw] template_name
972
736
  # The name of the custom verification email template.
973
737
  # @return [String]
@@ -1024,20 +788,6 @@ module Aws::SESV2
1024
788
 
1025
789
  # A request to create a new dedicated IP pool.
1026
790
  #
1027
- # @note When making an API call, you may pass CreateDedicatedIpPoolRequest
1028
- # data as a hash:
1029
- #
1030
- # {
1031
- # pool_name: "PoolName", # required
1032
- # tags: [
1033
- # {
1034
- # key: "TagKey", # required
1035
- # value: "TagValue", # required
1036
- # },
1037
- # ],
1038
- # scaling_mode: "STANDARD", # accepts STANDARD, MANAGED
1039
- # }
1040
- #
1041
791
  # @!attribute [rw] pool_name
1042
792
  # The name of the dedicated IP pool.
1043
793
  # @return [String]
@@ -1079,46 +829,6 @@ module Aws::SESV2
1079
829
  # `GetDeliverabilityTestReport` operation to view the results of the
1080
830
  # test.
1081
831
  #
1082
- # @note When making an API call, you may pass CreateDeliverabilityTestReportRequest
1083
- # data as a hash:
1084
- #
1085
- # {
1086
- # report_name: "ReportName",
1087
- # from_email_address: "EmailAddress", # required
1088
- # content: { # required
1089
- # simple: {
1090
- # subject: { # required
1091
- # data: "MessageData", # required
1092
- # charset: "Charset",
1093
- # },
1094
- # body: { # required
1095
- # text: {
1096
- # data: "MessageData", # required
1097
- # charset: "Charset",
1098
- # },
1099
- # html: {
1100
- # data: "MessageData", # required
1101
- # charset: "Charset",
1102
- # },
1103
- # },
1104
- # },
1105
- # raw: {
1106
- # data: "data", # required
1107
- # },
1108
- # template: {
1109
- # template_name: "EmailTemplateName",
1110
- # template_arn: "AmazonResourceName",
1111
- # template_data: "EmailTemplateData",
1112
- # },
1113
- # },
1114
- # tags: [
1115
- # {
1116
- # key: "TagKey", # required
1117
- # value: "TagValue", # required
1118
- # },
1119
- # ],
1120
- # }
1121
- #
1122
832
  # @!attribute [rw] report_name
1123
833
  # A unique name that helps you to identify the predictive inbox
1124
834
  # placement test when you retrieve the results.
@@ -1184,15 +894,6 @@ module Aws::SESV2
1184
894
  #
1185
895
  # [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization-identity-owner-tasks-management.html
1186
896
  #
1187
- # @note When making an API call, you may pass CreateEmailIdentityPolicyRequest
1188
- # data as a hash:
1189
- #
1190
- # {
1191
- # email_identity: "Identity", # required
1192
- # policy_name: "PolicyName", # required
1193
- # policy: "Policy", # required
1194
- # }
1195
- #
1196
897
  # @!attribute [rw] email_identity
1197
898
  # The email identity.
1198
899
  # @return [String]
@@ -1236,25 +937,6 @@ module Aws::SESV2
1236
937
  # A request to begin the verification process for an email identity (an
1237
938
  # email address or domain).
1238
939
  #
1239
- # @note When making an API call, you may pass CreateEmailIdentityRequest
1240
- # data as a hash:
1241
- #
1242
- # {
1243
- # email_identity: "Identity", # required
1244
- # tags: [
1245
- # {
1246
- # key: "TagKey", # required
1247
- # value: "TagValue", # required
1248
- # },
1249
- # ],
1250
- # dkim_signing_attributes: {
1251
- # domain_signing_selector: "Selector",
1252
- # domain_signing_private_key: "PrivateKey",
1253
- # next_signing_key_length: "RSA_1024_BIT", # accepts RSA_1024_BIT, RSA_2048_BIT
1254
- # },
1255
- # configuration_set_name: "ConfigurationSetName",
1256
- # }
1257
- #
1258
940
  # @!attribute [rw] email_identity
1259
941
  # The email address or domain to verify.
1260
942
  # @return [String]
@@ -1337,18 +1019,6 @@ module Aws::SESV2
1337
1019
  #
1338
1020
  # [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-personalized-email-api.html
1339
1021
  #
1340
- # @note When making an API call, you may pass CreateEmailTemplateRequest
1341
- # data as a hash:
1342
- #
1343
- # {
1344
- # template_name: "EmailTemplateName", # required
1345
- # template_content: { # required
1346
- # subject: "EmailTemplateSubject",
1347
- # text: "EmailTemplateText",
1348
- # html: "EmailTemplateHtml",
1349
- # },
1350
- # }
1351
- #
1352
1022
  # @!attribute [rw] template_name
1353
1023
  # The name of the template.
1354
1024
  # @return [String]
@@ -1377,25 +1047,6 @@ module Aws::SESV2
1377
1047
  # Represents a request to create an import job from a data source for a
1378
1048
  # data destination.
1379
1049
  #
1380
- # @note When making an API call, you may pass CreateImportJobRequest
1381
- # data as a hash:
1382
- #
1383
- # {
1384
- # import_destination: { # required
1385
- # suppression_list_destination: {
1386
- # suppression_list_import_action: "DELETE", # required, accepts DELETE, PUT
1387
- # },
1388
- # contact_list_destination: {
1389
- # contact_list_name: "ContactListName", # required
1390
- # contact_list_import_action: "DELETE", # required, accepts DELETE, PUT
1391
- # },
1392
- # },
1393
- # import_data_source: { # required
1394
- # s3_url: "S3Url", # required
1395
- # data_format: "CSV", # required, accepts CSV, JSON
1396
- # },
1397
- # }
1398
- #
1399
1050
  # @!attribute [rw] import_destination
1400
1051
  # The destination for the import job.
1401
1052
  # @return [Types::ImportDestination]
@@ -1495,13 +1146,6 @@ module Aws::SESV2
1495
1146
  # An object containing additional settings for your VDM configuration as
1496
1147
  # applicable to the Dashboard.
1497
1148
  #
1498
- # @note When making an API call, you may pass DashboardAttributes
1499
- # data as a hash:
1500
- #
1501
- # {
1502
- # engagement_metrics: "ENABLED", # accepts ENABLED, DISABLED
1503
- # }
1504
- #
1505
1149
  # @!attribute [rw] engagement_metrics
1506
1150
  # Specifies the status of your VDM engagement metrics collection. Can
1507
1151
  # be one of the following:
@@ -1524,13 +1168,6 @@ module Aws::SESV2
1524
1168
  # An object containing additional settings for your VDM configuration as
1525
1169
  # applicable to the Dashboard.
1526
1170
  #
1527
- # @note When making an API call, you may pass DashboardOptions
1528
- # data as a hash:
1529
- #
1530
- # {
1531
- # engagement_metrics: "ENABLED", # accepts ENABLED, DISABLED
1532
- # }
1533
- #
1534
1171
  # @!attribute [rw] engagement_metrics
1535
1172
  # Specifies the status of your VDM engagement metrics collection. Can
1536
1173
  # be one of the following:
@@ -1625,14 +1262,6 @@ module Aws::SESV2
1625
1262
 
1626
1263
  # A request to delete an event destination from a configuration set.
1627
1264
  #
1628
- # @note When making an API call, you may pass DeleteConfigurationSetEventDestinationRequest
1629
- # data as a hash:
1630
- #
1631
- # {
1632
- # configuration_set_name: "ConfigurationSetName", # required
1633
- # event_destination_name: "EventDestinationName", # required
1634
- # }
1635
- #
1636
1265
  # @!attribute [rw] configuration_set_name
1637
1266
  # The name of the configuration set that contains the event
1638
1267
  # destination to delete.
@@ -1660,13 +1289,6 @@ module Aws::SESV2
1660
1289
 
1661
1290
  # A request to delete a configuration set.
1662
1291
  #
1663
- # @note When making an API call, you may pass DeleteConfigurationSetRequest
1664
- # data as a hash:
1665
- #
1666
- # {
1667
- # configuration_set_name: "ConfigurationSetName", # required
1668
- # }
1669
- #
1670
1292
  # @!attribute [rw] configuration_set_name
1671
1293
  # The name of the configuration set.
1672
1294
  # @return [String]
@@ -1686,13 +1308,6 @@ module Aws::SESV2
1686
1308
  #
1687
1309
  class DeleteConfigurationSetResponse < Aws::EmptyStructure; end
1688
1310
 
1689
- # @note When making an API call, you may pass DeleteContactListRequest
1690
- # data as a hash:
1691
- #
1692
- # {
1693
- # contact_list_name: "ContactListName", # required
1694
- # }
1695
- #
1696
1311
  # @!attribute [rw] contact_list_name
1697
1312
  # The name of the contact list.
1698
1313
  # @return [String]
@@ -1709,14 +1324,6 @@ module Aws::SESV2
1709
1324
  #
1710
1325
  class DeleteContactListResponse < Aws::EmptyStructure; end
1711
1326
 
1712
- # @note When making an API call, you may pass DeleteContactRequest
1713
- # data as a hash:
1714
- #
1715
- # {
1716
- # contact_list_name: "ContactListName", # required
1717
- # email_address: "EmailAddress", # required
1718
- # }
1719
- #
1720
1327
  # @!attribute [rw] contact_list_name
1721
1328
  # The name of the contact list from which the contact should be
1722
1329
  # removed.
@@ -1742,13 +1349,6 @@ module Aws::SESV2
1742
1349
  # Represents a request to delete an existing custom verification email
1743
1350
  # template.
1744
1351
  #
1745
- # @note When making an API call, you may pass DeleteCustomVerificationEmailTemplateRequest
1746
- # data as a hash:
1747
- #
1748
- # {
1749
- # template_name: "EmailTemplateName", # required
1750
- # }
1751
- #
1752
1352
  # @!attribute [rw] template_name
1753
1353
  # The name of the custom verification email template that you want to
1754
1354
  # delete.
@@ -1771,13 +1371,6 @@ module Aws::SESV2
1771
1371
 
1772
1372
  # A request to delete a dedicated IP pool.
1773
1373
  #
1774
- # @note When making an API call, you may pass DeleteDedicatedIpPoolRequest
1775
- # data as a hash:
1776
- #
1777
- # {
1778
- # pool_name: "PoolName", # required
1779
- # }
1780
- #
1781
1374
  # @!attribute [rw] pool_name
1782
1375
  # The name of the dedicated IP pool that you want to delete.
1783
1376
  # @return [String]
@@ -1806,14 +1399,6 @@ module Aws::SESV2
1806
1399
  #
1807
1400
  # [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization-identity-owner-tasks-management.html
1808
1401
  #
1809
- # @note When making an API call, you may pass DeleteEmailIdentityPolicyRequest
1810
- # data as a hash:
1811
- #
1812
- # {
1813
- # email_identity: "Identity", # required
1814
- # policy_name: "PolicyName", # required
1815
- # }
1816
- #
1817
1402
  # @!attribute [rw] email_identity
1818
1403
  # The email identity.
1819
1404
  # @return [String]
@@ -1846,13 +1431,6 @@ module Aws::SESV2
1846
1431
  # can restore your ability to send email by completing the verification
1847
1432
  # process for the identity again.
1848
1433
  #
1849
- # @note When making an API call, you may pass DeleteEmailIdentityRequest
1850
- # data as a hash:
1851
- #
1852
- # {
1853
- # email_identity: "Identity", # required
1854
- # }
1855
- #
1856
1434
  # @!attribute [rw] email_identity
1857
1435
  # The identity (that is, the email address or domain) to delete.
1858
1436
  # @return [String]
@@ -1879,13 +1457,6 @@ module Aws::SESV2
1879
1457
  #
1880
1458
  # [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-personalized-email-api.html
1881
1459
  #
1882
- # @note When making an API call, you may pass DeleteEmailTemplateRequest
1883
- # data as a hash:
1884
- #
1885
- # {
1886
- # template_name: "EmailTemplateName", # required
1887
- # }
1888
- #
1889
1460
  # @!attribute [rw] template_name
1890
1461
  # The name of the template to be deleted.
1891
1462
  # @return [String]
@@ -1908,13 +1479,6 @@ module Aws::SESV2
1908
1479
  # A request to remove an email address from the suppression list for
1909
1480
  # your account.
1910
1481
  #
1911
- # @note When making an API call, you may pass DeleteSuppressedDestinationRequest
1912
- # data as a hash:
1913
- #
1914
- # {
1915
- # email_address: "EmailAddress", # required
1916
- # }
1917
- #
1918
1482
  # @!attribute [rw] email_address
1919
1483
  # The suppressed email destination to remove from the account
1920
1484
  # suppression list.
@@ -1986,14 +1550,6 @@ module Aws::SESV2
1986
1550
 
1987
1551
  # Used to associate a configuration set with a dedicated IP pool.
1988
1552
  #
1989
- # @note When making an API call, you may pass DeliveryOptions
1990
- # data as a hash:
1991
- #
1992
- # {
1993
- # tls_policy: "REQUIRE", # accepts REQUIRE, OPTIONAL
1994
- # sending_pool_name: "PoolName",
1995
- # }
1996
- #
1997
1553
  # @!attribute [rw] tls_policy
1998
1554
  # Specifies whether messages that use the configuration set are
1999
1555
  # required to use Transport Layer Security (TLS). If the value is
@@ -2033,15 +1589,6 @@ module Aws::SESV2
2033
1589
  # [2]: https://en.wikipedia.org/wiki/Email_address#Local-part
2034
1590
  # [3]: https://tools.ietf.org/html/rfc3492.html
2035
1591
  #
2036
- # @note When making an API call, you may pass Destination
2037
- # data as a hash:
2038
- #
2039
- # {
2040
- # to_addresses: ["EmailAddress"],
2041
- # cc_addresses: ["EmailAddress"],
2042
- # bcc_addresses: ["EmailAddress"],
2043
- # }
2044
- #
2045
1592
  # @!attribute [rw] to_addresses
2046
1593
  # An array that contains the email addresses of the "To" recipients
2047
1594
  # for the email.
@@ -2179,15 +1726,6 @@ module Aws::SESV2
2179
1726
  # An object that contains configuration for Bring Your Own DKIM
2180
1727
  # (BYODKIM), or, for Easy DKIM
2181
1728
  #
2182
- # @note When making an API call, you may pass DkimSigningAttributes
2183
- # data as a hash:
2184
- #
2185
- # {
2186
- # domain_signing_selector: "Selector",
2187
- # domain_signing_private_key: "PrivateKey",
2188
- # next_signing_key_length: "RSA_1024_BIT", # accepts RSA_1024_BIT, RSA_2048_BIT
2189
- # }
2190
- #
2191
1729
  # @!attribute [rw] domain_signing_selector
2192
1730
  # \[Bring Your Own DKIM\] A string that's used to identify a public
2193
1731
  # key in the DNS configuration for a domain.
@@ -2322,18 +1860,6 @@ module Aws::SESV2
2322
1860
  # access to reputation, inbox placement, and other metrics for the
2323
1861
  # domain.
2324
1862
  #
2325
- # @note When making an API call, you may pass DomainDeliverabilityTrackingOption
2326
- # data as a hash:
2327
- #
2328
- # {
2329
- # domain: "Domain",
2330
- # subscription_start_date: Time.now,
2331
- # inbox_placement_tracking_option: {
2332
- # global: false,
2333
- # tracked_isps: ["IspName"],
2334
- # },
2335
- # }
2336
- #
2337
1863
  # @!attribute [rw] domain
2338
1864
  # A verified domain that’s associated with your Amazon Web Services
2339
1865
  # account and currently has an active Deliverability dashboard
@@ -2411,36 +1937,6 @@ module Aws::SESV2
2411
1937
  # which you specify a complete MIME-formatted message. Raw messages can
2412
1938
  # include attachments and custom headers.
2413
1939
  #
2414
- # @note When making an API call, you may pass EmailContent
2415
- # data as a hash:
2416
- #
2417
- # {
2418
- # simple: {
2419
- # subject: { # required
2420
- # data: "MessageData", # required
2421
- # charset: "Charset",
2422
- # },
2423
- # body: { # required
2424
- # text: {
2425
- # data: "MessageData", # required
2426
- # charset: "Charset",
2427
- # },
2428
- # html: {
2429
- # data: "MessageData", # required
2430
- # charset: "Charset",
2431
- # },
2432
- # },
2433
- # },
2434
- # raw: {
2435
- # data: "data", # required
2436
- # },
2437
- # template: {
2438
- # template_name: "EmailTemplateName",
2439
- # template_arn: "AmazonResourceName",
2440
- # template_data: "EmailTemplateData",
2441
- # },
2442
- # }
2443
- #
2444
1940
  # @!attribute [rw] simple
2445
1941
  # The simple email message. The message consists of a subject and a
2446
1942
  # message body.
@@ -2492,15 +1988,6 @@ module Aws::SESV2
2492
1988
  # The content of the email, composed of a subject line, an HTML part,
2493
1989
  # and a text-only part.
2494
1990
  #
2495
- # @note When making an API call, you may pass EmailTemplateContent
2496
- # data as a hash:
2497
- #
2498
- # {
2499
- # subject: "EmailTemplateSubject",
2500
- # text: "EmailTemplateText",
2501
- # html: "EmailTemplateHtml",
2502
- # }
2503
- #
2504
1991
  # @!attribute [rw] subject
2505
1992
  # The subject line of the email.
2506
1993
  # @return [String]
@@ -2620,33 +2107,6 @@ module Aws::SESV2
2620
2107
  # set that the event destination is associated with. Also defines the
2621
2108
  # types of events that are sent to the event destination.
2622
2109
  #
2623
- # @note When making an API call, you may pass EventDestinationDefinition
2624
- # data as a hash:
2625
- #
2626
- # {
2627
- # enabled: false,
2628
- # matching_event_types: ["SEND"], # accepts SEND, REJECT, BOUNCE, COMPLAINT, DELIVERY, OPEN, CLICK, RENDERING_FAILURE, DELIVERY_DELAY, SUBSCRIPTION
2629
- # kinesis_firehose_destination: {
2630
- # iam_role_arn: "AmazonResourceName", # required
2631
- # delivery_stream_arn: "AmazonResourceName", # required
2632
- # },
2633
- # cloud_watch_destination: {
2634
- # dimension_configurations: [ # required
2635
- # {
2636
- # dimension_name: "DimensionName", # required
2637
- # dimension_value_source: "MESSAGE_TAG", # required, accepts MESSAGE_TAG, EMAIL_HEADER, LINK_TAG
2638
- # default_dimension_value: "DefaultDimensionValue", # required
2639
- # },
2640
- # ],
2641
- # },
2642
- # sns_destination: {
2643
- # topic_arn: "AmazonResourceName", # required
2644
- # },
2645
- # pinpoint_destination: {
2646
- # application_arn: "AmazonResourceName",
2647
- # },
2648
- # }
2649
- #
2650
2110
  # @!attribute [rw] enabled
2651
2111
  # If `true`, the event destination is enabled. When the event
2652
2112
  # destination is enabled, the specified event types are sent to the
@@ -2820,13 +2280,6 @@ module Aws::SESV2
2820
2280
  # A request to retrieve a list of the blacklists that your dedicated IP
2821
2281
  # addresses appear on.
2822
2282
  #
2823
- # @note When making an API call, you may pass GetBlacklistReportsRequest
2824
- # data as a hash:
2825
- #
2826
- # {
2827
- # blacklist_item_names: ["BlacklistItemName"], # required
2828
- # }
2829
- #
2830
2283
  # @!attribute [rw] blacklist_item_names
2831
2284
  # A list of IP addresses that you want to retrieve blacklist
2832
2285
  # information about. You can only specify the dedicated IP addresses
@@ -2859,13 +2312,6 @@ module Aws::SESV2
2859
2312
  # A request to obtain information about the event destinations for a
2860
2313
  # configuration set.
2861
2314
  #
2862
- # @note When making an API call, you may pass GetConfigurationSetEventDestinationsRequest
2863
- # data as a hash:
2864
- #
2865
- # {
2866
- # configuration_set_name: "ConfigurationSetName", # required
2867
- # }
2868
- #
2869
2315
  # @!attribute [rw] configuration_set_name
2870
2316
  # The name of the configuration set that contains the event
2871
2317
  # destination.
@@ -2896,13 +2342,6 @@ module Aws::SESV2
2896
2342
 
2897
2343
  # A request to obtain information about a configuration set.
2898
2344
  #
2899
- # @note When making an API call, you may pass GetConfigurationSetRequest
2900
- # data as a hash:
2901
- #
2902
- # {
2903
- # configuration_set_name: "ConfigurationSetName", # required
2904
- # }
2905
- #
2906
2345
  # @!attribute [rw] configuration_set_name
2907
2346
  # The name of the configuration set.
2908
2347
  # @return [String]
@@ -2971,13 +2410,6 @@ module Aws::SESV2
2971
2410
  include Aws::Structure
2972
2411
  end
2973
2412
 
2974
- # @note When making an API call, you may pass GetContactListRequest
2975
- # data as a hash:
2976
- #
2977
- # {
2978
- # contact_list_name: "ContactListName", # required
2979
- # }
2980
- #
2981
2413
  # @!attribute [rw] contact_list_name
2982
2414
  # The name of the contact list.
2983
2415
  # @return [String]
@@ -3028,14 +2460,6 @@ module Aws::SESV2
3028
2460
  include Aws::Structure
3029
2461
  end
3030
2462
 
3031
- # @note When making an API call, you may pass GetContactRequest
3032
- # data as a hash:
3033
- #
3034
- # {
3035
- # contact_list_name: "ContactListName", # required
3036
- # email_address: "EmailAddress", # required
3037
- # }
3038
- #
3039
2463
  # @!attribute [rw] contact_list_name
3040
2464
  # The name of the contact list to which the contact belongs.
3041
2465
  # @return [String]
@@ -3106,13 +2530,6 @@ module Aws::SESV2
3106
2530
  # Represents a request to retrieve an existing custom verification email
3107
2531
  # template.
3108
2532
  #
3109
- # @note When making an API call, you may pass GetCustomVerificationEmailTemplateRequest
3110
- # data as a hash:
3111
- #
3112
- # {
3113
- # template_name: "EmailTemplateName", # required
3114
- # }
3115
- #
3116
2533
  # @!attribute [rw] template_name
3117
2534
  # The name of the custom verification email template that you want to
3118
2535
  # retrieve.
@@ -3169,13 +2586,6 @@ module Aws::SESV2
3169
2586
 
3170
2587
  # A request to obtain more information about a dedicated IP pool.
3171
2588
  #
3172
- # @note When making an API call, you may pass GetDedicatedIpPoolRequest
3173
- # data as a hash:
3174
- #
3175
- # {
3176
- # pool_name: "PoolName", # required
3177
- # }
3178
- #
3179
2589
  # @!attribute [rw] pool_name
3180
2590
  # The name of the dedicated IP pool to retrieve.
3181
2591
  # @return [String]
@@ -3204,13 +2614,6 @@ module Aws::SESV2
3204
2614
 
3205
2615
  # A request to obtain more information about a dedicated IP address.
3206
2616
  #
3207
- # @note When making an API call, you may pass GetDedicatedIpRequest
3208
- # data as a hash:
3209
- #
3210
- # {
3211
- # ip: "Ip", # required
3212
- # }
3213
- #
3214
2617
  # @!attribute [rw] ip
3215
2618
  # The IP address that you want to obtain more information about. The
3216
2619
  # value you specify has to be a dedicated IP address that's
@@ -3241,15 +2644,6 @@ module Aws::SESV2
3241
2644
 
3242
2645
  # A request to obtain more information about dedicated IP pools.
3243
2646
  #
3244
- # @note When making an API call, you may pass GetDedicatedIpsRequest
3245
- # data as a hash:
3246
- #
3247
- # {
3248
- # pool_name: "PoolName",
3249
- # next_token: "NextToken",
3250
- # page_size: 1,
3251
- # }
3252
- #
3253
2647
  # @!attribute [rw] pool_name
3254
2648
  # The name of the IP pool that the dedicated IP address is associated
3255
2649
  # with.
@@ -3375,13 +2769,6 @@ module Aws::SESV2
3375
2769
  # A request to retrieve the results of a predictive inbox placement
3376
2770
  # test.
3377
2771
  #
3378
- # @note When making an API call, you may pass GetDeliverabilityTestReportRequest
3379
- # data as a hash:
3380
- #
3381
- # {
3382
- # report_id: "ReportId", # required
3383
- # }
3384
- #
3385
2772
  # @!attribute [rw] report_id
3386
2773
  # A unique string that identifies the predictive inbox placement test.
3387
2774
  # @return [String]
@@ -3440,13 +2827,6 @@ module Aws::SESV2
3440
2827
  # using a domain that the Deliverability dashboard is enabled for
3441
2828
  # (`PutDeliverabilityDashboardOption` operation).
3442
2829
  #
3443
- # @note When making an API call, you may pass GetDomainDeliverabilityCampaignRequest
3444
- # data as a hash:
3445
- #
3446
- # {
3447
- # campaign_id: "CampaignId", # required
3448
- # }
3449
- #
3450
2830
  # @!attribute [rw] campaign_id
3451
2831
  # The unique identifier for the campaign. The Deliverability dashboard
3452
2832
  # automatically generates and assigns this identifier to a campaign.
@@ -3479,15 +2859,6 @@ module Aws::SESV2
3479
2859
 
3480
2860
  # A request to obtain deliverability metrics for a domain.
3481
2861
  #
3482
- # @note When making an API call, you may pass GetDomainStatisticsReportRequest
3483
- # data as a hash:
3484
- #
3485
- # {
3486
- # domain: "Identity", # required
3487
- # start_date: Time.now, # required
3488
- # end_date: Time.now, # required
3489
- # }
3490
- #
3491
2862
  # @!attribute [rw] domain
3492
2863
  # The domain that you want to obtain deliverability metrics for.
3493
2864
  # @return [String]
@@ -3539,13 +2910,6 @@ module Aws::SESV2
3539
2910
 
3540
2911
  # A request to return the policies of an email identity.
3541
2912
  #
3542
- # @note When making an API call, you may pass GetEmailIdentityPoliciesRequest
3543
- # data as a hash:
3544
- #
3545
- # {
3546
- # email_identity: "Identity", # required
3547
- # }
3548
- #
3549
2913
  # @!attribute [rw] email_identity
3550
2914
  # The email identity.
3551
2915
  # @return [String]
@@ -3574,13 +2938,6 @@ module Aws::SESV2
3574
2938
 
3575
2939
  # A request to return details about an email identity.
3576
2940
  #
3577
- # @note When making an API call, you may pass GetEmailIdentityRequest
3578
- # data as a hash:
3579
- #
3580
- # {
3581
- # email_identity: "Identity", # required
3582
- # }
3583
- #
3584
2941
  # @!attribute [rw] email_identity
3585
2942
  # The email identity.
3586
2943
  # @return [String]
@@ -3687,13 +3044,6 @@ module Aws::SESV2
3687
3044
  # the subject line, HTML part and text part) for the template you
3688
3045
  # specify.
3689
3046
  #
3690
- # @note When making an API call, you may pass GetEmailTemplateRequest
3691
- # data as a hash:
3692
- #
3693
- # {
3694
- # template_name: "EmailTemplateName", # required
3695
- # }
3696
- #
3697
3047
  # @!attribute [rw] template_name
3698
3048
  # The name of the template.
3699
3049
  # @return [String]
@@ -3729,13 +3079,6 @@ module Aws::SESV2
3729
3079
  # Represents a request for information about an import job using the
3730
3080
  # import job ID.
3731
3081
  #
3732
- # @note When making an API call, you may pass GetImportJobRequest
3733
- # data as a hash:
3734
- #
3735
- # {
3736
- # job_id: "JobId", # required
3737
- # }
3738
- #
3739
3082
  # @!attribute [rw] job_id
3740
3083
  # The ID of the import job.
3741
3084
  # @return [String]
@@ -3807,13 +3150,6 @@ module Aws::SESV2
3807
3150
  # A request to retrieve information about an email address that's on
3808
3151
  # the suppression list for your account.
3809
3152
  #
3810
- # @note When making an API call, you may pass GetSuppressedDestinationRequest
3811
- # data as a hash:
3812
- #
3813
- # {
3814
- # email_address: "EmailAddress", # required
3815
- # }
3816
- #
3817
3153
  # @!attribute [rw] email_address
3818
3154
  # The email address that's on the account suppression list.
3819
3155
  # @return [String]
@@ -3843,13 +3179,6 @@ module Aws::SESV2
3843
3179
  # An object containing additional settings for your VDM configuration as
3844
3180
  # applicable to the Guardian.
3845
3181
  #
3846
- # @note When making an API call, you may pass GuardianAttributes
3847
- # data as a hash:
3848
- #
3849
- # {
3850
- # optimized_shared_delivery: "ENABLED", # accepts ENABLED, DISABLED
3851
- # }
3852
- #
3853
3182
  # @!attribute [rw] optimized_shared_delivery
3854
3183
  # Specifies the status of your VDM optimized shared delivery. Can be
3855
3184
  # one of the following:
@@ -3872,13 +3201,6 @@ module Aws::SESV2
3872
3201
  # An object containing additional settings for your VDM configuration as
3873
3202
  # applicable to the Guardian.
3874
3203
  #
3875
- # @note When making an API call, you may pass GuardianOptions
3876
- # data as a hash:
3877
- #
3878
- # {
3879
- # optimized_shared_delivery: "ENABLED", # accepts ENABLED, DISABLED
3880
- # }
3881
- #
3882
3204
  # @!attribute [rw] optimized_shared_delivery
3883
3205
  # Specifies the status of your VDM optimized shared delivery. Can be
3884
3206
  # one of the following:
@@ -3950,14 +3272,6 @@ module Aws::SESV2
3950
3272
  # An object that contains details about the data source of the import
3951
3273
  # job.
3952
3274
  #
3953
- # @note When making an API call, you may pass ImportDataSource
3954
- # data as a hash:
3955
- #
3956
- # {
3957
- # s3_url: "S3Url", # required
3958
- # data_format: "CSV", # required, accepts CSV, JSON
3959
- # }
3960
- #
3961
3275
  # @!attribute [rw] s3_url
3962
3276
  # An Amazon S3 URL in the format
3963
3277
  # s3://*&lt;bucket\_name&gt;*/*&lt;object&gt;*.
@@ -3979,19 +3293,6 @@ module Aws::SESV2
3979
3293
  # An object that contains details about the resource destination the
3980
3294
  # import job is going to target.
3981
3295
  #
3982
- # @note When making an API call, you may pass ImportDestination
3983
- # data as a hash:
3984
- #
3985
- # {
3986
- # suppression_list_destination: {
3987
- # suppression_list_import_action: "DELETE", # required, accepts DELETE, PUT
3988
- # },
3989
- # contact_list_destination: {
3990
- # contact_list_name: "ContactListName", # required
3991
- # contact_list_import_action: "DELETE", # required, accepts DELETE, PUT
3992
- # },
3993
- # }
3994
- #
3995
3296
  # @!attribute [rw] suppression_list_destination
3996
3297
  # An object that contains the action of the import job towards
3997
3298
  # suppression list.
@@ -4057,14 +3358,6 @@ module Aws::SESV2
4057
3358
  # Services account. This data is available only if you enabled the
4058
3359
  # Deliverability dashboard for the domain.
4059
3360
  #
4060
- # @note When making an API call, you may pass InboxPlacementTrackingOption
4061
- # data as a hash:
4062
- #
4063
- # {
4064
- # global: false,
4065
- # tracked_isps: ["IspName"],
4066
- # }
4067
- #
4068
3361
  # @!attribute [rw] global
4069
3362
  # Specifies whether inbox placement data is being tracked for the
4070
3363
  # domain.
@@ -4123,14 +3416,6 @@ module Aws::SESV2
4123
3416
  # email events. You can use Amazon Kinesis Data Firehose to stream data
4124
3417
  # to other services, such as Amazon S3 and Amazon Redshift.
4125
3418
  #
4126
- # @note When making an API call, you may pass KinesisFirehoseDestination
4127
- # data as a hash:
4128
- #
4129
- # {
4130
- # iam_role_arn: "AmazonResourceName", # required
4131
- # delivery_stream_arn: "AmazonResourceName", # required
4132
- # }
4133
- #
4134
3419
  # @!attribute [rw] iam_role_arn
4135
3420
  # The Amazon Resource Name (ARN) of the IAM role that the Amazon SES
4136
3421
  # API v2 uses to send email events to the Amazon Kinesis Data Firehose
@@ -4160,14 +3445,6 @@ module Aws::SESV2
4160
3445
  # A request to obtain a list of configuration sets for your Amazon SES
4161
3446
  # account in the current Amazon Web Services Region.
4162
3447
  #
4163
- # @note When making an API call, you may pass ListConfigurationSetsRequest
4164
- # data as a hash:
4165
- #
4166
- # {
4167
- # next_token: "NextToken",
4168
- # page_size: 1,
4169
- # }
4170
- #
4171
3448
  # @!attribute [rw] next_token
4172
3449
  # A token returned from a previous call to `ListConfigurationSets` to
4173
3450
  # indicate the position in the list of configuration sets.
@@ -4213,14 +3490,6 @@ module Aws::SESV2
4213
3490
  include Aws::Structure
4214
3491
  end
4215
3492
 
4216
- # @note When making an API call, you may pass ListContactListsRequest
4217
- # data as a hash:
4218
- #
4219
- # {
4220
- # page_size: 1,
4221
- # next_token: "NextToken",
4222
- # }
4223
- #
4224
3493
  # @!attribute [rw] page_size
4225
3494
  # Maximum number of contact lists to return at once. Use this
4226
3495
  # parameter to paginate results. If additional contact lists exist
@@ -4267,17 +3536,6 @@ module Aws::SESV2
4267
3536
 
4268
3537
  # A filter that can be applied to a list of contacts.
4269
3538
  #
4270
- # @note When making an API call, you may pass ListContactsFilter
4271
- # data as a hash:
4272
- #
4273
- # {
4274
- # filtered_status: "OPT_IN", # accepts OPT_IN, OPT_OUT
4275
- # topic_filter: {
4276
- # topic_name: "TopicName",
4277
- # use_default_if_preference_unavailable: false,
4278
- # },
4279
- # }
4280
- #
4281
3539
  # @!attribute [rw] filtered_status
4282
3540
  # The status by which you are filtering: `OPT_IN` or `OPT_OUT`.
4283
3541
  # @return [String]
@@ -4295,22 +3553,6 @@ module Aws::SESV2
4295
3553
  include Aws::Structure
4296
3554
  end
4297
3555
 
4298
- # @note When making an API call, you may pass ListContactsRequest
4299
- # data as a hash:
4300
- #
4301
- # {
4302
- # contact_list_name: "ContactListName", # required
4303
- # filter: {
4304
- # filtered_status: "OPT_IN", # accepts OPT_IN, OPT_OUT
4305
- # topic_filter: {
4306
- # topic_name: "TopicName",
4307
- # use_default_if_preference_unavailable: false,
4308
- # },
4309
- # },
4310
- # page_size: 1,
4311
- # next_token: "NextToken",
4312
- # }
4313
- #
4314
3556
  # @!attribute [rw] contact_list_name
4315
3557
  # The name of the contact list.
4316
3558
  # @return [String]
@@ -4369,14 +3611,6 @@ module Aws::SESV2
4369
3611
  # Represents a request to list the existing custom verification email
4370
3612
  # templates for your account.
4371
3613
  #
4372
- # @note When making an API call, you may pass ListCustomVerificationEmailTemplatesRequest
4373
- # data as a hash:
4374
- #
4375
- # {
4376
- # next_token: "NextToken",
4377
- # page_size: 1,
4378
- # }
4379
- #
4380
3614
  # @!attribute [rw] next_token
4381
3615
  # A token returned from a previous call to
4382
3616
  # `ListCustomVerificationEmailTemplates` to indicate the position in
@@ -4428,14 +3662,6 @@ module Aws::SESV2
4428
3662
 
4429
3663
  # A request to obtain a list of dedicated IP pools.
4430
3664
  #
4431
- # @note When making an API call, you may pass ListDedicatedIpPoolsRequest
4432
- # data as a hash:
4433
- #
4434
- # {
4435
- # next_token: "NextToken",
4436
- # page_size: 1,
4437
- # }
4438
- #
4439
3665
  # @!attribute [rw] next_token
4440
3666
  # A token returned from a previous call to `ListDedicatedIpPools` to
4441
3667
  # indicate the position in the list of dedicated IP pools.
@@ -4483,14 +3709,6 @@ module Aws::SESV2
4483
3709
  # A request to list all of the predictive inbox placement tests that
4484
3710
  # you've performed.
4485
3711
  #
4486
- # @note When making an API call, you may pass ListDeliverabilityTestReportsRequest
4487
- # data as a hash:
4488
- #
4489
- # {
4490
- # next_token: "NextToken",
4491
- # page_size: 1,
4492
- # }
4493
- #
4494
3712
  # @!attribute [rw] next_token
4495
3713
  # A token returned from a previous call to
4496
3714
  # `ListDeliverabilityTestReports` to indicate the position in the list
@@ -4548,17 +3766,6 @@ module Aws::SESV2
4548
3766
  # is available for a domain only if you enabled the Deliverability
4549
3767
  # dashboard.
4550
3768
  #
4551
- # @note When making an API call, you may pass ListDomainDeliverabilityCampaignsRequest
4552
- # data as a hash:
4553
- #
4554
- # {
4555
- # start_date: Time.now, # required
4556
- # end_date: Time.now, # required
4557
- # subscribed_domain: "Domain", # required
4558
- # next_token: "NextToken",
4559
- # page_size: 1,
4560
- # }
4561
- #
4562
3769
  # @!attribute [rw] start_date
4563
3770
  # The first day that you want to obtain deliverability data for.
4564
3771
  # @return [Time]
@@ -4629,14 +3836,6 @@ module Aws::SESV2
4629
3836
  # you've already verified, identities that are unverified, and
4630
3837
  # identities that were verified in the past, but are no longer verified.
4631
3838
  #
4632
- # @note When making an API call, you may pass ListEmailIdentitiesRequest
4633
- # data as a hash:
4634
- #
4635
- # {
4636
- # next_token: "NextToken",
4637
- # page_size: 1,
4638
- # }
4639
- #
4640
3839
  # @!attribute [rw] next_token
4641
3840
  # A token returned from a previous call to `ListEmailIdentities` to
4642
3841
  # indicate the position in the list of identities.
@@ -4694,14 +3893,6 @@ module Aws::SESV2
4694
3893
  #
4695
3894
  # [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-personalized-email-api.html
4696
3895
  #
4697
- # @note When making an API call, you may pass ListEmailTemplatesRequest
4698
- # data as a hash:
4699
- #
4700
- # {
4701
- # next_token: "NextToken",
4702
- # page_size: 1,
4703
- # }
4704
- #
4705
3896
  # @!attribute [rw] next_token
4706
3897
  # A token returned from a previous call to `ListEmailTemplates` to
4707
3898
  # indicate the position in the list of email templates.
@@ -4751,15 +3942,6 @@ module Aws::SESV2
4751
3942
  # Represents a request to list all of the import jobs for a data
4752
3943
  # destination within the specified maximum number of import jobs.
4753
3944
  #
4754
- # @note When making an API call, you may pass ListImportJobsRequest
4755
- # data as a hash:
4756
- #
4757
- # {
4758
- # import_destination_type: "SUPPRESSION_LIST", # accepts SUPPRESSION_LIST, CONTACT_LIST
4759
- # next_token: "NextToken",
4760
- # page_size: 1,
4761
- # }
4762
- #
4763
3945
  # @!attribute [rw] import_destination_type
4764
3946
  # The destination of the import job, which can be used to list import
4765
3947
  # jobs that have a certain `ImportDestinationType`.
@@ -4816,14 +3998,6 @@ module Aws::SESV2
4816
3998
  # An object used to specify a list or topic to which an email belongs,
4817
3999
  # which will be used when a contact chooses to unsubscribe.
4818
4000
  #
4819
- # @note When making an API call, you may pass ListManagementOptions
4820
- # data as a hash:
4821
- #
4822
- # {
4823
- # contact_list_name: "ContactListName", # required
4824
- # topic_name: "TopicName",
4825
- # }
4826
- #
4827
4001
  # @!attribute [rw] contact_list_name
4828
4002
  # The name of the contact list.
4829
4003
  # @return [String]
@@ -4844,17 +4018,6 @@ module Aws::SESV2
4844
4018
  # Represents a request to list the existing recommendations for your
4845
4019
  # account.
4846
4020
  #
4847
- # @note When making an API call, you may pass ListRecommendationsRequest
4848
- # data as a hash:
4849
- #
4850
- # {
4851
- # filter: {
4852
- # "TYPE" => "ListRecommendationFilterValue",
4853
- # },
4854
- # next_token: "NextToken",
4855
- # page_size: 1,
4856
- # }
4857
- #
4858
4021
  # @!attribute [rw] filter
4859
4022
  # Filters applied when retrieving recommendations. Can eiter be an
4860
4023
  # individual filter, or combinations of `STATUS` and `IMPACT` or
@@ -4913,17 +4076,6 @@ module Aws::SESV2
4913
4076
  # A request to obtain a list of email destinations that are on the
4914
4077
  # suppression list for your account.
4915
4078
  #
4916
- # @note When making an API call, you may pass ListSuppressedDestinationsRequest
4917
- # data as a hash:
4918
- #
4919
- # {
4920
- # reasons: ["BOUNCE"], # accepts BOUNCE, COMPLAINT
4921
- # start_date: Time.now,
4922
- # end_date: Time.now,
4923
- # next_token: "NextToken",
4924
- # page_size: 1,
4925
- # }
4926
- #
4927
4079
  # @!attribute [rw] reasons
4928
4080
  # The factors that caused the email address to be added to .
4929
4081
  # @return [Array<String>]
@@ -4989,13 +4141,6 @@ module Aws::SESV2
4989
4141
  include Aws::Structure
4990
4142
  end
4991
4143
 
4992
- # @note When making an API call, you may pass ListTagsForResourceRequest
4993
- # data as a hash:
4994
- #
4995
- # {
4996
- # resource_arn: "AmazonResourceName", # required
4997
- # }
4998
- #
4999
4144
  # @!attribute [rw] resource_arn
5000
4145
  # The Amazon Resource Name (ARN) of the resource that you want to
5001
4146
  # retrieve tag information for.
@@ -5079,26 +4224,6 @@ module Aws::SESV2
5079
4224
  # Represents the email message that you're sending. The `Message`
5080
4225
  # object consists of a subject line and a message body.
5081
4226
  #
5082
- # @note When making an API call, you may pass Message
5083
- # data as a hash:
5084
- #
5085
- # {
5086
- # subject: { # required
5087
- # data: "MessageData", # required
5088
- # charset: "Charset",
5089
- # },
5090
- # body: { # required
5091
- # text: {
5092
- # data: "MessageData", # required
5093
- # charset: "Charset",
5094
- # },
5095
- # html: {
5096
- # data: "MessageData", # required
5097
- # charset: "Charset",
5098
- # },
5099
- # },
5100
- # }
5101
- #
5102
4227
  # @!attribute [rw] subject
5103
4228
  # The subject line of the email. The subject line can only contain
5104
4229
  # 7-bit ASCII characters. However, you can specify non-ASCII
@@ -5133,14 +4258,6 @@ module Aws::SESV2
5133
4258
  # Contains the name and value of a tag that you apply to an email. You
5134
4259
  # can use message tags when you publish email sending events.
5135
4260
  #
5136
- # @note When making an API call, you may pass MessageTag
5137
- # data as a hash:
5138
- #
5139
- # {
5140
- # name: "MessageTagName", # required
5141
- # value: "MessageTagValue", # required
5142
- # }
5143
- #
5144
4261
  # @!attribute [rw] name
5145
4262
  # The name of the message tag. The message tag name has to meet the
5146
4263
  # following criteria:
@@ -5270,13 +4387,6 @@ module Aws::SESV2
5270
4387
  #
5271
4388
  # [1]: https://docs.aws.amazon.com/pinpoint/latest/userguide/analytics-transactional-messages.html
5272
4389
  #
5273
- # @note When making an API call, you may pass PinpointDestination
5274
- # data as a hash:
5275
- #
5276
- # {
5277
- # application_arn: "AmazonResourceName",
5278
- # }
5279
- #
5280
4390
  # @!attribute [rw] application_arn
5281
4391
  # The Amazon Resource Name (ARN) of the Amazon Pinpoint project to
5282
4392
  # send email events to.
@@ -5332,13 +4442,6 @@ module Aws::SESV2
5332
4442
  # A request to enable or disable the automatic IP address warm-up
5333
4443
  # feature.
5334
4444
  #
5335
- # @note When making an API call, you may pass PutAccountDedicatedIpWarmupAttributesRequest
5336
- # data as a hash:
5337
- #
5338
- # {
5339
- # auto_warmup_enabled: false,
5340
- # }
5341
- #
5342
4445
  # @!attribute [rw] auto_warmup_enabled
5343
4446
  # Enables or disables the automatic warm-up feature for dedicated IP
5344
4447
  # addresses that are associated with your Amazon SES account in the
@@ -5363,18 +4466,6 @@ module Aws::SESV2
5363
4466
 
5364
4467
  # A request to submit new account details.
5365
4468
  #
5366
- # @note When making an API call, you may pass PutAccountDetailsRequest
5367
- # data as a hash:
5368
- #
5369
- # {
5370
- # mail_type: "MARKETING", # required, accepts MARKETING, TRANSACTIONAL
5371
- # website_url: "WebsiteURL", # required
5372
- # contact_language: "EN", # accepts EN, JA
5373
- # use_case_description: "UseCaseDescription", # required
5374
- # additional_contact_email_addresses: ["AdditionalContactEmailAddress"],
5375
- # production_access_enabled: false,
5376
- # }
5377
- #
5378
4469
  # @!attribute [rw] mail_type
5379
4470
  # The type of email your account will send.
5380
4471
  # @return [String]
@@ -5436,13 +4527,6 @@ module Aws::SESV2
5436
4527
 
5437
4528
  # A request to change the ability of your account to send email.
5438
4529
  #
5439
- # @note When making an API call, you may pass PutAccountSendingAttributesRequest
5440
- # data as a hash:
5441
- #
5442
- # {
5443
- # sending_enabled: false,
5444
- # }
5445
- #
5446
4530
  # @!attribute [rw] sending_enabled
5447
4531
  # Enables or disables your account's ability to send email. Set to
5448
4532
  # `true` to enable email sending, or set to `false` to disable email
@@ -5472,13 +4556,6 @@ module Aws::SESV2
5472
4556
 
5473
4557
  # A request to change your account's suppression preferences.
5474
4558
  #
5475
- # @note When making an API call, you may pass PutAccountSuppressionAttributesRequest
5476
- # data as a hash:
5477
- #
5478
- # {
5479
- # suppressed_reasons: ["BOUNCE"], # accepts BOUNCE, COMPLAINT
5480
- # }
5481
- #
5482
4559
  # @!attribute [rw] suppressed_reasons
5483
4560
  # A list that contains the reasons that email addresses will be
5484
4561
  # automatically added to the suppression list for your account. This
@@ -5510,21 +4587,6 @@ module Aws::SESV2
5510
4587
 
5511
4588
  # A request to submit new account VDM attributes.
5512
4589
  #
5513
- # @note When making an API call, you may pass PutAccountVdmAttributesRequest
5514
- # data as a hash:
5515
- #
5516
- # {
5517
- # vdm_attributes: { # required
5518
- # vdm_enabled: "ENABLED", # required, accepts ENABLED, DISABLED
5519
- # dashboard_attributes: {
5520
- # engagement_metrics: "ENABLED", # accepts ENABLED, DISABLED
5521
- # },
5522
- # guardian_attributes: {
5523
- # optimized_shared_delivery: "ENABLED", # accepts ENABLED, DISABLED
5524
- # },
5525
- # },
5526
- # }
5527
- #
5528
4590
  # @!attribute [rw] vdm_attributes
5529
4591
  # The VDM attributes that you wish to apply to your Amazon SES
5530
4592
  # account.
@@ -5544,15 +4606,6 @@ module Aws::SESV2
5544
4606
 
5545
4607
  # A request to associate a configuration set with a dedicated IP pool.
5546
4608
  #
5547
- # @note When making an API call, you may pass PutConfigurationSetDeliveryOptionsRequest
5548
- # data as a hash:
5549
- #
5550
- # {
5551
- # configuration_set_name: "ConfigurationSetName", # required
5552
- # tls_policy: "REQUIRE", # accepts REQUIRE, OPTIONAL
5553
- # sending_pool_name: "SendingPoolName",
5554
- # }
5555
- #
5556
4609
  # @!attribute [rw] configuration_set_name
5557
4610
  # The name of the configuration set to associate with a dedicated IP
5558
4611
  # pool.
@@ -5591,14 +4644,6 @@ module Aws::SESV2
5591
4644
  # A request to enable or disable tracking of reputation metrics for a
5592
4645
  # configuration set.
5593
4646
  #
5594
- # @note When making an API call, you may pass PutConfigurationSetReputationOptionsRequest
5595
- # data as a hash:
5596
- #
5597
- # {
5598
- # configuration_set_name: "ConfigurationSetName", # required
5599
- # reputation_metrics_enabled: false,
5600
- # }
5601
- #
5602
4647
  # @!attribute [rw] configuration_set_name
5603
4648
  # The name of the configuration set.
5604
4649
  # @return [String]
@@ -5628,14 +4673,6 @@ module Aws::SESV2
5628
4673
  # A request to enable or disable the ability of Amazon SES to send
5629
4674
  # emails that use a specific configuration set.
5630
4675
  #
5631
- # @note When making an API call, you may pass PutConfigurationSetSendingOptionsRequest
5632
- # data as a hash:
5633
- #
5634
- # {
5635
- # configuration_set_name: "ConfigurationSetName", # required
5636
- # sending_enabled: false,
5637
- # }
5638
- #
5639
4676
  # @!attribute [rw] configuration_set_name
5640
4677
  # The name of the configuration set to enable or disable email sending
5641
4678
  # for.
@@ -5665,14 +4702,6 @@ module Aws::SESV2
5665
4702
  # A request to change the account suppression list preferences for a
5666
4703
  # specific configuration set.
5667
4704
  #
5668
- # @note When making an API call, you may pass PutConfigurationSetSuppressionOptionsRequest
5669
- # data as a hash:
5670
- #
5671
- # {
5672
- # configuration_set_name: "ConfigurationSetName", # required
5673
- # suppressed_reasons: ["BOUNCE"], # accepts BOUNCE, COMPLAINT
5674
- # }
5675
- #
5676
4705
  # @!attribute [rw] configuration_set_name
5677
4706
  # The name of the configuration set to change the suppression list
5678
4707
  # preferences for.
@@ -5711,14 +4740,6 @@ module Aws::SESV2
5711
4740
  # A request to add a custom domain for tracking open and click events to
5712
4741
  # a configuration set.
5713
4742
  #
5714
- # @note When making an API call, you may pass PutConfigurationSetTrackingOptionsRequest
5715
- # data as a hash:
5716
- #
5717
- # {
5718
- # configuration_set_name: "ConfigurationSetName", # required
5719
- # custom_redirect_domain: "CustomRedirectDomain",
5720
- # }
5721
- #
5722
4743
  # @!attribute [rw] configuration_set_name
5723
4744
  # The name of the configuration set.
5724
4745
  # @return [String]
@@ -5745,21 +4766,6 @@ module Aws::SESV2
5745
4766
 
5746
4767
  # A request to add specific VDM settings to a configuration set.
5747
4768
  #
5748
- # @note When making an API call, you may pass PutConfigurationSetVdmOptionsRequest
5749
- # data as a hash:
5750
- #
5751
- # {
5752
- # configuration_set_name: "ConfigurationSetName", # required
5753
- # vdm_options: {
5754
- # dashboard_options: {
5755
- # engagement_metrics: "ENABLED", # accepts ENABLED, DISABLED
5756
- # },
5757
- # guardian_options: {
5758
- # optimized_shared_delivery: "ENABLED", # accepts ENABLED, DISABLED
5759
- # },
5760
- # },
5761
- # }
5762
- #
5763
4769
  # @!attribute [rw] configuration_set_name
5764
4770
  # The name of the configuration set.
5765
4771
  # @return [String]
@@ -5786,14 +4792,6 @@ module Aws::SESV2
5786
4792
 
5787
4793
  # A request to move a dedicated IP address to a dedicated IP pool.
5788
4794
  #
5789
- # @note When making an API call, you may pass PutDedicatedIpInPoolRequest
5790
- # data as a hash:
5791
- #
5792
- # {
5793
- # ip: "Ip", # required
5794
- # destination_pool_name: "PoolName", # required
5795
- # }
5796
- #
5797
4795
  # @!attribute [rw] ip
5798
4796
  # The IP address that you want to move to the dedicated IP pool. The
5799
4797
  # value you specify has to be a dedicated IP address that's
@@ -5825,14 +4823,6 @@ module Aws::SESV2
5825
4823
  # This operation is useful when you want to resume the warm-up process
5826
4824
  # for an existing IP address.
5827
4825
  #
5828
- # @note When making an API call, you may pass PutDedicatedIpWarmupAttributesRequest
5829
- # data as a hash:
5830
- #
5831
- # {
5832
- # ip: "Ip", # required
5833
- # warmup_percentage: 1, # required
5834
- # }
5835
- #
5836
4826
  # @!attribute [rw] ip
5837
4827
  # The dedicated IP address that you want to update the warm-up
5838
4828
  # attributes for.
@@ -5875,23 +4865,6 @@ module Aws::SESV2
5875
4865
  #
5876
4866
  # [1]: http://aws.amazon.com/pinpoint/pricing/
5877
4867
  #
5878
- # @note When making an API call, you may pass PutDeliverabilityDashboardOptionRequest
5879
- # data as a hash:
5880
- #
5881
- # {
5882
- # dashboard_enabled: false, # required
5883
- # subscribed_domains: [
5884
- # {
5885
- # domain: "Domain",
5886
- # subscription_start_date: Time.now,
5887
- # inbox_placement_tracking_option: {
5888
- # global: false,
5889
- # tracked_isps: ["IspName"],
5890
- # },
5891
- # },
5892
- # ],
5893
- # }
5894
- #
5895
4868
  # @!attribute [rw] dashboard_enabled
5896
4869
  # Specifies whether to enable the Deliverability dashboard. To enable
5897
4870
  # the dashboard, set this value to `true`.
@@ -5920,14 +4893,6 @@ module Aws::SESV2
5920
4893
 
5921
4894
  # A request to associate a configuration set with an email identity.
5922
4895
  #
5923
- # @note When making an API call, you may pass PutEmailIdentityConfigurationSetAttributesRequest
5924
- # data as a hash:
5925
- #
5926
- # {
5927
- # email_identity: "Identity", # required
5928
- # configuration_set_name: "ConfigurationSetName",
5929
- # }
5930
- #
5931
4896
  # @!attribute [rw] email_identity
5932
4897
  # The email address or domain to associate with a configuration set.
5933
4898
  # @return [String]
@@ -5955,14 +4920,6 @@ module Aws::SESV2
5955
4920
  # A request to enable or disable DKIM signing of email that you send
5956
4921
  # from an email identity.
5957
4922
  #
5958
- # @note When making an API call, you may pass PutEmailIdentityDkimAttributesRequest
5959
- # data as a hash:
5960
- #
5961
- # {
5962
- # email_identity: "Identity", # required
5963
- # signing_enabled: false,
5964
- # }
5965
- #
5966
4923
  # @!attribute [rw] email_identity
5967
4924
  # The email identity.
5968
4925
  # @return [String]
@@ -5993,19 +4950,6 @@ module Aws::SESV2
5993
4950
 
5994
4951
  # A request to change the DKIM attributes for an email identity.
5995
4952
  #
5996
- # @note When making an API call, you may pass PutEmailIdentityDkimSigningAttributesRequest
5997
- # data as a hash:
5998
- #
5999
- # {
6000
- # email_identity: "Identity", # required
6001
- # signing_attributes_origin: "AWS_SES", # required, accepts AWS_SES, EXTERNAL
6002
- # signing_attributes: {
6003
- # domain_signing_selector: "Selector",
6004
- # domain_signing_private_key: "PrivateKey",
6005
- # next_signing_key_length: "RSA_1024_BIT", # accepts RSA_1024_BIT, RSA_2048_BIT
6006
- # },
6007
- # }
6008
- #
6009
4953
  # @!attribute [rw] email_identity
6010
4954
  # The email identity.
6011
4955
  # @return [String]
@@ -6120,14 +5064,6 @@ module Aws::SESV2
6120
5064
  # A request to set the attributes that control how bounce and complaint
6121
5065
  # events are processed.
6122
5066
  #
6123
- # @note When making an API call, you may pass PutEmailIdentityFeedbackAttributesRequest
6124
- # data as a hash:
6125
- #
6126
- # {
6127
- # email_identity: "Identity", # required
6128
- # email_forwarding_enabled: false,
6129
- # }
6130
- #
6131
5067
  # @!attribute [rw] email_identity
6132
5068
  # The email identity.
6133
5069
  # @return [String]
@@ -6166,15 +5102,6 @@ module Aws::SESV2
6166
5102
  # A request to configure the custom MAIL FROM domain for a verified
6167
5103
  # identity.
6168
5104
  #
6169
- # @note When making an API call, you may pass PutEmailIdentityMailFromAttributesRequest
6170
- # data as a hash:
6171
- #
6172
- # {
6173
- # email_identity: "Identity", # required
6174
- # mail_from_domain: "MailFromDomainName",
6175
- # behavior_on_mx_failure: "USE_DEFAULT_VALUE", # accepts USE_DEFAULT_VALUE, REJECT_MESSAGE
6176
- # }
6177
- #
6178
5105
  # @!attribute [rw] email_identity
6179
5106
  # The verified email identity.
6180
5107
  # @return [String]
@@ -6224,14 +5151,6 @@ module Aws::SESV2
6224
5151
  # A request to add an email destination to the suppression list for your
6225
5152
  # account.
6226
5153
  #
6227
- # @note When making an API call, you may pass PutSuppressedDestinationRequest
6228
- # data as a hash:
6229
- #
6230
- # {
6231
- # email_address: "EmailAddress", # required
6232
- # reason: "BOUNCE", # required, accepts BOUNCE, COMPLAINT
6233
- # }
6234
- #
6235
5154
  # @!attribute [rw] email_address
6236
5155
  # The email address that should be added to the suppression list for
6237
5156
  # your account.
@@ -6260,13 +5179,6 @@ module Aws::SESV2
6260
5179
 
6261
5180
  # Represents the raw content of an email message.
6262
5181
  #
6263
- # @note When making an API call, you may pass RawMessage
6264
- # data as a hash:
6265
- #
6266
- # {
6267
- # data: "data", # required
6268
- # }
6269
- #
6270
5182
  # @!attribute [rw] data
6271
5183
  # The raw email message. The message has to meet the following
6272
5184
  # criteria:
@@ -6354,15 +5266,6 @@ module Aws::SESV2
6354
5266
  # `BulkEmailEntry`. The `ReplacementTemplate` can be specified within
6355
5267
  # this object.
6356
5268
  #
6357
- # @note When making an API call, you may pass ReplacementEmailContent
6358
- # data as a hash:
6359
- #
6360
- # {
6361
- # replacement_template: {
6362
- # replacement_template_data: "EmailTemplateData",
6363
- # },
6364
- # }
6365
- #
6366
5269
  # @!attribute [rw] replacement_template
6367
5270
  # The `ReplacementTemplate` associated with `ReplacementEmailContent`.
6368
5271
  # @return [Types::ReplacementTemplate]
@@ -6378,13 +5281,6 @@ module Aws::SESV2
6378
5281
  # An object which contains `ReplacementTemplateData` to be used for a
6379
5282
  # specific `BulkEmailEntry`.
6380
5283
  #
6381
- # @note When making an API call, you may pass ReplacementTemplate
6382
- # data as a hash:
6383
- #
6384
- # {
6385
- # replacement_template_data: "EmailTemplateData",
6386
- # }
6387
- #
6388
5284
  # @!attribute [rw] replacement_template_data
6389
5285
  # A list of replacement values to apply to the template. This
6390
5286
  # parameter is a JSON object, typically consisting of key-value pairs
@@ -6404,14 +5300,6 @@ module Aws::SESV2
6404
5300
  # send using this configuration set in the current Amazon Web Services
6405
5301
  # Region.
6406
5302
  #
6407
- # @note When making an API call, you may pass ReputationOptions
6408
- # data as a hash:
6409
- #
6410
- # {
6411
- # reputation_metrics_enabled: false,
6412
- # last_fresh_start: Time.now,
6413
- # }
6414
- #
6415
5303
  # @!attribute [rw] reputation_metrics_enabled
6416
5304
  # If `true`, tracking of reputation metrics is enabled for the
6417
5305
  # configuration set. If `false`, tracking of reputation metrics is
@@ -6474,51 +5362,6 @@ module Aws::SESV2
6474
5362
  #
6475
5363
  # [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-personalized-email-api.html
6476
5364
  #
6477
- # @note When making an API call, you may pass SendBulkEmailRequest
6478
- # data as a hash:
6479
- #
6480
- # {
6481
- # from_email_address: "EmailAddress",
6482
- # from_email_address_identity_arn: "AmazonResourceName",
6483
- # reply_to_addresses: ["EmailAddress"],
6484
- # feedback_forwarding_email_address: "EmailAddress",
6485
- # feedback_forwarding_email_address_identity_arn: "AmazonResourceName",
6486
- # default_email_tags: [
6487
- # {
6488
- # name: "MessageTagName", # required
6489
- # value: "MessageTagValue", # required
6490
- # },
6491
- # ],
6492
- # default_content: { # required
6493
- # template: {
6494
- # template_name: "EmailTemplateName",
6495
- # template_arn: "AmazonResourceName",
6496
- # template_data: "EmailTemplateData",
6497
- # },
6498
- # },
6499
- # bulk_email_entries: [ # required
6500
- # {
6501
- # destination: { # required
6502
- # to_addresses: ["EmailAddress"],
6503
- # cc_addresses: ["EmailAddress"],
6504
- # bcc_addresses: ["EmailAddress"],
6505
- # },
6506
- # replacement_tags: [
6507
- # {
6508
- # name: "MessageTagName", # required
6509
- # value: "MessageTagValue", # required
6510
- # },
6511
- # ],
6512
- # replacement_email_content: {
6513
- # replacement_template: {
6514
- # replacement_template_data: "EmailTemplateData",
6515
- # },
6516
- # },
6517
- # },
6518
- # ],
6519
- # configuration_set_name: "ConfigurationSetName",
6520
- # }
6521
- #
6522
5365
  # @!attribute [rw] from_email_address
6523
5366
  # The email address to use as the "From" address for the email. The
6524
5367
  # address that you specify has to be verified.
@@ -6630,15 +5473,6 @@ module Aws::SESV2
6630
5473
  # Represents a request to send a custom verification email to a
6631
5474
  # specified recipient.
6632
5475
  #
6633
- # @note When making an API call, you may pass SendCustomVerificationEmailRequest
6634
- # data as a hash:
6635
- #
6636
- # {
6637
- # email_address: "EmailAddress", # required
6638
- # template_name: "EmailTemplateName", # required
6639
- # configuration_set_name: "ConfigurationSetName",
6640
- # }
6641
- #
6642
5476
  # @!attribute [rw] email_address
6643
5477
  # The email address to verify.
6644
5478
  # @return [String]
@@ -6685,59 +5519,6 @@ module Aws::SESV2
6685
5519
  #
6686
5520
  # [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-email-formatted.html
6687
5521
  #
6688
- # @note When making an API call, you may pass SendEmailRequest
6689
- # data as a hash:
6690
- #
6691
- # {
6692
- # from_email_address: "EmailAddress",
6693
- # from_email_address_identity_arn: "AmazonResourceName",
6694
- # destination: {
6695
- # to_addresses: ["EmailAddress"],
6696
- # cc_addresses: ["EmailAddress"],
6697
- # bcc_addresses: ["EmailAddress"],
6698
- # },
6699
- # reply_to_addresses: ["EmailAddress"],
6700
- # feedback_forwarding_email_address: "EmailAddress",
6701
- # feedback_forwarding_email_address_identity_arn: "AmazonResourceName",
6702
- # content: { # required
6703
- # simple: {
6704
- # subject: { # required
6705
- # data: "MessageData", # required
6706
- # charset: "Charset",
6707
- # },
6708
- # body: { # required
6709
- # text: {
6710
- # data: "MessageData", # required
6711
- # charset: "Charset",
6712
- # },
6713
- # html: {
6714
- # data: "MessageData", # required
6715
- # charset: "Charset",
6716
- # },
6717
- # },
6718
- # },
6719
- # raw: {
6720
- # data: "data", # required
6721
- # },
6722
- # template: {
6723
- # template_name: "EmailTemplateName",
6724
- # template_arn: "AmazonResourceName",
6725
- # template_data: "EmailTemplateData",
6726
- # },
6727
- # },
6728
- # email_tags: [
6729
- # {
6730
- # name: "MessageTagName", # required
6731
- # value: "MessageTagValue", # required
6732
- # },
6733
- # ],
6734
- # configuration_set_name: "ConfigurationSetName",
6735
- # list_management_options: {
6736
- # contact_list_name: "ContactListName", # required
6737
- # topic_name: "TopicName",
6738
- # },
6739
- # }
6740
- #
6741
5522
  # @!attribute [rw] from_email_address
6742
5523
  # The email address to use as the "From" address for the email. The
6743
5524
  # address that you specify has to be verified.
@@ -6900,13 +5681,6 @@ module Aws::SESV2
6900
5681
  # Used to enable or disable email sending for messages that use this
6901
5682
  # configuration set in the current Amazon Web Services Region.
6902
5683
  #
6903
- # @note When making an API call, you may pass SendingOptions
6904
- # data as a hash:
6905
- #
6906
- # {
6907
- # sending_enabled: false,
6908
- # }
6909
- #
6910
5684
  # @!attribute [rw] sending_enabled
6911
5685
  # If `true`, email sending is enabled for the configuration set. If
6912
5686
  # `false`, email sending is disabled for the configuration set.
@@ -6931,13 +5705,6 @@ module Aws::SESV2
6931
5705
  # can use Amazon SNS to send notification when certain email events
6932
5706
  # occur.
6933
5707
  #
6934
- # @note When making an API call, you may pass SnsDestination
6935
- # data as a hash:
6936
- #
6937
- # {
6938
- # topic_arn: "AmazonResourceName", # required
6939
- # }
6940
- #
6941
5708
  # @!attribute [rw] topic_arn
6942
5709
  # The Amazon Resource Name (ARN) of the Amazon SNS topic to publish
6943
5710
  # email events to. For more information about Amazon SNS topics, see
@@ -7066,13 +5833,6 @@ module Aws::SESV2
7066
5833
 
7067
5834
  # An object that contains details about the action of suppression list.
7068
5835
  #
7069
- # @note When making an API call, you may pass SuppressionListDestination
7070
- # data as a hash:
7071
- #
7072
- # {
7073
- # suppression_list_import_action: "DELETE", # required, accepts DELETE, PUT
7074
- # }
7075
- #
7076
5836
  # @!attribute [rw] suppression_list_import_action
7077
5837
  # The type of action to perform on the address. The following are
7078
5838
  # possible values:
@@ -7094,13 +5854,6 @@ module Aws::SESV2
7094
5854
  # An object that contains information about the suppression list
7095
5855
  # preferences for your account.
7096
5856
  #
7097
- # @note When making an API call, you may pass SuppressionOptions
7098
- # data as a hash:
7099
- #
7100
- # {
7101
- # suppressed_reasons: ["BOUNCE"], # accepts BOUNCE, COMPLAINT
7102
- # }
7103
- #
7104
5857
  # @!attribute [rw] suppressed_reasons
7105
5858
  # A list that contains the reasons that email addresses are
7106
5859
  # automatically added to the suppression list for your account. This
@@ -7155,14 +5908,6 @@ module Aws::SESV2
7155
5908
  # available only for resources that are located in the specified
7156
5909
  # Amazon Web Services Region for your Amazon Web Services account.
7157
5910
  #
7158
- # @note When making an API call, you may pass Tag
7159
- # data as a hash:
7160
- #
7161
- # {
7162
- # key: "TagKey", # required
7163
- # value: "TagValue", # required
7164
- # }
7165
- #
7166
5911
  # @!attribute [rw] key
7167
5912
  # One part of a key-value pair that defines a tag. The maximum length
7168
5913
  # of a tag key is 128 characters. The minimum length is 1 character.
@@ -7185,19 +5930,6 @@ module Aws::SESV2
7185
5930
  include Aws::Structure
7186
5931
  end
7187
5932
 
7188
- # @note When making an API call, you may pass TagResourceRequest
7189
- # data as a hash:
7190
- #
7191
- # {
7192
- # resource_arn: "AmazonResourceName", # required
7193
- # tags: [ # required
7194
- # {
7195
- # key: "TagKey", # required
7196
- # value: "TagValue", # required
7197
- # },
7198
- # ],
7199
- # }
7200
- #
7201
5933
  # @!attribute [rw] resource_arn
7202
5934
  # The Amazon Resource Name (ARN) of the resource that you want to add
7203
5935
  # one or more tags to.
@@ -7229,15 +5961,6 @@ module Aws::SESV2
7229
5961
  # that you want to define, save, and reuse in email messages that you
7230
5962
  # send.
7231
5963
  #
7232
- # @note When making an API call, you may pass Template
7233
- # data as a hash:
7234
- #
7235
- # {
7236
- # template_name: "EmailTemplateName",
7237
- # template_arn: "AmazonResourceName",
7238
- # template_data: "EmailTemplateData",
7239
- # }
7240
- #
7241
5964
  # @!attribute [rw] template_name
7242
5965
  # The name of the template. You will refer to this name when you send
7243
5966
  # email using the `SendTemplatedEmail` or `SendBulkTemplatedEmail`
@@ -7268,14 +5991,6 @@ module Aws::SESV2
7268
5991
  # &gt;Represents a request to create a preview of the MIME content of an
7269
5992
  # email when provided with a template and a set of replacement data.
7270
5993
  #
7271
- # @note When making an API call, you may pass TestRenderEmailTemplateRequest
7272
- # data as a hash:
7273
- #
7274
- # {
7275
- # template_name: "EmailTemplateName", # required
7276
- # template_data: "EmailTemplateData", # required
7277
- # }
7278
- #
7279
5994
  # @!attribute [rw] template_name
7280
5995
  # The name of the template.
7281
5996
  # @return [String]
@@ -7321,16 +6036,6 @@ module Aws::SESV2
7321
6036
  # An interest group, theme, or label within a list. Lists can have
7322
6037
  # multiple topics.
7323
6038
  #
7324
- # @note When making an API call, you may pass Topic
7325
- # data as a hash:
7326
- #
7327
- # {
7328
- # topic_name: "TopicName", # required
7329
- # display_name: "DisplayName", # required
7330
- # description: "Description",
7331
- # default_subscription_status: "OPT_IN", # required, accepts OPT_IN, OPT_OUT
7332
- # }
7333
- #
7334
6039
  # @!attribute [rw] topic_name
7335
6040
  # The name of the topic.
7336
6041
  # @return [String]
@@ -7362,14 +6067,6 @@ module Aws::SESV2
7362
6067
 
7363
6068
  # Used for filtering by a specific topic preference.
7364
6069
  #
7365
- # @note When making an API call, you may pass TopicFilter
7366
- # data as a hash:
7367
- #
7368
- # {
7369
- # topic_name: "TopicName",
7370
- # use_default_if_preference_unavailable: false,
7371
- # }
7372
- #
7373
6070
  # @!attribute [rw] topic_name
7374
6071
  # The name of a topic on which you wish to apply the filter.
7375
6072
  # @return [String]
@@ -7392,14 +6089,6 @@ module Aws::SESV2
7392
6089
  # The contact's preference for being opted-in to or opted-out of a
7393
6090
  # topic.
7394
6091
  #
7395
- # @note When making an API call, you may pass TopicPreference
7396
- # data as a hash:
7397
- #
7398
- # {
7399
- # topic_name: "TopicName", # required
7400
- # subscription_status: "OPT_IN", # required, accepts OPT_IN, OPT_OUT
7401
- # }
7402
- #
7403
6092
  # @!attribute [rw] topic_name
7404
6093
  # The name of the topic.
7405
6094
  # @return [String]
@@ -7428,13 +6117,6 @@ module Aws::SESV2
7428
6117
  # Amazon Web Services. You can optionally configure the Amazon SES to
7429
6118
  # use a domain that you operate for these images and links.
7430
6119
  #
7431
- # @note When making an API call, you may pass TrackingOptions
7432
- # data as a hash:
7433
- #
7434
- # {
7435
- # custom_redirect_domain: "CustomRedirectDomain", # required
7436
- # }
7437
- #
7438
6120
  # @!attribute [rw] custom_redirect_domain
7439
6121
  # The domain to use for tracking open and click events.
7440
6122
  # @return [String]
@@ -7447,14 +6129,6 @@ module Aws::SESV2
7447
6129
  include Aws::Structure
7448
6130
  end
7449
6131
 
7450
- # @note When making an API call, you may pass UntagResourceRequest
7451
- # data as a hash:
7452
- #
7453
- # {
7454
- # resource_arn: "AmazonResourceName", # required
7455
- # tag_keys: ["TagKey"], # required
7456
- # }
7457
- #
7458
6132
  # @!attribute [rw] resource_arn
7459
6133
  # The Amazon Resource Name (ARN) of the resource that you want to
7460
6134
  # remove one or more tags from.
@@ -7487,37 +6161,6 @@ module Aws::SESV2
7487
6161
  # A request to change the settings for an event destination for a
7488
6162
  # configuration set.
7489
6163
  #
7490
- # @note When making an API call, you may pass UpdateConfigurationSetEventDestinationRequest
7491
- # data as a hash:
7492
- #
7493
- # {
7494
- # configuration_set_name: "ConfigurationSetName", # required
7495
- # event_destination_name: "EventDestinationName", # required
7496
- # event_destination: { # required
7497
- # enabled: false,
7498
- # matching_event_types: ["SEND"], # accepts SEND, REJECT, BOUNCE, COMPLAINT, DELIVERY, OPEN, CLICK, RENDERING_FAILURE, DELIVERY_DELAY, SUBSCRIPTION
7499
- # kinesis_firehose_destination: {
7500
- # iam_role_arn: "AmazonResourceName", # required
7501
- # delivery_stream_arn: "AmazonResourceName", # required
7502
- # },
7503
- # cloud_watch_destination: {
7504
- # dimension_configurations: [ # required
7505
- # {
7506
- # dimension_name: "DimensionName", # required
7507
- # dimension_value_source: "MESSAGE_TAG", # required, accepts MESSAGE_TAG, EMAIL_HEADER, LINK_TAG
7508
- # default_dimension_value: "DefaultDimensionValue", # required
7509
- # },
7510
- # ],
7511
- # },
7512
- # sns_destination: {
7513
- # topic_arn: "AmazonResourceName", # required
7514
- # },
7515
- # pinpoint_destination: {
7516
- # application_arn: "AmazonResourceName",
7517
- # },
7518
- # },
7519
- # }
7520
- #
7521
6164
  # @!attribute [rw] configuration_set_name
7522
6165
  # The name of the configuration set that contains the event
7523
6166
  # destination to modify.
@@ -7548,22 +6191,6 @@ module Aws::SESV2
7548
6191
  #
7549
6192
  class UpdateConfigurationSetEventDestinationResponse < Aws::EmptyStructure; end
7550
6193
 
7551
- # @note When making an API call, you may pass UpdateContactListRequest
7552
- # data as a hash:
7553
- #
7554
- # {
7555
- # contact_list_name: "ContactListName", # required
7556
- # topics: [
7557
- # {
7558
- # topic_name: "TopicName", # required
7559
- # display_name: "DisplayName", # required
7560
- # description: "Description",
7561
- # default_subscription_status: "OPT_IN", # required, accepts OPT_IN, OPT_OUT
7562
- # },
7563
- # ],
7564
- # description: "Description",
7565
- # }
7566
- #
7567
6194
  # @!attribute [rw] contact_list_name
7568
6195
  # The name of the contact list.
7569
6196
  # @return [String]
@@ -7591,22 +6218,6 @@ module Aws::SESV2
7591
6218
  #
7592
6219
  class UpdateContactListResponse < Aws::EmptyStructure; end
7593
6220
 
7594
- # @note When making an API call, you may pass UpdateContactRequest
7595
- # data as a hash:
7596
- #
7597
- # {
7598
- # contact_list_name: "ContactListName", # required
7599
- # email_address: "EmailAddress", # required
7600
- # topic_preferences: [
7601
- # {
7602
- # topic_name: "TopicName", # required
7603
- # subscription_status: "OPT_IN", # required, accepts OPT_IN, OPT_OUT
7604
- # },
7605
- # ],
7606
- # unsubscribe_all: false,
7607
- # attributes_data: "AttributesData",
7608
- # }
7609
- #
7610
6221
  # @!attribute [rw] contact_list_name
7611
6222
  # The name of the contact list.
7612
6223
  # @return [String]
@@ -7648,18 +6259,6 @@ module Aws::SESV2
7648
6259
  # Represents a request to update an existing custom verification email
7649
6260
  # template.
7650
6261
  #
7651
- # @note When making an API call, you may pass UpdateCustomVerificationEmailTemplateRequest
7652
- # data as a hash:
7653
- #
7654
- # {
7655
- # template_name: "EmailTemplateName", # required
7656
- # from_email_address: "EmailAddress", # required
7657
- # template_subject: "EmailTemplateSubject", # required
7658
- # template_content: "TemplateContent", # required
7659
- # success_redirection_url: "SuccessRedirectionURL", # required
7660
- # failure_redirection_url: "FailureRedirectionURL", # required
7661
- # }
7662
- #
7663
6262
  # @!attribute [rw] template_name
7664
6263
  # The name of the custom verification email template that you want to
7665
6264
  # update.
@@ -7724,15 +6323,6 @@ module Aws::SESV2
7724
6323
  #
7725
6324
  # [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization-identity-owner-tasks-management.html
7726
6325
  #
7727
- # @note When making an API call, you may pass UpdateEmailIdentityPolicyRequest
7728
- # data as a hash:
7729
- #
7730
- # {
7731
- # email_identity: "Identity", # required
7732
- # policy_name: "PolicyName", # required
7733
- # policy: "Policy", # required
7734
- # }
7735
- #
7736
6326
  # @!attribute [rw] email_identity
7737
6327
  # The email identity.
7738
6328
  # @return [String]
@@ -7780,18 +6370,6 @@ module Aws::SESV2
7780
6370
  #
7781
6371
  # [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-personalized-email-api.html
7782
6372
  #
7783
- # @note When making an API call, you may pass UpdateEmailTemplateRequest
7784
- # data as a hash:
7785
- #
7786
- # {
7787
- # template_name: "EmailTemplateName", # required
7788
- # template_content: { # required
7789
- # subject: "EmailTemplateSubject",
7790
- # text: "EmailTemplateText",
7791
- # html: "EmailTemplateHtml",
7792
- # },
7793
- # }
7794
- #
7795
6373
  # @!attribute [rw] template_name
7796
6374
  # The name of the template.
7797
6375
  # @return [String]
@@ -7819,19 +6397,6 @@ module Aws::SESV2
7819
6397
 
7820
6398
  # The VDM attributes that apply to your Amazon SES account.
7821
6399
  #
7822
- # @note When making an API call, you may pass VdmAttributes
7823
- # data as a hash:
7824
- #
7825
- # {
7826
- # vdm_enabled: "ENABLED", # required, accepts ENABLED, DISABLED
7827
- # dashboard_attributes: {
7828
- # engagement_metrics: "ENABLED", # accepts ENABLED, DISABLED
7829
- # },
7830
- # guardian_attributes: {
7831
- # optimized_shared_delivery: "ENABLED", # accepts ENABLED, DISABLED
7832
- # },
7833
- # }
7834
- #
7835
6400
  # @!attribute [rw] vdm_enabled
7836
6401
  # Specifies the status of your VDM configuration. Can be one of the
7837
6402
  # following:
@@ -7864,18 +6429,6 @@ module Aws::SESV2
7864
6429
  # An object that defines the VDM settings that apply to emails that you
7865
6430
  # send using the configuration set.
7866
6431
  #
7867
- # @note When making an API call, you may pass VdmOptions
7868
- # data as a hash:
7869
- #
7870
- # {
7871
- # dashboard_options: {
7872
- # engagement_metrics: "ENABLED", # accepts ENABLED, DISABLED
7873
- # },
7874
- # guardian_options: {
7875
- # optimized_shared_delivery: "ENABLED", # accepts ENABLED, DISABLED
7876
- # },
7877
- # }
7878
- #
7879
6432
  # @!attribute [rw] dashboard_options
7880
6433
  # Specifies additional settings for your VDM configuration as
7881
6434
  # applicable to the Dashboard.