aws-sdk-sesv2 1.17.0 → 1.21.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/CHANGELOG.md +20 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-sesv2/client.rb +119 -113
- data/lib/aws-sdk-sesv2/client_api.rb +7 -2
- data/lib/aws-sdk-sesv2/types.rb +226 -185
- data/lib/aws-sdk-sesv2.rb +1 -1
- metadata +8 -9
data/lib/aws-sdk-sesv2/client.rb
CHANGED
@@ -335,7 +335,9 @@ module Aws::SESV2
|
|
335
335
|
# configuration set are applied to the email.
|
336
336
|
#
|
337
337
|
# @option params [required, String] :configuration_set_name
|
338
|
-
# The name of the configuration set.
|
338
|
+
# The name of the configuration set. The name can contain up to 64
|
339
|
+
# alphanumeric characters, including letters, numbers, hyphens (-) and
|
340
|
+
# underscores (\_) only.
|
339
341
|
#
|
340
342
|
# @option params [Types::TrackingOptions] :tracking_options
|
341
343
|
# An object that defines the open and click tracking options for emails
|
@@ -354,8 +356,8 @@ module Aws::SESV2
|
|
354
356
|
# you send using the configuration set.
|
355
357
|
#
|
356
358
|
# @option params [Array<Types::Tag>] :tags
|
357
|
-
# An array of objects that define the tags (keys and values)
|
358
|
-
#
|
359
|
+
# An array of objects that define the tags (keys and values) to
|
360
|
+
# associate with the configuration set.
|
359
361
|
#
|
360
362
|
# @option params [Types::SuppressionOptions] :suppression_options
|
361
363
|
# An object that contains information about the suppression list
|
@@ -413,8 +415,7 @@ module Aws::SESV2
|
|
413
415
|
# destination.
|
414
416
|
#
|
415
417
|
# @option params [required, String] :configuration_set_name
|
416
|
-
# The name of the configuration set
|
417
|
-
# destination to.
|
418
|
+
# The name of the configuration set .
|
418
419
|
#
|
419
420
|
# @option params [required, String] :event_destination_name
|
420
421
|
# A name that identifies the event destination within the configuration
|
@@ -619,10 +620,10 @@ module Aws::SESV2
|
|
619
620
|
end
|
620
621
|
|
621
622
|
# Create a new pool of dedicated IP addresses. A pool can include one or
|
622
|
-
# more dedicated IP addresses that are associated with your
|
623
|
-
# You can associate a pool with a configuration set.
|
624
|
-
# email that uses that configuration set, the message
|
625
|
-
# of the addresses in the associated pool.
|
623
|
+
# more dedicated IP addresses that are associated with your Amazon Web
|
624
|
+
# Services account. You can associate a pool with a configuration set.
|
625
|
+
# When you send an email that uses that configuration set, the message
|
626
|
+
# is sent from one of the addresses in the associated pool.
|
626
627
|
#
|
627
628
|
# @option params [required, String] :pool_name
|
628
629
|
# The name of the dedicated IP pool.
|
@@ -763,8 +764,7 @@ module Aws::SESV2
|
|
763
764
|
# `CreateEmailIdentity` operation has to include the
|
764
765
|
# `DkimSigningAttributes` object. When you specify this object, you
|
765
766
|
# provide a selector (a component of the DNS record name that identifies
|
766
|
-
# the public key
|
767
|
-
# private key.
|
767
|
+
# the public key to use for DKIM authentication) and a private key.
|
768
768
|
#
|
769
769
|
# When you verify a domain, this operation provides a set of DKIM
|
770
770
|
# tokens, which you can convert into CNAME tokens. You add these CNAME
|
@@ -781,16 +781,16 @@ module Aws::SESV2
|
|
781
781
|
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/easy-dkim.html
|
782
782
|
#
|
783
783
|
# @option params [required, String] :email_identity
|
784
|
-
# The email address or domain
|
784
|
+
# The email address or domain to verify.
|
785
785
|
#
|
786
786
|
# @option params [Array<Types::Tag>] :tags
|
787
|
-
# An array of objects that define the tags (keys and values)
|
788
|
-
#
|
787
|
+
# An array of objects that define the tags (keys and values) to
|
788
|
+
# associate with the email identity.
|
789
789
|
#
|
790
790
|
# @option params [Types::DkimSigningAttributes] :dkim_signing_attributes
|
791
791
|
# If your request includes this object, Amazon SES configures the
|
792
792
|
# identity to use Bring Your Own DKIM (BYODKIM) for DKIM authentication
|
793
|
-
# purposes,
|
793
|
+
# purposes, or, configures the key length to be used for [Easy DKIM][1].
|
794
794
|
#
|
795
795
|
# You can only specify this object if the email identity is a domain, as
|
796
796
|
# opposed to an address.
|
@@ -821,8 +821,9 @@ module Aws::SESV2
|
|
821
821
|
# },
|
822
822
|
# ],
|
823
823
|
# dkim_signing_attributes: {
|
824
|
-
# domain_signing_selector: "Selector",
|
825
|
-
# domain_signing_private_key: "PrivateKey",
|
824
|
+
# domain_signing_selector: "Selector",
|
825
|
+
# domain_signing_private_key: "PrivateKey",
|
826
|
+
# next_signing_key_length: "RSA_1024_BIT", # accepts RSA_1024_BIT, RSA_2048_BIT
|
826
827
|
# },
|
827
828
|
# configuration_set_name: "ConfigurationSetName",
|
828
829
|
# })
|
@@ -836,6 +837,9 @@ module Aws::SESV2
|
|
836
837
|
# resp.dkim_attributes.tokens #=> Array
|
837
838
|
# resp.dkim_attributes.tokens[0] #=> String
|
838
839
|
# resp.dkim_attributes.signing_attributes_origin #=> String, one of "AWS_SES", "EXTERNAL"
|
840
|
+
# resp.dkim_attributes.next_signing_key_length #=> String, one of "RSA_1024_BIT", "RSA_2048_BIT"
|
841
|
+
# resp.dkim_attributes.current_signing_key_length #=> String, one of "RSA_1024_BIT", "RSA_2048_BIT"
|
842
|
+
# resp.dkim_attributes.last_key_generation_timestamp #=> Time
|
839
843
|
#
|
840
844
|
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/CreateEmailIdentity AWS API Documentation
|
841
845
|
#
|
@@ -865,7 +869,7 @@ module Aws::SESV2
|
|
865
869
|
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html
|
866
870
|
#
|
867
871
|
# @option params [required, String] :email_identity
|
868
|
-
# The email identity
|
872
|
+
# The email identity.
|
869
873
|
#
|
870
874
|
# @option params [required, String] :policy_name
|
871
875
|
# The name of the policy.
|
@@ -914,7 +918,7 @@ module Aws::SESV2
|
|
914
918
|
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-personalized-email-api.html
|
915
919
|
#
|
916
920
|
# @option params [required, String] :template_name
|
917
|
-
# The name of the template
|
921
|
+
# The name of the template.
|
918
922
|
#
|
919
923
|
# @option params [required, Types::EmailTemplateContent] :template_content
|
920
924
|
# The content of the email template, composed of a subject line, an HTML
|
@@ -994,7 +998,7 @@ module Aws::SESV2
|
|
994
998
|
# rules in that configuration set are applied to the email.
|
995
999
|
#
|
996
1000
|
# @option params [required, String] :configuration_set_name
|
997
|
-
# The name of the configuration set
|
1001
|
+
# The name of the configuration set.
|
998
1002
|
#
|
999
1003
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1000
1004
|
#
|
@@ -1024,10 +1028,10 @@ module Aws::SESV2
|
|
1024
1028
|
#
|
1025
1029
|
# @option params [required, String] :configuration_set_name
|
1026
1030
|
# The name of the configuration set that contains the event destination
|
1027
|
-
#
|
1031
|
+
# to delete.
|
1028
1032
|
#
|
1029
1033
|
# @option params [required, String] :event_destination_name
|
1030
|
-
# The name of the event destination
|
1034
|
+
# The name of the event destination to delete.
|
1031
1035
|
#
|
1032
1036
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1033
1037
|
#
|
@@ -1105,7 +1109,7 @@ module Aws::SESV2
|
|
1105
1109
|
#
|
1106
1110
|
#
|
1107
1111
|
#
|
1108
|
-
# [1]: https://docs.aws.amazon.com/
|
1112
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-email-verify-address-custom.html
|
1109
1113
|
#
|
1110
1114
|
# @option params [required, String] :template_name
|
1111
1115
|
# The name of the custom verification email template that you want to
|
@@ -1154,8 +1158,7 @@ module Aws::SESV2
|
|
1154
1158
|
# or a domain name.
|
1155
1159
|
#
|
1156
1160
|
# @option params [required, String] :email_identity
|
1157
|
-
# The identity (that is, the email address or domain)
|
1158
|
-
# delete.
|
1161
|
+
# The identity (that is, the email address or domain) to delete.
|
1159
1162
|
#
|
1160
1163
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1161
1164
|
#
|
@@ -1194,7 +1197,7 @@ module Aws::SESV2
|
|
1194
1197
|
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html
|
1195
1198
|
#
|
1196
1199
|
# @option params [required, String] :email_identity
|
1197
|
-
# The email identity
|
1200
|
+
# The email identity.
|
1198
1201
|
#
|
1199
1202
|
# @option params [required, String] :policy_name
|
1200
1203
|
# The name of the policy.
|
@@ -1268,7 +1271,7 @@ module Aws::SESV2
|
|
1268
1271
|
end
|
1269
1272
|
|
1270
1273
|
# Obtain information about the email-sending status and capabilities of
|
1271
|
-
# your Amazon SES account in the current
|
1274
|
+
# your Amazon SES account in the current Amazon Web Services Region.
|
1272
1275
|
#
|
1273
1276
|
# @return [Types::GetAccountResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1274
1277
|
#
|
@@ -1355,8 +1358,7 @@ module Aws::SESV2
|
|
1355
1358
|
# rules in that configuration set are applied to the email.
|
1356
1359
|
#
|
1357
1360
|
# @option params [required, String] :configuration_set_name
|
1358
|
-
# The name of the configuration set
|
1359
|
-
# information about.
|
1361
|
+
# The name of the configuration set.
|
1360
1362
|
#
|
1361
1363
|
# @return [Types::GetConfigurationSetResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1362
1364
|
#
|
@@ -1598,7 +1600,7 @@ module Aws::SESV2
|
|
1598
1600
|
# @option params [required, String] :ip
|
1599
1601
|
# The IP address that you want to obtain more information about. The
|
1600
1602
|
# value you specify has to be a dedicated IP address that's assocaited
|
1601
|
-
# with your
|
1603
|
+
# with your Amazon Web Services account.
|
1602
1604
|
#
|
1603
1605
|
# @return [Types::GetDedicatedIpResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1604
1606
|
#
|
@@ -1626,8 +1628,8 @@ module Aws::SESV2
|
|
1626
1628
|
req.send_request(options)
|
1627
1629
|
end
|
1628
1630
|
|
1629
|
-
# List the dedicated IP addresses that are associated with your
|
1630
|
-
# account.
|
1631
|
+
# List the dedicated IP addresses that are associated with your Amazon
|
1632
|
+
# Web Services account.
|
1631
1633
|
#
|
1632
1634
|
# @option params [String] :pool_name
|
1633
1635
|
# The name of the IP pool that the dedicated IP address is associated
|
@@ -1684,9 +1686,9 @@ module Aws::SESV2
|
|
1684
1686
|
#
|
1685
1687
|
# When you use the Deliverability dashboard, you pay a monthly
|
1686
1688
|
# subscription charge, in addition to any other fees that you accrue by
|
1687
|
-
# using Amazon SES and other
|
1688
|
-
# the features and cost of a Deliverability dashboard
|
1689
|
-
# [Amazon SES Pricing][1].
|
1689
|
+
# using Amazon SES and other Amazon Web Services services. For more
|
1690
|
+
# information about the features and cost of a Deliverability dashboard
|
1691
|
+
# subscription, see [Amazon SES Pricing][1].
|
1690
1692
|
#
|
1691
1693
|
#
|
1692
1694
|
#
|
@@ -1894,7 +1896,7 @@ module Aws::SESV2
|
|
1894
1896
|
# DKIM authentication status, and its custom Mail-From settings.
|
1895
1897
|
#
|
1896
1898
|
# @option params [required, String] :email_identity
|
1897
|
-
# The email identity
|
1899
|
+
# The email identity.
|
1898
1900
|
#
|
1899
1901
|
# @return [Types::GetEmailIdentityResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1900
1902
|
#
|
@@ -1923,6 +1925,9 @@ module Aws::SESV2
|
|
1923
1925
|
# resp.dkim_attributes.tokens #=> Array
|
1924
1926
|
# resp.dkim_attributes.tokens[0] #=> String
|
1925
1927
|
# resp.dkim_attributes.signing_attributes_origin #=> String, one of "AWS_SES", "EXTERNAL"
|
1928
|
+
# resp.dkim_attributes.next_signing_key_length #=> String, one of "RSA_1024_BIT", "RSA_2048_BIT"
|
1929
|
+
# resp.dkim_attributes.current_signing_key_length #=> String, one of "RSA_1024_BIT", "RSA_2048_BIT"
|
1930
|
+
# resp.dkim_attributes.last_key_generation_timestamp #=> Time
|
1926
1931
|
# resp.mail_from_attributes.mail_from_domain #=> String
|
1927
1932
|
# resp.mail_from_attributes.mail_from_domain_status #=> String, one of "PENDING", "SUCCESS", "FAILED", "TEMPORARY_FAILURE"
|
1928
1933
|
# resp.mail_from_attributes.behavior_on_mx_failure #=> String, one of "USE_DEFAULT_VALUE", "REJECT_MESSAGE"
|
@@ -1963,7 +1968,7 @@ module Aws::SESV2
|
|
1963
1968
|
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html
|
1964
1969
|
#
|
1965
1970
|
# @option params [required, String] :email_identity
|
1966
|
-
# The email identity
|
1971
|
+
# The email identity.
|
1967
1972
|
#
|
1968
1973
|
# @return [Types::GetEmailIdentityPoliciesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1969
1974
|
#
|
@@ -1995,7 +2000,7 @@ module Aws::SESV2
|
|
1995
2000
|
# You can execute this operation no more than once per second.
|
1996
2001
|
#
|
1997
2002
|
# @option params [required, String] :template_name
|
1998
|
-
# The name of the template
|
2003
|
+
# The name of the template.
|
1999
2004
|
#
|
2000
2005
|
# @return [Types::GetEmailTemplateResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2001
2006
|
#
|
@@ -2266,7 +2271,7 @@ module Aws::SESV2
|
|
2266
2271
|
end
|
2267
2272
|
|
2268
2273
|
# Lists the existing custom verification email templates for your
|
2269
|
-
# account in the current
|
2274
|
+
# account in the current Amazon Web Services Region.
|
2270
2275
|
#
|
2271
2276
|
# For more information about custom verification email templates, see
|
2272
2277
|
# [Using Custom Verification Email Templates][1] in the *Amazon SES
|
@@ -2326,8 +2331,8 @@ module Aws::SESV2
|
|
2326
2331
|
req.send_request(options)
|
2327
2332
|
end
|
2328
2333
|
|
2329
|
-
# List all of the dedicated IP pools that exist in your
|
2330
|
-
# the current Region.
|
2334
|
+
# List all of the dedicated IP pools that exist in your Amazon Web
|
2335
|
+
# Services account in the current Region.
|
2331
2336
|
#
|
2332
2337
|
# @option params [String] :next_token
|
2333
2338
|
# A token returned from a previous call to `ListDedicatedIpPools` to
|
@@ -2499,10 +2504,10 @@ module Aws::SESV2
|
|
2499
2504
|
end
|
2500
2505
|
|
2501
2506
|
# Returns a list of all of the email identities that are associated with
|
2502
|
-
# your
|
2503
|
-
# domain. This operation returns identities that are
|
2504
|
-
# those that aren't. This operation returns
|
2505
|
-
# associated with Amazon SES and Amazon Pinpoint.
|
2507
|
+
# your Amazon Web Services account. An identity can be either an email
|
2508
|
+
# address or a domain. This operation returns identities that are
|
2509
|
+
# verified as well as those that aren't. This operation returns
|
2510
|
+
# identities that are associated with Amazon SES and Amazon Pinpoint.
|
2506
2511
|
#
|
2507
2512
|
# @option params [String] :next_token
|
2508
2513
|
# A token returned from a previous call to `ListEmailIdentities` to
|
@@ -2549,7 +2554,7 @@ module Aws::SESV2
|
|
2549
2554
|
end
|
2550
2555
|
|
2551
2556
|
# Lists the email templates present in your Amazon SES account in the
|
2552
|
-
# current
|
2557
|
+
# current Amazon Web Services Region.
|
2553
2558
|
#
|
2554
2559
|
# You can execute this operation no more than once per second.
|
2555
2560
|
#
|
@@ -2752,8 +2757,8 @@ module Aws::SESV2
|
|
2752
2757
|
# @option params [Boolean] :auto_warmup_enabled
|
2753
2758
|
# Enables or disables the automatic warm-up feature for dedicated IP
|
2754
2759
|
# addresses that are associated with your Amazon SES account in the
|
2755
|
-
# current
|
2756
|
-
# feature, or set to `false` to disable it.
|
2760
|
+
# current Amazon Web Services Region. Set to `true` to enable the
|
2761
|
+
# automatic warm-up feature, or set to `false` to disable it.
|
2757
2762
|
#
|
2758
2763
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2759
2764
|
#
|
@@ -2793,7 +2798,7 @@ module Aws::SESV2
|
|
2793
2798
|
#
|
2794
2799
|
# @option params [Boolean] :production_access_enabled
|
2795
2800
|
# Indicates whether or not your account should have production access in
|
2796
|
-
# the current
|
2801
|
+
# the current Amazon Web Services Region.
|
2797
2802
|
#
|
2798
2803
|
# If the value is `false`, then your account is in the *sandbox*. When
|
2799
2804
|
# your account is in the sandbox, you can only send email to verified
|
@@ -2835,8 +2840,9 @@ module Aws::SESV2
|
|
2835
2840
|
# `true` to enable email sending, or set to `false` to disable email
|
2836
2841
|
# sending.
|
2837
2842
|
#
|
2838
|
-
# <note markdown="1"> If
|
2839
|
-
# this operation to resume your account's ability to
|
2843
|
+
# <note markdown="1"> If Amazon Web Services paused your account's ability to send email,
|
2844
|
+
# you can't use this operation to resume your account's ability to
|
2845
|
+
# send email.
|
2840
2846
|
#
|
2841
2847
|
# </note>
|
2842
2848
|
#
|
@@ -2894,8 +2900,8 @@ module Aws::SESV2
|
|
2894
2900
|
# sending specific types of email.
|
2895
2901
|
#
|
2896
2902
|
# @option params [required, String] :configuration_set_name
|
2897
|
-
# The name of the configuration set
|
2898
|
-
#
|
2903
|
+
# The name of the configuration set to associate with a dedicated IP
|
2904
|
+
# pool.
|
2899
2905
|
#
|
2900
2906
|
# @option params [String] :tls_policy
|
2901
2907
|
# Specifies whether messages that use the configuration set are required
|
@@ -2905,8 +2911,8 @@ module Aws::SESV2
|
|
2905
2911
|
# TLS connection can't be established.
|
2906
2912
|
#
|
2907
2913
|
# @option params [String] :sending_pool_name
|
2908
|
-
# The name of the dedicated IP pool
|
2909
|
-
#
|
2914
|
+
# The name of the dedicated IP pool to associate with the configuration
|
2915
|
+
# set.
|
2910
2916
|
#
|
2911
2917
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2912
2918
|
#
|
@@ -2928,11 +2934,11 @@ module Aws::SESV2
|
|
2928
2934
|
end
|
2929
2935
|
|
2930
2936
|
# Enable or disable collection of reputation metrics for emails that you
|
2931
|
-
# send using a particular configuration set in a specific
|
2937
|
+
# send using a particular configuration set in a specific Amazon Web
|
2938
|
+
# Services Region.
|
2932
2939
|
#
|
2933
2940
|
# @option params [required, String] :configuration_set_name
|
2934
|
-
# The name of the configuration set
|
2935
|
-
# reputation metric tracking for.
|
2941
|
+
# The name of the configuration set.
|
2936
2942
|
#
|
2937
2943
|
# @option params [Boolean] :reputation_metrics_enabled
|
2938
2944
|
# If `true`, tracking of reputation metrics is enabled for the
|
@@ -2958,11 +2964,11 @@ module Aws::SESV2
|
|
2958
2964
|
end
|
2959
2965
|
|
2960
2966
|
# Enable or disable email sending for messages that use a particular
|
2961
|
-
# configuration set in a specific
|
2967
|
+
# configuration set in a specific Amazon Web Services Region.
|
2962
2968
|
#
|
2963
2969
|
# @option params [required, String] :configuration_set_name
|
2964
|
-
# The name of the configuration set
|
2965
|
-
#
|
2970
|
+
# The name of the configuration set to enable or disable email sending
|
2971
|
+
# for.
|
2966
2972
|
#
|
2967
2973
|
# @option params [Boolean] :sending_enabled
|
2968
2974
|
# If `true`, email sending is enabled for the configuration set. If
|
@@ -2990,8 +2996,8 @@ module Aws::SESV2
|
|
2990
2996
|
# set.
|
2991
2997
|
#
|
2992
2998
|
# @option params [required, String] :configuration_set_name
|
2993
|
-
# The name of the configuration set
|
2994
|
-
#
|
2999
|
+
# The name of the configuration set to change the suppression list
|
3000
|
+
# preferences for.
|
2995
3001
|
#
|
2996
3002
|
# @option params [Array<String>] :suppressed_reasons
|
2997
3003
|
# A list that contains the reasons that email addresses are
|
@@ -3028,11 +3034,10 @@ module Aws::SESV2
|
|
3028
3034
|
# email that you send.
|
3029
3035
|
#
|
3030
3036
|
# @option params [required, String] :configuration_set_name
|
3031
|
-
# The name of the configuration set
|
3032
|
-
# tracking domain to.
|
3037
|
+
# The name of the configuration set.
|
3033
3038
|
#
|
3034
3039
|
# @option params [String] :custom_redirect_domain
|
3035
|
-
# The domain
|
3040
|
+
# The domain to use to track open and click events.
|
3036
3041
|
#
|
3037
3042
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
3038
3043
|
#
|
@@ -3055,7 +3060,7 @@ module Aws::SESV2
|
|
3055
3060
|
# Move a dedicated IP address to an existing dedicated IP pool.
|
3056
3061
|
#
|
3057
3062
|
# <note markdown="1"> The dedicated IP address that you specify must already exist, and must
|
3058
|
-
# be associated with your
|
3063
|
+
# be associated with your Amazon Web Services account.
|
3059
3064
|
#
|
3060
3065
|
# The dedicated IP pool you specify must already exist. You can create a
|
3061
3066
|
# new pool by using the `CreateDedicatedIpPool` operation.
|
@@ -3065,7 +3070,7 @@ module Aws::SESV2
|
|
3065
3070
|
# @option params [required, String] :ip
|
3066
3071
|
# The IP address that you want to move to the dedicated IP pool. The
|
3067
3072
|
# value you specify has to be a dedicated IP address that's associated
|
3068
|
-
# with your
|
3073
|
+
# with your Amazon Web Services account.
|
3069
3074
|
#
|
3070
3075
|
# @option params [required, String] :destination_pool_name
|
3071
3076
|
# The name of the IP pool that you want to add the dedicated IP address
|
@@ -3123,9 +3128,9 @@ module Aws::SESV2
|
|
3123
3128
|
#
|
3124
3129
|
# When you use the Deliverability dashboard, you pay a monthly
|
3125
3130
|
# subscription charge, in addition to any other fees that you accrue by
|
3126
|
-
# using Amazon SES and other
|
3127
|
-
# the features and cost of a Deliverability dashboard
|
3128
|
-
# [Amazon SES Pricing][1].
|
3131
|
+
# using Amazon SES and other Amazon Web Services services. For more
|
3132
|
+
# information about the features and cost of a Deliverability dashboard
|
3133
|
+
# subscription, see [Amazon SES Pricing][1].
|
3129
3134
|
#
|
3130
3135
|
#
|
3131
3136
|
#
|
@@ -3169,12 +3174,10 @@ module Aws::SESV2
|
|
3169
3174
|
# Used to associate a configuration set with an email identity.
|
3170
3175
|
#
|
3171
3176
|
# @option params [required, String] :email_identity
|
3172
|
-
# The email address or domain
|
3173
|
-
# configuration set.
|
3177
|
+
# The email address or domain to associate with a configuration set.
|
3174
3178
|
#
|
3175
3179
|
# @option params [String] :configuration_set_name
|
3176
|
-
# The configuration set
|
3177
|
-
# identity.
|
3180
|
+
# The configuration set to associate with an email identity.
|
3178
3181
|
#
|
3179
3182
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
3180
3183
|
#
|
@@ -3197,7 +3200,7 @@ module Aws::SESV2
|
|
3197
3200
|
# Used to enable or disable DKIM authentication for an email identity.
|
3198
3201
|
#
|
3199
3202
|
# @option params [required, String] :email_identity
|
3200
|
-
# The email identity
|
3203
|
+
# The email identity.
|
3201
3204
|
#
|
3202
3205
|
# @option params [Boolean] :signing_enabled
|
3203
3206
|
# Sets the DKIM signing configuration for the identity.
|
@@ -3231,6 +3234,8 @@ module Aws::SESV2
|
|
3231
3234
|
# * Update the signing attributes for an identity that uses Bring Your
|
3232
3235
|
# Own DKIM (BYODKIM).
|
3233
3236
|
#
|
3237
|
+
# * Update the key length that should be used for Easy DKIM.
|
3238
|
+
#
|
3234
3239
|
# * Change from using no DKIM authentication to using Easy DKIM.
|
3235
3240
|
#
|
3236
3241
|
# * Change from using no DKIM authentication to using BYODKIM.
|
@@ -3240,11 +3245,11 @@ module Aws::SESV2
|
|
3240
3245
|
# * Change from using BYODKIM to using Easy DKIM.
|
3241
3246
|
#
|
3242
3247
|
# @option params [required, String] :email_identity
|
3243
|
-
# The email identity
|
3248
|
+
# The email identity.
|
3244
3249
|
#
|
3245
3250
|
# @option params [required, String] :signing_attributes_origin
|
3246
|
-
# The method
|
3247
|
-
#
|
3251
|
+
# The method to use to configure DKIM for the identity. There are the
|
3252
|
+
# following possible values:
|
3248
3253
|
#
|
3249
3254
|
# * `AWS_SES` – Configure DKIM for the identity by using [Easy DKIM][1].
|
3250
3255
|
#
|
@@ -3257,9 +3262,13 @@ module Aws::SESV2
|
|
3257
3262
|
#
|
3258
3263
|
# @option params [Types::DkimSigningAttributes] :signing_attributes
|
3259
3264
|
# An object that contains information about the private key and selector
|
3260
|
-
# that you want to use to configure DKIM for the identity
|
3261
|
-
#
|
3262
|
-
#
|
3265
|
+
# that you want to use to configure DKIM for the identity for Bring Your
|
3266
|
+
# Own DKIM (BYODKIM) for the identity, or, configures the key length to
|
3267
|
+
# be used for [Easy DKIM][1].
|
3268
|
+
#
|
3269
|
+
#
|
3270
|
+
#
|
3271
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/easy-dkim.html
|
3263
3272
|
#
|
3264
3273
|
# @return [Types::PutEmailIdentityDkimSigningAttributesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3265
3274
|
#
|
@@ -3272,8 +3281,9 @@ module Aws::SESV2
|
|
3272
3281
|
# email_identity: "Identity", # required
|
3273
3282
|
# signing_attributes_origin: "AWS_SES", # required, accepts AWS_SES, EXTERNAL
|
3274
3283
|
# signing_attributes: {
|
3275
|
-
# domain_signing_selector: "Selector",
|
3276
|
-
# domain_signing_private_key: "PrivateKey",
|
3284
|
+
# domain_signing_selector: "Selector",
|
3285
|
+
# domain_signing_private_key: "PrivateKey",
|
3286
|
+
# next_signing_key_length: "RSA_1024_BIT", # accepts RSA_1024_BIT, RSA_2048_BIT
|
3277
3287
|
# },
|
3278
3288
|
# })
|
3279
3289
|
#
|
@@ -3307,8 +3317,7 @@ module Aws::SESV2
|
|
3307
3317
|
# occur (even if this setting is disabled).
|
3308
3318
|
#
|
3309
3319
|
# @option params [required, String] :email_identity
|
3310
|
-
# The email identity
|
3311
|
-
# feedback forwarding for.
|
3320
|
+
# The email identity.
|
3312
3321
|
#
|
3313
3322
|
# @option params [Boolean] :email_forwarding_enabled
|
3314
3323
|
# Sets the feedback forwarding configuration for the identity.
|
@@ -3345,8 +3354,7 @@ module Aws::SESV2
|
|
3345
3354
|
# for an email identity.
|
3346
3355
|
#
|
3347
3356
|
# @option params [required, String] :email_identity
|
3348
|
-
# The verified email identity
|
3349
|
-
# FROM domain for.
|
3357
|
+
# The verified email identity.
|
3350
3358
|
#
|
3351
3359
|
# @option params [String] :mail_from_domain
|
3352
3360
|
# The custom MAIL FROM domain that you want the verified identity to
|
@@ -3360,12 +3368,12 @@ module Aws::SESV2
|
|
3360
3368
|
# destination for feedback forwarding emails.
|
3361
3369
|
#
|
3362
3370
|
# @option params [String] :behavior_on_mx_failure
|
3363
|
-
# The action
|
3364
|
-
#
|
3365
|
-
#
|
3366
|
-
#
|
3367
|
-
#
|
3368
|
-
#
|
3371
|
+
# The action to take if the required MX record isn't found when you
|
3372
|
+
# send an email. When you set this value to `UseDefaultValue`, the mail
|
3373
|
+
# is sent using *amazonses.com* as the MAIL FROM domain. When you set
|
3374
|
+
# this value to `RejectMessage`, the Amazon SES API v2 returns a
|
3375
|
+
# `MailFromDomainNotVerified` error, and doesn't attempt to deliver the
|
3376
|
+
# email.
|
3369
3377
|
#
|
3370
3378
|
# These behaviors are taken when the custom MAIL FROM domain
|
3371
3379
|
# configuration is in the `Pending`, `Failed`, and `TemporaryFailure`
|
@@ -3421,8 +3429,8 @@ module Aws::SESV2
|
|
3421
3429
|
# Composes an email message to multiple destinations.
|
3422
3430
|
#
|
3423
3431
|
# @option params [String] :from_email_address
|
3424
|
-
# The email address
|
3425
|
-
#
|
3432
|
+
# The email address to use as the "From" address for the email. The
|
3433
|
+
# address that you specify has to be verified.
|
3426
3434
|
#
|
3427
3435
|
# @option params [String] :from_email_address_identity_arn
|
3428
3436
|
# This parameter is used only for sending authorization. It is the ARN
|
@@ -3486,8 +3494,7 @@ module Aws::SESV2
|
|
3486
3494
|
# The list of bulk email entry objects.
|
3487
3495
|
#
|
3488
3496
|
# @option params [String] :configuration_set_name
|
3489
|
-
# The name of the configuration set
|
3490
|
-
# the email.
|
3497
|
+
# The name of the configuration set to use when sending the email.
|
3491
3498
|
#
|
3492
3499
|
# @return [Types::SendBulkEmailResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3493
3500
|
#
|
@@ -3554,9 +3561,9 @@ module Aws::SESV2
|
|
3554
3561
|
end
|
3555
3562
|
|
3556
3563
|
# Adds an email address to the list of identities for your Amazon SES
|
3557
|
-
# account in the current
|
3558
|
-
# result of executing this operation, a customized
|
3559
|
-
# sent to the specified address.
|
3564
|
+
# account in the current Amazon Web Services Region and attempts to
|
3565
|
+
# verify it. As a result of executing this operation, a customized
|
3566
|
+
# verification email is sent to the specified address.
|
3560
3567
|
#
|
3561
3568
|
# To use this operation, you must first create a custom verification
|
3562
3569
|
# email template. For more information about creating and using custom
|
@@ -3605,8 +3612,8 @@ module Aws::SESV2
|
|
3605
3612
|
req.send_request(options)
|
3606
3613
|
end
|
3607
3614
|
|
3608
|
-
# Sends an email message. You can use the Amazon SES API v2 to send
|
3609
|
-
# types of messages:
|
3615
|
+
# Sends an email message. You can use the Amazon SES API v2 to send the
|
3616
|
+
# following types of messages:
|
3610
3617
|
#
|
3611
3618
|
# * **Simple** – A standard email message. When you create this type of
|
3612
3619
|
# message, you specify the sender, the recipient, and the message
|
@@ -3623,8 +3630,8 @@ module Aws::SESV2
|
|
3623
3630
|
# replaces the tags with values that you specify.
|
3624
3631
|
#
|
3625
3632
|
# @option params [String] :from_email_address
|
3626
|
-
# The email address
|
3627
|
-
#
|
3633
|
+
# The email address to use as the "From" address for the email. The
|
3634
|
+
# address that you specify has to be verified.
|
3628
3635
|
#
|
3629
3636
|
# @option params [String] :from_email_address_identity_arn
|
3630
3637
|
# This parameter is used only for sending authorization. It is the ARN
|
@@ -3692,8 +3699,7 @@ module Aws::SESV2
|
|
3692
3699
|
# email sending events.
|
3693
3700
|
#
|
3694
3701
|
# @option params [String] :configuration_set_name
|
3695
|
-
# The name of the configuration set
|
3696
|
-
# the email.
|
3702
|
+
# The name of the configuration set to use when sending the email.
|
3697
3703
|
#
|
3698
3704
|
# @option params [Types::ListManagementOptions] :list_management_options
|
3699
3705
|
# An object used to specify a list or topic to which an email belongs,
|
@@ -3818,7 +3824,7 @@ module Aws::SESV2
|
|
3818
3824
|
# You can execute this operation no more than once per second.
|
3819
3825
|
#
|
3820
3826
|
# @option params [required, String] :template_name
|
3821
|
-
# The name of the template
|
3827
|
+
# The name of the template.
|
3822
3828
|
#
|
3823
3829
|
# @option params [required, String] :template_data
|
3824
3830
|
# A list of replacement values to apply to the template. This parameter
|
@@ -3895,10 +3901,10 @@ module Aws::SESV2
|
|
3895
3901
|
#
|
3896
3902
|
# @option params [required, String] :configuration_set_name
|
3897
3903
|
# The name of the configuration set that contains the event destination
|
3898
|
-
#
|
3904
|
+
# to modify.
|
3899
3905
|
#
|
3900
3906
|
# @option params [required, String] :event_destination_name
|
3901
|
-
# The name of the event destination
|
3907
|
+
# The name of the event destination.
|
3902
3908
|
#
|
3903
3909
|
# @option params [required, Types::EventDestinationDefinition] :event_destination
|
3904
3910
|
# An object that defines the event destination.
|
@@ -4112,7 +4118,7 @@ module Aws::SESV2
|
|
4112
4118
|
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html
|
4113
4119
|
#
|
4114
4120
|
# @option params [required, String] :email_identity
|
4115
|
-
# The email identity
|
4121
|
+
# The email identity.
|
4116
4122
|
#
|
4117
4123
|
# @option params [required, String] :policy_name
|
4118
4124
|
# The name of the policy.
|
@@ -4161,7 +4167,7 @@ module Aws::SESV2
|
|
4161
4167
|
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-personalized-email-api.html
|
4162
4168
|
#
|
4163
4169
|
# @option params [required, String] :template_name
|
4164
|
-
# The name of the template
|
4170
|
+
# The name of the template.
|
4165
4171
|
#
|
4166
4172
|
# @option params [required, Types::EmailTemplateContent] :template_content
|
4167
4173
|
# The content of the email template, composed of a subject line, an HTML
|
@@ -4202,7 +4208,7 @@ module Aws::SESV2
|
|
4202
4208
|
params: params,
|
4203
4209
|
config: config)
|
4204
4210
|
context[:gem_name] = 'aws-sdk-sesv2'
|
4205
|
-
context[:gem_version] = '1.
|
4211
|
+
context[:gem_version] = '1.21.0'
|
4206
4212
|
Seahorse::Client::Request.new(handlers, context)
|
4207
4213
|
end
|
4208
4214
|
|