aws-sdk-sesv2 1.11.0 → 1.16.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/lib/aws-sdk-sesv2.rb +2 -1
- data/lib/aws-sdk-sesv2/client.rb +502 -6
- data/lib/aws-sdk-sesv2/client_api.rb +324 -1
- data/lib/aws-sdk-sesv2/types.rb +846 -10
- metadata +4 -4
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 2e69db66cd52b826dec1e44dca0b0d2c9ff515e8f115136ceb6cb20185e42812
|
4
|
+
data.tar.gz: 131c74a8d5b0bed0790c42fe05c5366fd4560b82f9dbfec574c3ef5bf30b4b35
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 0e2b177c6e66cdcfe6f2f920577dcf1627d2b38086e341c9f14a71cc5435b5ba3bfdb5704d872da4b63957076adffd12cc91c90dedbce4cc3c37766223f00c38
|
7
|
+
data.tar.gz: 376cc6980ddb400601e22576cf99f0b44cad1464db44876d934470067c45e201a2ceaa9134d5e9b2798ea1a90827f10b0c811c1aadff60aabf99f964fe7c3f17
|
data/lib/aws-sdk-sesv2.rb
CHANGED
@@ -7,6 +7,7 @@
|
|
7
7
|
#
|
8
8
|
# WARNING ABOUT GENERATED CODE
|
9
9
|
|
10
|
+
|
10
11
|
require 'aws-sdk-core'
|
11
12
|
require 'aws-sigv4'
|
12
13
|
|
@@ -47,6 +48,6 @@ require_relative 'aws-sdk-sesv2/customizations'
|
|
47
48
|
# @!group service
|
48
49
|
module Aws::SESV2
|
49
50
|
|
50
|
-
GEM_VERSION = '1.
|
51
|
+
GEM_VERSION = '1.16.0'
|
51
52
|
|
52
53
|
end
|
data/lib/aws-sdk-sesv2/client.rb
CHANGED
@@ -432,7 +432,7 @@ module Aws::SESV2
|
|
432
432
|
# event_destination_name: "EventDestinationName", # required
|
433
433
|
# event_destination: { # required
|
434
434
|
# enabled: false,
|
435
|
-
# matching_event_types: ["SEND"], # accepts SEND, REJECT, BOUNCE, COMPLAINT, DELIVERY, OPEN, CLICK, RENDERING_FAILURE, DELIVERY_DELAY
|
435
|
+
# matching_event_types: ["SEND"], # accepts SEND, REJECT, BOUNCE, COMPLAINT, DELIVERY, OPEN, CLICK, RENDERING_FAILURE, DELIVERY_DELAY, SUBSCRIPTION
|
436
436
|
# kinesis_firehose_destination: {
|
437
437
|
# iam_role_arn: "AmazonResourceName", # required
|
438
438
|
# delivery_stream_arn: "AmazonResourceName", # required
|
@@ -464,6 +464,99 @@ module Aws::SESV2
|
|
464
464
|
req.send_request(options)
|
465
465
|
end
|
466
466
|
|
467
|
+
# Creates a contact, which is an end-user who is receiving the email,
|
468
|
+
# and adds them to a contact list.
|
469
|
+
#
|
470
|
+
# @option params [required, String] :contact_list_name
|
471
|
+
# The name of the contact list to which the contact should be added.
|
472
|
+
#
|
473
|
+
# @option params [required, String] :email_address
|
474
|
+
# The contact's email address.
|
475
|
+
#
|
476
|
+
# @option params [Array<Types::TopicPreference>] :topic_preferences
|
477
|
+
# The contact's preferences for being opted-in to or opted-out of
|
478
|
+
# topics.
|
479
|
+
#
|
480
|
+
# @option params [Boolean] :unsubscribe_all
|
481
|
+
# A boolean value status noting if the contact is unsubscribed from all
|
482
|
+
# contact list topics.
|
483
|
+
#
|
484
|
+
# @option params [String] :attributes_data
|
485
|
+
# The attribute data attached to a contact.
|
486
|
+
#
|
487
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
488
|
+
#
|
489
|
+
# @example Request syntax with placeholder values
|
490
|
+
#
|
491
|
+
# resp = client.create_contact({
|
492
|
+
# contact_list_name: "ContactListName", # required
|
493
|
+
# email_address: "EmailAddress", # required
|
494
|
+
# topic_preferences: [
|
495
|
+
# {
|
496
|
+
# topic_name: "TopicName", # required
|
497
|
+
# subscription_status: "OPT_IN", # required, accepts OPT_IN, OPT_OUT
|
498
|
+
# },
|
499
|
+
# ],
|
500
|
+
# unsubscribe_all: false,
|
501
|
+
# attributes_data: "AttributesData",
|
502
|
+
# })
|
503
|
+
#
|
504
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/CreateContact AWS API Documentation
|
505
|
+
#
|
506
|
+
# @overload create_contact(params = {})
|
507
|
+
# @param [Hash] params ({})
|
508
|
+
def create_contact(params = {}, options = {})
|
509
|
+
req = build_request(:create_contact, params)
|
510
|
+
req.send_request(options)
|
511
|
+
end
|
512
|
+
|
513
|
+
# Creates a contact list.
|
514
|
+
#
|
515
|
+
# @option params [required, String] :contact_list_name
|
516
|
+
# The name of the contact list.
|
517
|
+
#
|
518
|
+
# @option params [Array<Types::Topic>] :topics
|
519
|
+
# An interest group, theme, or label within a list. A contact list can
|
520
|
+
# have multiple topics.
|
521
|
+
#
|
522
|
+
# @option params [String] :description
|
523
|
+
# A description of what the contact list is about.
|
524
|
+
#
|
525
|
+
# @option params [Array<Types::Tag>] :tags
|
526
|
+
# The tags associated with a contact list.
|
527
|
+
#
|
528
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
529
|
+
#
|
530
|
+
# @example Request syntax with placeholder values
|
531
|
+
#
|
532
|
+
# resp = client.create_contact_list({
|
533
|
+
# contact_list_name: "ContactListName", # required
|
534
|
+
# topics: [
|
535
|
+
# {
|
536
|
+
# topic_name: "TopicName", # required
|
537
|
+
# display_name: "DisplayName", # required
|
538
|
+
# description: "Description",
|
539
|
+
# default_subscription_status: "OPT_IN", # required, accepts OPT_IN, OPT_OUT
|
540
|
+
# },
|
541
|
+
# ],
|
542
|
+
# description: "Description",
|
543
|
+
# tags: [
|
544
|
+
# {
|
545
|
+
# key: "TagKey", # required
|
546
|
+
# value: "TagValue", # required
|
547
|
+
# },
|
548
|
+
# ],
|
549
|
+
# })
|
550
|
+
#
|
551
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/CreateContactList AWS API Documentation
|
552
|
+
#
|
553
|
+
# @overload create_contact_list(params = {})
|
554
|
+
# @param [Hash] params ({})
|
555
|
+
def create_contact_list(params = {}, options = {})
|
556
|
+
req = build_request(:create_contact_list, params)
|
557
|
+
req.send_request(options)
|
558
|
+
end
|
559
|
+
|
467
560
|
# Creates a new custom verification email template.
|
468
561
|
#
|
469
562
|
# For more information about custom verification email templates, see
|
@@ -673,6 +766,16 @@ module Aws::SESV2
|
|
673
766
|
# the public key that you want to use for DKIM authentication) and a
|
674
767
|
# private key.
|
675
768
|
#
|
769
|
+
# When you verify a domain, this operation provides a set of DKIM
|
770
|
+
# tokens, which you can convert into CNAME tokens. You add these CNAME
|
771
|
+
# tokens to the DNS configuration for your domain. Your domain is
|
772
|
+
# verified when Amazon SES detects these records in the DNS
|
773
|
+
# configuration for your domain. For some DNS providers, it can take 72
|
774
|
+
# hours or more to complete the domain verification process.
|
775
|
+
#
|
776
|
+
# Additionally, you can associate an existing configuration set with the
|
777
|
+
# email identity that you're verifying.
|
778
|
+
#
|
676
779
|
#
|
677
780
|
#
|
678
781
|
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/easy-dkim.html
|
@@ -696,6 +799,11 @@ module Aws::SESV2
|
|
696
799
|
#
|
697
800
|
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/easy-dkim.html
|
698
801
|
#
|
802
|
+
# @option params [String] :configuration_set_name
|
803
|
+
# The configuration set to use by default when sending from this
|
804
|
+
# identity. Note that any configuration set defined in the email sending
|
805
|
+
# request takes precedence.
|
806
|
+
#
|
699
807
|
# @return [Types::CreateEmailIdentityResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
700
808
|
#
|
701
809
|
# * {Types::CreateEmailIdentityResponse#identity_type #identity_type} => String
|
@@ -716,6 +824,7 @@ module Aws::SESV2
|
|
716
824
|
# domain_signing_selector: "Selector", # required
|
717
825
|
# domain_signing_private_key: "PrivateKey", # required
|
718
826
|
# },
|
827
|
+
# configuration_set_name: "ConfigurationSetName",
|
719
828
|
# })
|
720
829
|
#
|
721
830
|
# @example Response structure
|
@@ -849,9 +958,13 @@ module Aws::SESV2
|
|
849
958
|
#
|
850
959
|
# resp = client.create_import_job({
|
851
960
|
# import_destination: { # required
|
852
|
-
# suppression_list_destination: {
|
961
|
+
# suppression_list_destination: {
|
853
962
|
# suppression_list_import_action: "DELETE", # required, accepts DELETE, PUT
|
854
963
|
# },
|
964
|
+
# contact_list_destination: {
|
965
|
+
# contact_list_name: "ContactListName", # required
|
966
|
+
# contact_list_import_action: "DELETE", # required, accepts DELETE, PUT
|
967
|
+
# },
|
855
968
|
# },
|
856
969
|
# import_data_source: { # required
|
857
970
|
# s3_url: "S3Url", # required
|
@@ -934,6 +1047,54 @@ module Aws::SESV2
|
|
934
1047
|
req.send_request(options)
|
935
1048
|
end
|
936
1049
|
|
1050
|
+
# Removes a contact from a contact list.
|
1051
|
+
#
|
1052
|
+
# @option params [required, String] :contact_list_name
|
1053
|
+
# The name of the contact list from which the contact should be removed.
|
1054
|
+
#
|
1055
|
+
# @option params [required, String] :email_address
|
1056
|
+
# The contact's email address.
|
1057
|
+
#
|
1058
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1059
|
+
#
|
1060
|
+
# @example Request syntax with placeholder values
|
1061
|
+
#
|
1062
|
+
# resp = client.delete_contact({
|
1063
|
+
# contact_list_name: "ContactListName", # required
|
1064
|
+
# email_address: "EmailAddress", # required
|
1065
|
+
# })
|
1066
|
+
#
|
1067
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/DeleteContact AWS API Documentation
|
1068
|
+
#
|
1069
|
+
# @overload delete_contact(params = {})
|
1070
|
+
# @param [Hash] params ({})
|
1071
|
+
def delete_contact(params = {}, options = {})
|
1072
|
+
req = build_request(:delete_contact, params)
|
1073
|
+
req.send_request(options)
|
1074
|
+
end
|
1075
|
+
|
1076
|
+
# Deletes a contact list and all of the contacts on that list.
|
1077
|
+
#
|
1078
|
+
# @option params [required, String] :contact_list_name
|
1079
|
+
# The name of the contact list.
|
1080
|
+
#
|
1081
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1082
|
+
#
|
1083
|
+
# @example Request syntax with placeholder values
|
1084
|
+
#
|
1085
|
+
# resp = client.delete_contact_list({
|
1086
|
+
# contact_list_name: "ContactListName", # required
|
1087
|
+
# })
|
1088
|
+
#
|
1089
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/DeleteContactList AWS API Documentation
|
1090
|
+
#
|
1091
|
+
# @overload delete_contact_list(params = {})
|
1092
|
+
# @param [Hash] params ({})
|
1093
|
+
def delete_contact_list(params = {}, options = {})
|
1094
|
+
req = build_request(:delete_contact_list, params)
|
1095
|
+
req.send_request(options)
|
1096
|
+
end
|
1097
|
+
|
937
1098
|
# Deletes an existing custom verification email template.
|
938
1099
|
#
|
939
1100
|
# For more information about custom verification email templates, see
|
@@ -1266,7 +1427,7 @@ module Aws::SESV2
|
|
1266
1427
|
# resp.event_destinations[0].name #=> String
|
1267
1428
|
# resp.event_destinations[0].enabled #=> Boolean
|
1268
1429
|
# resp.event_destinations[0].matching_event_types #=> Array
|
1269
|
-
# resp.event_destinations[0].matching_event_types[0] #=> String, one of "SEND", "REJECT", "BOUNCE", "COMPLAINT", "DELIVERY", "OPEN", "CLICK", "RENDERING_FAILURE", "DELIVERY_DELAY"
|
1430
|
+
# resp.event_destinations[0].matching_event_types[0] #=> String, one of "SEND", "REJECT", "BOUNCE", "COMPLAINT", "DELIVERY", "OPEN", "CLICK", "RENDERING_FAILURE", "DELIVERY_DELAY", "SUBSCRIPTION"
|
1270
1431
|
# resp.event_destinations[0].kinesis_firehose_destination.iam_role_arn #=> String
|
1271
1432
|
# resp.event_destinations[0].kinesis_firehose_destination.delivery_stream_arn #=> String
|
1272
1433
|
# resp.event_destinations[0].cloud_watch_destination.dimension_configurations #=> Array
|
@@ -1285,6 +1446,101 @@ module Aws::SESV2
|
|
1285
1446
|
req.send_request(options)
|
1286
1447
|
end
|
1287
1448
|
|
1449
|
+
# Returns a contact from a contact list.
|
1450
|
+
#
|
1451
|
+
# @option params [required, String] :contact_list_name
|
1452
|
+
# The name of the contact list to which the contact belongs.
|
1453
|
+
#
|
1454
|
+
# @option params [required, String] :email_address
|
1455
|
+
# The contact's email addres.
|
1456
|
+
#
|
1457
|
+
# @return [Types::GetContactResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1458
|
+
#
|
1459
|
+
# * {Types::GetContactResponse#contact_list_name #contact_list_name} => String
|
1460
|
+
# * {Types::GetContactResponse#email_address #email_address} => String
|
1461
|
+
# * {Types::GetContactResponse#topic_preferences #topic_preferences} => Array<Types::TopicPreference>
|
1462
|
+
# * {Types::GetContactResponse#topic_default_preferences #topic_default_preferences} => Array<Types::TopicPreference>
|
1463
|
+
# * {Types::GetContactResponse#unsubscribe_all #unsubscribe_all} => Boolean
|
1464
|
+
# * {Types::GetContactResponse#attributes_data #attributes_data} => String
|
1465
|
+
# * {Types::GetContactResponse#created_timestamp #created_timestamp} => Time
|
1466
|
+
# * {Types::GetContactResponse#last_updated_timestamp #last_updated_timestamp} => Time
|
1467
|
+
#
|
1468
|
+
# @example Request syntax with placeholder values
|
1469
|
+
#
|
1470
|
+
# resp = client.get_contact({
|
1471
|
+
# contact_list_name: "ContactListName", # required
|
1472
|
+
# email_address: "EmailAddress", # required
|
1473
|
+
# })
|
1474
|
+
#
|
1475
|
+
# @example Response structure
|
1476
|
+
#
|
1477
|
+
# resp.contact_list_name #=> String
|
1478
|
+
# resp.email_address #=> String
|
1479
|
+
# resp.topic_preferences #=> Array
|
1480
|
+
# resp.topic_preferences[0].topic_name #=> String
|
1481
|
+
# resp.topic_preferences[0].subscription_status #=> String, one of "OPT_IN", "OPT_OUT"
|
1482
|
+
# resp.topic_default_preferences #=> Array
|
1483
|
+
# resp.topic_default_preferences[0].topic_name #=> String
|
1484
|
+
# resp.topic_default_preferences[0].subscription_status #=> String, one of "OPT_IN", "OPT_OUT"
|
1485
|
+
# resp.unsubscribe_all #=> Boolean
|
1486
|
+
# resp.attributes_data #=> String
|
1487
|
+
# resp.created_timestamp #=> Time
|
1488
|
+
# resp.last_updated_timestamp #=> Time
|
1489
|
+
#
|
1490
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/GetContact AWS API Documentation
|
1491
|
+
#
|
1492
|
+
# @overload get_contact(params = {})
|
1493
|
+
# @param [Hash] params ({})
|
1494
|
+
def get_contact(params = {}, options = {})
|
1495
|
+
req = build_request(:get_contact, params)
|
1496
|
+
req.send_request(options)
|
1497
|
+
end
|
1498
|
+
|
1499
|
+
# Returns contact list metadata. It does not return any information
|
1500
|
+
# about the contacts present in the list.
|
1501
|
+
#
|
1502
|
+
# @option params [required, String] :contact_list_name
|
1503
|
+
# The name of the contact list.
|
1504
|
+
#
|
1505
|
+
# @return [Types::GetContactListResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1506
|
+
#
|
1507
|
+
# * {Types::GetContactListResponse#contact_list_name #contact_list_name} => String
|
1508
|
+
# * {Types::GetContactListResponse#topics #topics} => Array<Types::Topic>
|
1509
|
+
# * {Types::GetContactListResponse#description #description} => String
|
1510
|
+
# * {Types::GetContactListResponse#created_timestamp #created_timestamp} => Time
|
1511
|
+
# * {Types::GetContactListResponse#last_updated_timestamp #last_updated_timestamp} => Time
|
1512
|
+
# * {Types::GetContactListResponse#tags #tags} => Array<Types::Tag>
|
1513
|
+
#
|
1514
|
+
# @example Request syntax with placeholder values
|
1515
|
+
#
|
1516
|
+
# resp = client.get_contact_list({
|
1517
|
+
# contact_list_name: "ContactListName", # required
|
1518
|
+
# })
|
1519
|
+
#
|
1520
|
+
# @example Response structure
|
1521
|
+
#
|
1522
|
+
# resp.contact_list_name #=> String
|
1523
|
+
# resp.topics #=> Array
|
1524
|
+
# resp.topics[0].topic_name #=> String
|
1525
|
+
# resp.topics[0].display_name #=> String
|
1526
|
+
# resp.topics[0].description #=> String
|
1527
|
+
# resp.topics[0].default_subscription_status #=> String, one of "OPT_IN", "OPT_OUT"
|
1528
|
+
# resp.description #=> String
|
1529
|
+
# resp.created_timestamp #=> Time
|
1530
|
+
# resp.last_updated_timestamp #=> Time
|
1531
|
+
# resp.tags #=> Array
|
1532
|
+
# resp.tags[0].key #=> String
|
1533
|
+
# resp.tags[0].value #=> String
|
1534
|
+
#
|
1535
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/GetContactList AWS API Documentation
|
1536
|
+
#
|
1537
|
+
# @overload get_contact_list(params = {})
|
1538
|
+
# @param [Hash] params ({})
|
1539
|
+
def get_contact_list(params = {}, options = {})
|
1540
|
+
req = build_request(:get_contact_list, params)
|
1541
|
+
req.send_request(options)
|
1542
|
+
end
|
1543
|
+
|
1288
1544
|
# Returns the custom email verification template for the template name
|
1289
1545
|
# you specify.
|
1290
1546
|
#
|
@@ -1649,6 +1905,7 @@ module Aws::SESV2
|
|
1649
1905
|
# * {Types::GetEmailIdentityResponse#mail_from_attributes #mail_from_attributes} => Types::MailFromAttributes
|
1650
1906
|
# * {Types::GetEmailIdentityResponse#policies #policies} => Hash<String,String>
|
1651
1907
|
# * {Types::GetEmailIdentityResponse#tags #tags} => Array<Types::Tag>
|
1908
|
+
# * {Types::GetEmailIdentityResponse#configuration_set_name #configuration_set_name} => String
|
1652
1909
|
#
|
1653
1910
|
# @example Request syntax with placeholder values
|
1654
1911
|
#
|
@@ -1674,6 +1931,7 @@ module Aws::SESV2
|
|
1674
1931
|
# resp.tags #=> Array
|
1675
1932
|
# resp.tags[0].key #=> String
|
1676
1933
|
# resp.tags[0].value #=> String
|
1934
|
+
# resp.configuration_set_name #=> String
|
1677
1935
|
#
|
1678
1936
|
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/GetEmailIdentity AWS API Documentation
|
1679
1937
|
#
|
@@ -1793,6 +2051,8 @@ module Aws::SESV2
|
|
1793
2051
|
#
|
1794
2052
|
# resp.job_id #=> String
|
1795
2053
|
# resp.import_destination.suppression_list_destination.suppression_list_import_action #=> String, one of "DELETE", "PUT"
|
2054
|
+
# resp.import_destination.contact_list_destination.contact_list_name #=> String
|
2055
|
+
# resp.import_destination.contact_list_destination.contact_list_import_action #=> String, one of "DELETE", "PUT"
|
1796
2056
|
# resp.import_data_source.s3_url #=> String
|
1797
2057
|
# resp.import_data_source.data_format #=> String, one of "CSV", "JSON"
|
1798
2058
|
# resp.failure_info.failed_records_s3_url #=> String
|
@@ -1893,6 +2153,118 @@ module Aws::SESV2
|
|
1893
2153
|
req.send_request(options)
|
1894
2154
|
end
|
1895
2155
|
|
2156
|
+
# Lists all of the contact lists available.
|
2157
|
+
#
|
2158
|
+
# @option params [Integer] :page_size
|
2159
|
+
# Maximum number of contact lists to return at once. Use this parameter
|
2160
|
+
# to paginate results. If additional contact lists exist beyond the
|
2161
|
+
# specified limit, the `NextToken` element is sent in the response. Use
|
2162
|
+
# the `NextToken` value in subsequent requests to retrieve additional
|
2163
|
+
# lists.
|
2164
|
+
#
|
2165
|
+
# @option params [String] :next_token
|
2166
|
+
# A string token indicating that there might be additional contact lists
|
2167
|
+
# available to be listed. Use the token provided in the Response to use
|
2168
|
+
# in the subsequent call to ListContactLists with the same parameters to
|
2169
|
+
# retrieve the next page of contact lists.
|
2170
|
+
#
|
2171
|
+
# @return [Types::ListContactListsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2172
|
+
#
|
2173
|
+
# * {Types::ListContactListsResponse#contact_lists #contact_lists} => Array<Types::ContactList>
|
2174
|
+
# * {Types::ListContactListsResponse#next_token #next_token} => String
|
2175
|
+
#
|
2176
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2177
|
+
#
|
2178
|
+
# @example Request syntax with placeholder values
|
2179
|
+
#
|
2180
|
+
# resp = client.list_contact_lists({
|
2181
|
+
# page_size: 1,
|
2182
|
+
# next_token: "NextToken",
|
2183
|
+
# })
|
2184
|
+
#
|
2185
|
+
# @example Response structure
|
2186
|
+
#
|
2187
|
+
# resp.contact_lists #=> Array
|
2188
|
+
# resp.contact_lists[0].contact_list_name #=> String
|
2189
|
+
# resp.contact_lists[0].last_updated_timestamp #=> Time
|
2190
|
+
# resp.next_token #=> String
|
2191
|
+
#
|
2192
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/ListContactLists AWS API Documentation
|
2193
|
+
#
|
2194
|
+
# @overload list_contact_lists(params = {})
|
2195
|
+
# @param [Hash] params ({})
|
2196
|
+
def list_contact_lists(params = {}, options = {})
|
2197
|
+
req = build_request(:list_contact_lists, params)
|
2198
|
+
req.send_request(options)
|
2199
|
+
end
|
2200
|
+
|
2201
|
+
# Lists the contacts present in a specific contact list.
|
2202
|
+
#
|
2203
|
+
# @option params [required, String] :contact_list_name
|
2204
|
+
# The name of the contact list.
|
2205
|
+
#
|
2206
|
+
# @option params [Types::ListContactsFilter] :filter
|
2207
|
+
# A filter that can be applied to a list of contacts.
|
2208
|
+
#
|
2209
|
+
# @option params [Integer] :page_size
|
2210
|
+
# The number of contacts that may be returned at once, which is
|
2211
|
+
# dependent on if there are more or less contacts than the value of the
|
2212
|
+
# PageSize. Use this parameter to paginate results. If additional
|
2213
|
+
# contacts exist beyond the specified limit, the `NextToken` element is
|
2214
|
+
# sent in the response. Use the `NextToken` value in subsequent requests
|
2215
|
+
# to retrieve additional contacts.
|
2216
|
+
#
|
2217
|
+
# @option params [String] :next_token
|
2218
|
+
# A string token indicating that there might be additional contacts
|
2219
|
+
# available to be listed. Use the token provided in the Response to use
|
2220
|
+
# in the subsequent call to ListContacts with the same parameters to
|
2221
|
+
# retrieve the next page of contacts.
|
2222
|
+
#
|
2223
|
+
# @return [Types::ListContactsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2224
|
+
#
|
2225
|
+
# * {Types::ListContactsResponse#contacts #contacts} => Array<Types::Contact>
|
2226
|
+
# * {Types::ListContactsResponse#next_token #next_token} => String
|
2227
|
+
#
|
2228
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2229
|
+
#
|
2230
|
+
# @example Request syntax with placeholder values
|
2231
|
+
#
|
2232
|
+
# resp = client.list_contacts({
|
2233
|
+
# contact_list_name: "ContactListName", # required
|
2234
|
+
# filter: {
|
2235
|
+
# filtered_status: "OPT_IN", # accepts OPT_IN, OPT_OUT
|
2236
|
+
# topic_filter: {
|
2237
|
+
# topic_name: "TopicName",
|
2238
|
+
# use_default_if_preference_unavailable: false,
|
2239
|
+
# },
|
2240
|
+
# },
|
2241
|
+
# page_size: 1,
|
2242
|
+
# next_token: "NextToken",
|
2243
|
+
# })
|
2244
|
+
#
|
2245
|
+
# @example Response structure
|
2246
|
+
#
|
2247
|
+
# resp.contacts #=> Array
|
2248
|
+
# resp.contacts[0].email_address #=> String
|
2249
|
+
# resp.contacts[0].topic_preferences #=> Array
|
2250
|
+
# resp.contacts[0].topic_preferences[0].topic_name #=> String
|
2251
|
+
# resp.contacts[0].topic_preferences[0].subscription_status #=> String, one of "OPT_IN", "OPT_OUT"
|
2252
|
+
# resp.contacts[0].topic_default_preferences #=> Array
|
2253
|
+
# resp.contacts[0].topic_default_preferences[0].topic_name #=> String
|
2254
|
+
# resp.contacts[0].topic_default_preferences[0].subscription_status #=> String, one of "OPT_IN", "OPT_OUT"
|
2255
|
+
# resp.contacts[0].unsubscribe_all #=> Boolean
|
2256
|
+
# resp.contacts[0].last_updated_timestamp #=> Time
|
2257
|
+
# resp.next_token #=> String
|
2258
|
+
#
|
2259
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/ListContacts AWS API Documentation
|
2260
|
+
#
|
2261
|
+
# @overload list_contacts(params = {})
|
2262
|
+
# @param [Hash] params ({})
|
2263
|
+
def list_contacts(params = {}, options = {})
|
2264
|
+
req = build_request(:list_contacts, params)
|
2265
|
+
req.send_request(options)
|
2266
|
+
end
|
2267
|
+
|
1896
2268
|
# Lists the existing custom verification email templates for your
|
1897
2269
|
# account in the current AWS Region.
|
1898
2270
|
#
|
@@ -2253,7 +2625,7 @@ module Aws::SESV2
|
|
2253
2625
|
# @example Request syntax with placeholder values
|
2254
2626
|
#
|
2255
2627
|
# resp = client.list_import_jobs({
|
2256
|
-
# import_destination_type: "SUPPRESSION_LIST", # accepts SUPPRESSION_LIST
|
2628
|
+
# import_destination_type: "SUPPRESSION_LIST", # accepts SUPPRESSION_LIST, CONTACT_LIST
|
2257
2629
|
# next_token: "NextToken",
|
2258
2630
|
# page_size: 1,
|
2259
2631
|
# })
|
@@ -2263,6 +2635,8 @@ module Aws::SESV2
|
|
2263
2635
|
# resp.import_jobs #=> Array
|
2264
2636
|
# resp.import_jobs[0].job_id #=> String
|
2265
2637
|
# resp.import_jobs[0].import_destination.suppression_list_destination.suppression_list_import_action #=> String, one of "DELETE", "PUT"
|
2638
|
+
# resp.import_jobs[0].import_destination.contact_list_destination.contact_list_name #=> String
|
2639
|
+
# resp.import_jobs[0].import_destination.contact_list_destination.contact_list_import_action #=> String, one of "DELETE", "PUT"
|
2266
2640
|
# resp.import_jobs[0].job_status #=> String, one of "CREATED", "PROCESSING", "COMPLETED", "FAILED"
|
2267
2641
|
# resp.import_jobs[0].created_timestamp #=> Time
|
2268
2642
|
# resp.next_token #=> String
|
@@ -2792,6 +3166,34 @@ module Aws::SESV2
|
|
2792
3166
|
req.send_request(options)
|
2793
3167
|
end
|
2794
3168
|
|
3169
|
+
# Used to associate a configuration set with an email identity.
|
3170
|
+
#
|
3171
|
+
# @option params [required, String] :email_identity
|
3172
|
+
# The email address or domain that you want to associate with a
|
3173
|
+
# configuration set.
|
3174
|
+
#
|
3175
|
+
# @option params [String] :configuration_set_name
|
3176
|
+
# The configuration set that you want to associate with an email
|
3177
|
+
# identity.
|
3178
|
+
#
|
3179
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
3180
|
+
#
|
3181
|
+
# @example Request syntax with placeholder values
|
3182
|
+
#
|
3183
|
+
# resp = client.put_email_identity_configuration_set_attributes({
|
3184
|
+
# email_identity: "Identity", # required
|
3185
|
+
# configuration_set_name: "ConfigurationSetName",
|
3186
|
+
# })
|
3187
|
+
#
|
3188
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/PutEmailIdentityConfigurationSetAttributes AWS API Documentation
|
3189
|
+
#
|
3190
|
+
# @overload put_email_identity_configuration_set_attributes(params = {})
|
3191
|
+
# @param [Hash] params ({})
|
3192
|
+
def put_email_identity_configuration_set_attributes(params = {}, options = {})
|
3193
|
+
req = build_request(:put_email_identity_configuration_set_attributes, params)
|
3194
|
+
req.send_request(options)
|
3195
|
+
end
|
3196
|
+
|
2795
3197
|
# Used to enable or disable DKIM authentication for an email identity.
|
2796
3198
|
#
|
2797
3199
|
# @option params [required, String] :email_identity
|
@@ -3293,6 +3695,10 @@ module Aws::SESV2
|
|
3293
3695
|
# The name of the configuration set that you want to use when sending
|
3294
3696
|
# the email.
|
3295
3697
|
#
|
3698
|
+
# @option params [Types::ListManagementOptions] :list_management_options
|
3699
|
+
# An object used to specify a list or topic to which an email belongs,
|
3700
|
+
# which will be used when a contact chooses to unsubscribe.
|
3701
|
+
#
|
3296
3702
|
# @return [Types::SendEmailResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3297
3703
|
#
|
3298
3704
|
# * {Types::SendEmailResponse#message_id #message_id} => String
|
@@ -3343,6 +3749,10 @@ module Aws::SESV2
|
|
3343
3749
|
# },
|
3344
3750
|
# ],
|
3345
3751
|
# configuration_set_name: "ConfigurationSetName",
|
3752
|
+
# list_management_options: {
|
3753
|
+
# contact_list_name: "ContactListName", # required
|
3754
|
+
# topic_name: "TopicName",
|
3755
|
+
# },
|
3346
3756
|
# })
|
3347
3757
|
#
|
3348
3758
|
# @example Response structure
|
@@ -3502,7 +3912,7 @@ module Aws::SESV2
|
|
3502
3912
|
# event_destination_name: "EventDestinationName", # required
|
3503
3913
|
# event_destination: { # required
|
3504
3914
|
# enabled: false,
|
3505
|
-
# matching_event_types: ["SEND"], # accepts SEND, REJECT, BOUNCE, COMPLAINT, DELIVERY, OPEN, CLICK, RENDERING_FAILURE, DELIVERY_DELAY
|
3915
|
+
# matching_event_types: ["SEND"], # accepts SEND, REJECT, BOUNCE, COMPLAINT, DELIVERY, OPEN, CLICK, RENDERING_FAILURE, DELIVERY_DELAY, SUBSCRIPTION
|
3506
3916
|
# kinesis_firehose_destination: {
|
3507
3917
|
# iam_role_arn: "AmazonResourceName", # required
|
3508
3918
|
# delivery_stream_arn: "AmazonResourceName", # required
|
@@ -3534,6 +3944,92 @@ module Aws::SESV2
|
|
3534
3944
|
req.send_request(options)
|
3535
3945
|
end
|
3536
3946
|
|
3947
|
+
# Updates a contact's preferences for a list. It is not necessary to
|
3948
|
+
# specify all existing topic preferences in the TopicPreferences object,
|
3949
|
+
# just the ones that need updating.
|
3950
|
+
#
|
3951
|
+
# @option params [required, String] :contact_list_name
|
3952
|
+
# The name of the contact list.
|
3953
|
+
#
|
3954
|
+
# @option params [required, String] :email_address
|
3955
|
+
# The contact's email addres.
|
3956
|
+
#
|
3957
|
+
# @option params [Array<Types::TopicPreference>] :topic_preferences
|
3958
|
+
# The contact's preference for being opted-in to or opted-out of a
|
3959
|
+
# topic.
|
3960
|
+
#
|
3961
|
+
# @option params [Boolean] :unsubscribe_all
|
3962
|
+
# A boolean value status noting if the contact is unsubscribed from all
|
3963
|
+
# contact list topics.
|
3964
|
+
#
|
3965
|
+
# @option params [String] :attributes_data
|
3966
|
+
# The attribute data attached to a contact.
|
3967
|
+
#
|
3968
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
3969
|
+
#
|
3970
|
+
# @example Request syntax with placeholder values
|
3971
|
+
#
|
3972
|
+
# resp = client.update_contact({
|
3973
|
+
# contact_list_name: "ContactListName", # required
|
3974
|
+
# email_address: "EmailAddress", # required
|
3975
|
+
# topic_preferences: [
|
3976
|
+
# {
|
3977
|
+
# topic_name: "TopicName", # required
|
3978
|
+
# subscription_status: "OPT_IN", # required, accepts OPT_IN, OPT_OUT
|
3979
|
+
# },
|
3980
|
+
# ],
|
3981
|
+
# unsubscribe_all: false,
|
3982
|
+
# attributes_data: "AttributesData",
|
3983
|
+
# })
|
3984
|
+
#
|
3985
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/UpdateContact AWS API Documentation
|
3986
|
+
#
|
3987
|
+
# @overload update_contact(params = {})
|
3988
|
+
# @param [Hash] params ({})
|
3989
|
+
def update_contact(params = {}, options = {})
|
3990
|
+
req = build_request(:update_contact, params)
|
3991
|
+
req.send_request(options)
|
3992
|
+
end
|
3993
|
+
|
3994
|
+
# Updates contact list metadata. This operation does a complete
|
3995
|
+
# replacement.
|
3996
|
+
#
|
3997
|
+
# @option params [required, String] :contact_list_name
|
3998
|
+
# The name of the contact list.
|
3999
|
+
#
|
4000
|
+
# @option params [Array<Types::Topic>] :topics
|
4001
|
+
# An interest group, theme, or label within a list. A contact list can
|
4002
|
+
# have multiple topics.
|
4003
|
+
#
|
4004
|
+
# @option params [String] :description
|
4005
|
+
# A description of what the contact list is about.
|
4006
|
+
#
|
4007
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
4008
|
+
#
|
4009
|
+
# @example Request syntax with placeholder values
|
4010
|
+
#
|
4011
|
+
# resp = client.update_contact_list({
|
4012
|
+
# contact_list_name: "ContactListName", # required
|
4013
|
+
# topics: [
|
4014
|
+
# {
|
4015
|
+
# topic_name: "TopicName", # required
|
4016
|
+
# display_name: "DisplayName", # required
|
4017
|
+
# description: "Description",
|
4018
|
+
# default_subscription_status: "OPT_IN", # required, accepts OPT_IN, OPT_OUT
|
4019
|
+
# },
|
4020
|
+
# ],
|
4021
|
+
# description: "Description",
|
4022
|
+
# })
|
4023
|
+
#
|
4024
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/UpdateContactList AWS API Documentation
|
4025
|
+
#
|
4026
|
+
# @overload update_contact_list(params = {})
|
4027
|
+
# @param [Hash] params ({})
|
4028
|
+
def update_contact_list(params = {}, options = {})
|
4029
|
+
req = build_request(:update_contact_list, params)
|
4030
|
+
req.send_request(options)
|
4031
|
+
end
|
4032
|
+
|
3537
4033
|
# Updates an existing custom verification email template.
|
3538
4034
|
#
|
3539
4035
|
# For more information about custom verification email templates, see
|
@@ -3706,7 +4202,7 @@ module Aws::SESV2
|
|
3706
4202
|
params: params,
|
3707
4203
|
config: config)
|
3708
4204
|
context[:gem_name] = 'aws-sdk-sesv2'
|
3709
|
-
context[:gem_version] = '1.
|
4205
|
+
context[:gem_version] = '1.16.0'
|
3710
4206
|
Seahorse::Client::Request.new(handlers, context)
|
3711
4207
|
end
|
3712
4208
|
|