aws-sdk-sesv2 1.5.0 → 1.10.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/lib/aws-sdk-sesv2.rb +3 -1
- data/lib/aws-sdk-sesv2/client.rb +1174 -29
- data/lib/aws-sdk-sesv2/client_api.rb +620 -5
- data/lib/aws-sdk-sesv2/errors.rb +13 -0
- data/lib/aws-sdk-sesv2/resource.rb +2 -0
- data/lib/aws-sdk-sesv2/types.rb +1997 -42
- 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: 41ba84c1073f0ac30e1bca3bf6d99b93ba8c04d4cd9fdb3799baf480e940bd0c
|
4
|
+
data.tar.gz: ba9d305f6fb12740bb2551f22ae005e800421c5b9d1ad49bcb03328656c60c29
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 322da1d03ced2f98ea8381fc9c6ca9e8e291370a502ffc9d3c61ca5f7614d47cfdeaed65eea0436f401339459de7509e1a1be4740d951010299929d89cd26894
|
7
|
+
data.tar.gz: ed20ce195dcac19f8dad75062a74364c148dc414183ed4969fc9fc1d7685510e0f2a2926f73623ceaccf5b24fceef8275151b003705836dd32c46d16c3ea08f5
|
data/lib/aws-sdk-sesv2.rb
CHANGED
@@ -1,3 +1,5 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
1
3
|
# WARNING ABOUT GENERATED CODE
|
2
4
|
#
|
3
5
|
# This file is generated. See the contributing guide for more information:
|
@@ -45,6 +47,6 @@ require_relative 'aws-sdk-sesv2/customizations'
|
|
45
47
|
# @service
|
46
48
|
module Aws::SESV2
|
47
49
|
|
48
|
-
GEM_VERSION = '1.
|
50
|
+
GEM_VERSION = '1.10.0'
|
49
51
|
|
50
52
|
end
|
data/lib/aws-sdk-sesv2/client.rb
CHANGED
@@ -1,3 +1,5 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
1
3
|
# WARNING ABOUT GENERATED CODE
|
2
4
|
#
|
3
5
|
# This file is generated. See the contributing guide for more information:
|
@@ -24,6 +26,7 @@ require 'aws-sdk-core/plugins/jsonvalue_converter.rb'
|
|
24
26
|
require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
|
25
27
|
require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
|
26
28
|
require 'aws-sdk-core/plugins/transfer_encoding.rb'
|
29
|
+
require 'aws-sdk-core/plugins/http_checksum.rb'
|
27
30
|
require 'aws-sdk-core/plugins/signature_v4.rb'
|
28
31
|
require 'aws-sdk-core/plugins/protocols/rest_json.rb'
|
29
32
|
|
@@ -69,6 +72,7 @@ module Aws::SESV2
|
|
69
72
|
add_plugin(Aws::Plugins::ClientMetricsPlugin)
|
70
73
|
add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
|
71
74
|
add_plugin(Aws::Plugins::TransferEncoding)
|
75
|
+
add_plugin(Aws::Plugins::HttpChecksum)
|
72
76
|
add_plugin(Aws::Plugins::SignatureV4)
|
73
77
|
add_plugin(Aws::Plugins::Protocols::RestJson)
|
74
78
|
|
@@ -161,7 +165,7 @@ module Aws::SESV2
|
|
161
165
|
# @option options [String] :endpoint
|
162
166
|
# The client endpoint is normally constructed from the `:region`
|
163
167
|
# option. You should only configure an `:endpoint` when connecting
|
164
|
-
# to test endpoints. This should be a valid HTTP(S) URI.
|
168
|
+
# to test or custom endpoints. This should be a valid HTTP(S) URI.
|
165
169
|
#
|
166
170
|
# @option options [Integer] :endpoint_cache_max_entries (1000)
|
167
171
|
# Used for the maximum size limit of the LRU cache storing endpoints data
|
@@ -413,7 +417,7 @@ module Aws::SESV2
|
|
413
417
|
# event_destination_name: "EventDestinationName", # required
|
414
418
|
# event_destination: { # required
|
415
419
|
# enabled: false,
|
416
|
-
# matching_event_types: ["SEND"], # accepts SEND, REJECT, BOUNCE, COMPLAINT, DELIVERY, OPEN, CLICK, RENDERING_FAILURE
|
420
|
+
# matching_event_types: ["SEND"], # accepts SEND, REJECT, BOUNCE, COMPLAINT, DELIVERY, OPEN, CLICK, RENDERING_FAILURE, DELIVERY_DELAY
|
417
421
|
# kinesis_firehose_destination: {
|
418
422
|
# iam_role_arn: "AmazonResourceName", # required
|
419
423
|
# delivery_stream_arn: "AmazonResourceName", # required
|
@@ -445,6 +449,67 @@ module Aws::SESV2
|
|
445
449
|
req.send_request(options)
|
446
450
|
end
|
447
451
|
|
452
|
+
# Creates a new custom verification email template.
|
453
|
+
#
|
454
|
+
# For more information about custom verification email templates, see
|
455
|
+
# [Using Custom Verification Email Templates][1] in the *Amazon SES
|
456
|
+
# Developer Guide*.
|
457
|
+
#
|
458
|
+
# You can execute this operation no more than once per second.
|
459
|
+
#
|
460
|
+
#
|
461
|
+
#
|
462
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-email-verify-address-custom.html
|
463
|
+
#
|
464
|
+
# @option params [required, String] :template_name
|
465
|
+
# The name of the custom verification email template.
|
466
|
+
#
|
467
|
+
# @option params [required, String] :from_email_address
|
468
|
+
# The email address that the custom verification email is sent from.
|
469
|
+
#
|
470
|
+
# @option params [required, String] :template_subject
|
471
|
+
# The subject line of the custom verification email.
|
472
|
+
#
|
473
|
+
# @option params [required, String] :template_content
|
474
|
+
# The content of the custom verification email. The total size of the
|
475
|
+
# email must be less than 10 MB. The message body may contain HTML, with
|
476
|
+
# some limitations. For more information, see [Custom Verification Email
|
477
|
+
# Frequently Asked Questions][1] in the *Amazon SES Developer Guide*.
|
478
|
+
#
|
479
|
+
#
|
480
|
+
#
|
481
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-email-verify-address-custom.html#custom-verification-emails-faq
|
482
|
+
#
|
483
|
+
# @option params [required, String] :success_redirection_url
|
484
|
+
# The URL that the recipient of the verification email is sent to if his
|
485
|
+
# or her address is successfully verified.
|
486
|
+
#
|
487
|
+
# @option params [required, String] :failure_redirection_url
|
488
|
+
# The URL that the recipient of the verification email is sent to if his
|
489
|
+
# or her address is not successfully verified.
|
490
|
+
#
|
491
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
492
|
+
#
|
493
|
+
# @example Request syntax with placeholder values
|
494
|
+
#
|
495
|
+
# resp = client.create_custom_verification_email_template({
|
496
|
+
# template_name: "EmailTemplateName", # required
|
497
|
+
# from_email_address: "EmailAddress", # required
|
498
|
+
# template_subject: "EmailTemplateSubject", # required
|
499
|
+
# template_content: "TemplateContent", # required
|
500
|
+
# success_redirection_url: "SuccessRedirectionURL", # required
|
501
|
+
# failure_redirection_url: "FailureRedirectionURL", # required
|
502
|
+
# })
|
503
|
+
#
|
504
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/CreateCustomVerificationEmailTemplate AWS API Documentation
|
505
|
+
#
|
506
|
+
# @overload create_custom_verification_email_template(params = {})
|
507
|
+
# @param [Hash] params ({})
|
508
|
+
def create_custom_verification_email_template(params = {}, options = {})
|
509
|
+
req = build_request(:create_custom_verification_email_template, params)
|
510
|
+
req.send_request(options)
|
511
|
+
end
|
512
|
+
|
448
513
|
# Create a new pool of dedicated IP addresses. A pool can include one or
|
449
514
|
# more dedicated IP addresses that are associated with your AWS account.
|
450
515
|
# You can associate a pool with a configuration set. When you send an
|
@@ -538,8 +603,9 @@ module Aws::SESV2
|
|
538
603
|
# data: "data", # required
|
539
604
|
# },
|
540
605
|
# template: {
|
541
|
-
#
|
542
|
-
#
|
606
|
+
# template_name: "EmailTemplateName",
|
607
|
+
# template_arn: "AmazonResourceName",
|
608
|
+
# template_data: "EmailTemplateData",
|
543
609
|
# },
|
544
610
|
# },
|
545
611
|
# tags: [
|
@@ -656,6 +722,141 @@ module Aws::SESV2
|
|
656
722
|
req.send_request(options)
|
657
723
|
end
|
658
724
|
|
725
|
+
# Creates the specified sending authorization policy for the given
|
726
|
+
# identity (an email address or a domain).
|
727
|
+
#
|
728
|
+
# <note markdown="1"> This API is for the identity owner only. If you have not verified the
|
729
|
+
# identity, this API will return an error.
|
730
|
+
#
|
731
|
+
# </note>
|
732
|
+
#
|
733
|
+
# Sending authorization is a feature that enables an identity owner to
|
734
|
+
# authorize other senders to use its identities. For information about
|
735
|
+
# using sending authorization, see the [Amazon SES Developer Guide][1].
|
736
|
+
#
|
737
|
+
# You can execute this operation no more than once per second.
|
738
|
+
#
|
739
|
+
#
|
740
|
+
#
|
741
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html
|
742
|
+
#
|
743
|
+
# @option params [required, String] :email_identity
|
744
|
+
# The email identity for which you want to create a policy.
|
745
|
+
#
|
746
|
+
# @option params [required, String] :policy_name
|
747
|
+
# The name of the policy.
|
748
|
+
#
|
749
|
+
# The policy name cannot exceed 64 characters and can only include
|
750
|
+
# alphanumeric characters, dashes, and underscores.
|
751
|
+
#
|
752
|
+
# @option params [required, String] :policy
|
753
|
+
# The text of the policy in JSON format. The policy cannot exceed 4 KB.
|
754
|
+
#
|
755
|
+
# For information about the syntax of sending authorization policies,
|
756
|
+
# see the [Amazon SES Developer Guide][1].
|
757
|
+
#
|
758
|
+
#
|
759
|
+
#
|
760
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization-policies.html
|
761
|
+
#
|
762
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
763
|
+
#
|
764
|
+
# @example Request syntax with placeholder values
|
765
|
+
#
|
766
|
+
# resp = client.create_email_identity_policy({
|
767
|
+
# email_identity: "Identity", # required
|
768
|
+
# policy_name: "PolicyName", # required
|
769
|
+
# policy: "Policy", # required
|
770
|
+
# })
|
771
|
+
#
|
772
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/CreateEmailIdentityPolicy AWS API Documentation
|
773
|
+
#
|
774
|
+
# @overload create_email_identity_policy(params = {})
|
775
|
+
# @param [Hash] params ({})
|
776
|
+
def create_email_identity_policy(params = {}, options = {})
|
777
|
+
req = build_request(:create_email_identity_policy, params)
|
778
|
+
req.send_request(options)
|
779
|
+
end
|
780
|
+
|
781
|
+
# Creates an email template. Email templates enable you to send
|
782
|
+
# personalized email to one or more destinations in a single API
|
783
|
+
# operation. For more information, see the [Amazon SES Developer
|
784
|
+
# Guide][1].
|
785
|
+
#
|
786
|
+
# You can execute this operation no more than once per second.
|
787
|
+
#
|
788
|
+
#
|
789
|
+
#
|
790
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-personalized-email-api.html
|
791
|
+
#
|
792
|
+
# @option params [required, String] :template_name
|
793
|
+
# The name of the template you want to create.
|
794
|
+
#
|
795
|
+
# @option params [required, Types::EmailTemplateContent] :template_content
|
796
|
+
# The content of the email template, composed of a subject line, an HTML
|
797
|
+
# part, and a text-only part.
|
798
|
+
#
|
799
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
800
|
+
#
|
801
|
+
# @example Request syntax with placeholder values
|
802
|
+
#
|
803
|
+
# resp = client.create_email_template({
|
804
|
+
# template_name: "EmailTemplateName", # required
|
805
|
+
# template_content: { # required
|
806
|
+
# subject: "EmailTemplateSubject",
|
807
|
+
# text: "EmailTemplateText",
|
808
|
+
# html: "EmailTemplateHtml",
|
809
|
+
# },
|
810
|
+
# })
|
811
|
+
#
|
812
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/CreateEmailTemplate AWS API Documentation
|
813
|
+
#
|
814
|
+
# @overload create_email_template(params = {})
|
815
|
+
# @param [Hash] params ({})
|
816
|
+
def create_email_template(params = {}, options = {})
|
817
|
+
req = build_request(:create_email_template, params)
|
818
|
+
req.send_request(options)
|
819
|
+
end
|
820
|
+
|
821
|
+
# Creates an import job for a data destination.
|
822
|
+
#
|
823
|
+
# @option params [required, Types::ImportDestination] :import_destination
|
824
|
+
# The destination for the import job.
|
825
|
+
#
|
826
|
+
# @option params [required, Types::ImportDataSource] :import_data_source
|
827
|
+
# The data source for the import job.
|
828
|
+
#
|
829
|
+
# @return [Types::CreateImportJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
830
|
+
#
|
831
|
+
# * {Types::CreateImportJobResponse#job_id #job_id} => String
|
832
|
+
#
|
833
|
+
# @example Request syntax with placeholder values
|
834
|
+
#
|
835
|
+
# resp = client.create_import_job({
|
836
|
+
# import_destination: { # required
|
837
|
+
# suppression_list_destination: { # required
|
838
|
+
# suppression_list_import_action: "DELETE", # required, accepts DELETE, PUT
|
839
|
+
# },
|
840
|
+
# },
|
841
|
+
# import_data_source: { # required
|
842
|
+
# s3_url: "S3Url", # required
|
843
|
+
# data_format: "CSV", # required, accepts CSV, JSON
|
844
|
+
# },
|
845
|
+
# })
|
846
|
+
#
|
847
|
+
# @example Response structure
|
848
|
+
#
|
849
|
+
# resp.job_id #=> String
|
850
|
+
#
|
851
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/CreateImportJob AWS API Documentation
|
852
|
+
#
|
853
|
+
# @overload create_import_job(params = {})
|
854
|
+
# @param [Hash] params ({})
|
855
|
+
def create_import_job(params = {}, options = {})
|
856
|
+
req = build_request(:create_import_job, params)
|
857
|
+
req.send_request(options)
|
858
|
+
end
|
859
|
+
|
659
860
|
# Delete an existing configuration set.
|
660
861
|
#
|
661
862
|
# *Configuration sets* are groups of rules that you can apply to the
|
@@ -718,6 +919,39 @@ module Aws::SESV2
|
|
718
919
|
req.send_request(options)
|
719
920
|
end
|
720
921
|
|
922
|
+
# Deletes an existing custom verification email template.
|
923
|
+
#
|
924
|
+
# For more information about custom verification email templates, see
|
925
|
+
# [Using Custom Verification Email Templates][1] in the *Amazon SES
|
926
|
+
# Developer Guide*.
|
927
|
+
#
|
928
|
+
# You can execute this operation no more than once per second.
|
929
|
+
#
|
930
|
+
#
|
931
|
+
#
|
932
|
+
# [1]: https://docs.aws.amazon.com/es/latest/DeveloperGuide/send-email-verify-address-custom.html
|
933
|
+
#
|
934
|
+
# @option params [required, String] :template_name
|
935
|
+
# The name of the custom verification email template that you want to
|
936
|
+
# delete.
|
937
|
+
#
|
938
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
939
|
+
#
|
940
|
+
# @example Request syntax with placeholder values
|
941
|
+
#
|
942
|
+
# resp = client.delete_custom_verification_email_template({
|
943
|
+
# template_name: "EmailTemplateName", # required
|
944
|
+
# })
|
945
|
+
#
|
946
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/DeleteCustomVerificationEmailTemplate AWS API Documentation
|
947
|
+
#
|
948
|
+
# @overload delete_custom_verification_email_template(params = {})
|
949
|
+
# @param [Hash] params ({})
|
950
|
+
def delete_custom_verification_email_template(params = {}, options = {})
|
951
|
+
req = build_request(:delete_custom_verification_email_template, params)
|
952
|
+
req.send_request(options)
|
953
|
+
end
|
954
|
+
|
721
955
|
# Delete a dedicated IP pool.
|
722
956
|
#
|
723
957
|
# @option params [required, String] :pool_name
|
@@ -764,6 +998,76 @@ module Aws::SESV2
|
|
764
998
|
req.send_request(options)
|
765
999
|
end
|
766
1000
|
|
1001
|
+
# Deletes the specified sending authorization policy for the given
|
1002
|
+
# identity (an email address or a domain). This API returns successfully
|
1003
|
+
# even if a policy with the specified name does not exist.
|
1004
|
+
#
|
1005
|
+
# <note markdown="1"> This API is for the identity owner only. If you have not verified the
|
1006
|
+
# identity, this API will return an error.
|
1007
|
+
#
|
1008
|
+
# </note>
|
1009
|
+
#
|
1010
|
+
# Sending authorization is a feature that enables an identity owner to
|
1011
|
+
# authorize other senders to use its identities. For information about
|
1012
|
+
# using sending authorization, see the [Amazon SES Developer Guide][1].
|
1013
|
+
#
|
1014
|
+
# You can execute this operation no more than once per second.
|
1015
|
+
#
|
1016
|
+
#
|
1017
|
+
#
|
1018
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html
|
1019
|
+
#
|
1020
|
+
# @option params [required, String] :email_identity
|
1021
|
+
# The email identity for which you want to delete a policy.
|
1022
|
+
#
|
1023
|
+
# @option params [required, String] :policy_name
|
1024
|
+
# The name of the policy.
|
1025
|
+
#
|
1026
|
+
# The policy name cannot exceed 64 characters and can only include
|
1027
|
+
# alphanumeric characters, dashes, and underscores.
|
1028
|
+
#
|
1029
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1030
|
+
#
|
1031
|
+
# @example Request syntax with placeholder values
|
1032
|
+
#
|
1033
|
+
# resp = client.delete_email_identity_policy({
|
1034
|
+
# email_identity: "Identity", # required
|
1035
|
+
# policy_name: "PolicyName", # required
|
1036
|
+
# })
|
1037
|
+
#
|
1038
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/DeleteEmailIdentityPolicy AWS API Documentation
|
1039
|
+
#
|
1040
|
+
# @overload delete_email_identity_policy(params = {})
|
1041
|
+
# @param [Hash] params ({})
|
1042
|
+
def delete_email_identity_policy(params = {}, options = {})
|
1043
|
+
req = build_request(:delete_email_identity_policy, params)
|
1044
|
+
req.send_request(options)
|
1045
|
+
end
|
1046
|
+
|
1047
|
+
# Deletes an email template.
|
1048
|
+
#
|
1049
|
+
# You can execute this operation no more than once per second.
|
1050
|
+
#
|
1051
|
+
# @option params [required, String] :template_name
|
1052
|
+
# The name of the template to be deleted.
|
1053
|
+
#
|
1054
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1055
|
+
#
|
1056
|
+
# @example Request syntax with placeholder values
|
1057
|
+
#
|
1058
|
+
# resp = client.delete_email_template({
|
1059
|
+
# template_name: "EmailTemplateName", # required
|
1060
|
+
# })
|
1061
|
+
#
|
1062
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/DeleteEmailTemplate AWS API Documentation
|
1063
|
+
#
|
1064
|
+
# @overload delete_email_template(params = {})
|
1065
|
+
# @param [Hash] params ({})
|
1066
|
+
def delete_email_template(params = {}, options = {})
|
1067
|
+
req = build_request(:delete_email_template, params)
|
1068
|
+
req.send_request(options)
|
1069
|
+
end
|
1070
|
+
|
767
1071
|
# Removes an email address from the suppression list for your account.
|
768
1072
|
#
|
769
1073
|
# @option params [required, String] :email_address
|
@@ -798,6 +1102,7 @@ module Aws::SESV2
|
|
798
1102
|
# * {Types::GetAccountResponse#send_quota #send_quota} => Types::SendQuota
|
799
1103
|
# * {Types::GetAccountResponse#sending_enabled #sending_enabled} => Boolean
|
800
1104
|
# * {Types::GetAccountResponse#suppression_attributes #suppression_attributes} => Types::SuppressionAttributes
|
1105
|
+
# * {Types::GetAccountResponse#details #details} => Types::AccountDetails
|
801
1106
|
#
|
802
1107
|
# @example Response structure
|
803
1108
|
#
|
@@ -810,6 +1115,14 @@ module Aws::SESV2
|
|
810
1115
|
# resp.sending_enabled #=> Boolean
|
811
1116
|
# resp.suppression_attributes.suppressed_reasons #=> Array
|
812
1117
|
# resp.suppression_attributes.suppressed_reasons[0] #=> String, one of "BOUNCE", "COMPLAINT"
|
1118
|
+
# resp.details.mail_type #=> String, one of "MARKETING", "TRANSACTIONAL"
|
1119
|
+
# resp.details.website_url #=> String
|
1120
|
+
# resp.details.contact_language #=> String, one of "EN", "JA"
|
1121
|
+
# resp.details.use_case_description #=> String
|
1122
|
+
# resp.details.additional_contact_email_addresses #=> Array
|
1123
|
+
# resp.details.additional_contact_email_addresses[0] #=> String
|
1124
|
+
# resp.details.review_details.status #=> String, one of "PENDING", "FAILED", "GRANTED", "DENIED"
|
1125
|
+
# resp.details.review_details.case_id #=> String
|
813
1126
|
#
|
814
1127
|
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/GetAccount AWS API Documentation
|
815
1128
|
#
|
@@ -938,7 +1251,7 @@ module Aws::SESV2
|
|
938
1251
|
# resp.event_destinations[0].name #=> String
|
939
1252
|
# resp.event_destinations[0].enabled #=> Boolean
|
940
1253
|
# resp.event_destinations[0].matching_event_types #=> Array
|
941
|
-
# resp.event_destinations[0].matching_event_types[0] #=> String, one of "SEND", "REJECT", "BOUNCE", "COMPLAINT", "DELIVERY", "OPEN", "CLICK", "RENDERING_FAILURE"
|
1254
|
+
# resp.event_destinations[0].matching_event_types[0] #=> String, one of "SEND", "REJECT", "BOUNCE", "COMPLAINT", "DELIVERY", "OPEN", "CLICK", "RENDERING_FAILURE", "DELIVERY_DELAY"
|
942
1255
|
# resp.event_destinations[0].kinesis_firehose_destination.iam_role_arn #=> String
|
943
1256
|
# resp.event_destinations[0].kinesis_firehose_destination.delivery_stream_arn #=> String
|
944
1257
|
# resp.event_destinations[0].cloud_watch_destination.dimension_configurations #=> Array
|
@@ -957,6 +1270,56 @@ module Aws::SESV2
|
|
957
1270
|
req.send_request(options)
|
958
1271
|
end
|
959
1272
|
|
1273
|
+
# Returns the custom email verification template for the template name
|
1274
|
+
# you specify.
|
1275
|
+
#
|
1276
|
+
# For more information about custom verification email templates, see
|
1277
|
+
# [Using Custom Verification Email Templates][1] in the *Amazon SES
|
1278
|
+
# Developer Guide*.
|
1279
|
+
#
|
1280
|
+
# You can execute this operation no more than once per second.
|
1281
|
+
#
|
1282
|
+
#
|
1283
|
+
#
|
1284
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-email-verify-address-custom.html
|
1285
|
+
#
|
1286
|
+
# @option params [required, String] :template_name
|
1287
|
+
# The name of the custom verification email template that you want to
|
1288
|
+
# retrieve.
|
1289
|
+
#
|
1290
|
+
# @return [Types::GetCustomVerificationEmailTemplateResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1291
|
+
#
|
1292
|
+
# * {Types::GetCustomVerificationEmailTemplateResponse#template_name #template_name} => String
|
1293
|
+
# * {Types::GetCustomVerificationEmailTemplateResponse#from_email_address #from_email_address} => String
|
1294
|
+
# * {Types::GetCustomVerificationEmailTemplateResponse#template_subject #template_subject} => String
|
1295
|
+
# * {Types::GetCustomVerificationEmailTemplateResponse#template_content #template_content} => String
|
1296
|
+
# * {Types::GetCustomVerificationEmailTemplateResponse#success_redirection_url #success_redirection_url} => String
|
1297
|
+
# * {Types::GetCustomVerificationEmailTemplateResponse#failure_redirection_url #failure_redirection_url} => String
|
1298
|
+
#
|
1299
|
+
# @example Request syntax with placeholder values
|
1300
|
+
#
|
1301
|
+
# resp = client.get_custom_verification_email_template({
|
1302
|
+
# template_name: "EmailTemplateName", # required
|
1303
|
+
# })
|
1304
|
+
#
|
1305
|
+
# @example Response structure
|
1306
|
+
#
|
1307
|
+
# resp.template_name #=> String
|
1308
|
+
# resp.from_email_address #=> String
|
1309
|
+
# resp.template_subject #=> String
|
1310
|
+
# resp.template_content #=> String
|
1311
|
+
# resp.success_redirection_url #=> String
|
1312
|
+
# resp.failure_redirection_url #=> String
|
1313
|
+
#
|
1314
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/GetCustomVerificationEmailTemplate AWS API Documentation
|
1315
|
+
#
|
1316
|
+
# @overload get_custom_verification_email_template(params = {})
|
1317
|
+
# @param [Hash] params ({})
|
1318
|
+
def get_custom_verification_email_template(params = {}, options = {})
|
1319
|
+
req = build_request(:get_custom_verification_email_template, params)
|
1320
|
+
req.send_request(options)
|
1321
|
+
end
|
1322
|
+
|
960
1323
|
# Get information about a dedicated IP address, including the name of
|
961
1324
|
# the dedicated IP pool that it's associated with, as well information
|
962
1325
|
# about the automatic warm-up process for the address.
|
@@ -1256,8 +1619,8 @@ module Aws::SESV2
|
|
1256
1619
|
end
|
1257
1620
|
|
1258
1621
|
# Provides information about a specific identity, including the
|
1259
|
-
# identity's verification status,
|
1260
|
-
# its custom Mail-From settings.
|
1622
|
+
# identity's verification status, sending authorization policies, its
|
1623
|
+
# DKIM authentication status, and its custom Mail-From settings.
|
1261
1624
|
#
|
1262
1625
|
# @option params [required, String] :email_identity
|
1263
1626
|
# The email identity that you want to retrieve details for.
|
@@ -1269,6 +1632,7 @@ module Aws::SESV2
|
|
1269
1632
|
# * {Types::GetEmailIdentityResponse#verified_for_sending_status #verified_for_sending_status} => Boolean
|
1270
1633
|
# * {Types::GetEmailIdentityResponse#dkim_attributes #dkim_attributes} => Types::DkimAttributes
|
1271
1634
|
# * {Types::GetEmailIdentityResponse#mail_from_attributes #mail_from_attributes} => Types::MailFromAttributes
|
1635
|
+
# * {Types::GetEmailIdentityResponse#policies #policies} => Hash<String,String>
|
1272
1636
|
# * {Types::GetEmailIdentityResponse#tags #tags} => Array<Types::Tag>
|
1273
1637
|
#
|
1274
1638
|
# @example Request syntax with placeholder values
|
@@ -1290,6 +1654,8 @@ module Aws::SESV2
|
|
1290
1654
|
# resp.mail_from_attributes.mail_from_domain #=> String
|
1291
1655
|
# resp.mail_from_attributes.mail_from_domain_status #=> String, one of "PENDING", "SUCCESS", "FAILED", "TEMPORARY_FAILURE"
|
1292
1656
|
# resp.mail_from_attributes.behavior_on_mx_failure #=> String, one of "USE_DEFAULT_VALUE", "REJECT_MESSAGE"
|
1657
|
+
# resp.policies #=> Hash
|
1658
|
+
# resp.policies["PolicyName"] #=> String
|
1293
1659
|
# resp.tags #=> Array
|
1294
1660
|
# resp.tags[0].key #=> String
|
1295
1661
|
# resp.tags[0].value #=> String
|
@@ -1303,6 +1669,134 @@ module Aws::SESV2
|
|
1303
1669
|
req.send_request(options)
|
1304
1670
|
end
|
1305
1671
|
|
1672
|
+
# Returns the requested sending authorization policies for the given
|
1673
|
+
# identity (an email address or a domain). The policies are returned as
|
1674
|
+
# a map of policy names to policy contents. You can retrieve a maximum
|
1675
|
+
# of 20 policies at a time.
|
1676
|
+
#
|
1677
|
+
# <note markdown="1"> This API is for the identity owner only. If you have not verified the
|
1678
|
+
# identity, this API will return an error.
|
1679
|
+
#
|
1680
|
+
# </note>
|
1681
|
+
#
|
1682
|
+
# Sending authorization is a feature that enables an identity owner to
|
1683
|
+
# authorize other senders to use its identities. For information about
|
1684
|
+
# using sending authorization, see the [Amazon SES Developer Guide][1].
|
1685
|
+
#
|
1686
|
+
# You can execute this operation no more than once per second.
|
1687
|
+
#
|
1688
|
+
#
|
1689
|
+
#
|
1690
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html
|
1691
|
+
#
|
1692
|
+
# @option params [required, String] :email_identity
|
1693
|
+
# The email identity that you want to retrieve policies for.
|
1694
|
+
#
|
1695
|
+
# @return [Types::GetEmailIdentityPoliciesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1696
|
+
#
|
1697
|
+
# * {Types::GetEmailIdentityPoliciesResponse#policies #policies} => Hash<String,String>
|
1698
|
+
#
|
1699
|
+
# @example Request syntax with placeholder values
|
1700
|
+
#
|
1701
|
+
# resp = client.get_email_identity_policies({
|
1702
|
+
# email_identity: "Identity", # required
|
1703
|
+
# })
|
1704
|
+
#
|
1705
|
+
# @example Response structure
|
1706
|
+
#
|
1707
|
+
# resp.policies #=> Hash
|
1708
|
+
# resp.policies["PolicyName"] #=> String
|
1709
|
+
#
|
1710
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/GetEmailIdentityPolicies AWS API Documentation
|
1711
|
+
#
|
1712
|
+
# @overload get_email_identity_policies(params = {})
|
1713
|
+
# @param [Hash] params ({})
|
1714
|
+
def get_email_identity_policies(params = {}, options = {})
|
1715
|
+
req = build_request(:get_email_identity_policies, params)
|
1716
|
+
req.send_request(options)
|
1717
|
+
end
|
1718
|
+
|
1719
|
+
# Displays the template object (which includes the subject line, HTML
|
1720
|
+
# part and text part) for the template you specify.
|
1721
|
+
#
|
1722
|
+
# You can execute this operation no more than once per second.
|
1723
|
+
#
|
1724
|
+
# @option params [required, String] :template_name
|
1725
|
+
# The name of the template you want to retrieve.
|
1726
|
+
#
|
1727
|
+
# @return [Types::GetEmailTemplateResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1728
|
+
#
|
1729
|
+
# * {Types::GetEmailTemplateResponse#template_name #template_name} => String
|
1730
|
+
# * {Types::GetEmailTemplateResponse#template_content #template_content} => Types::EmailTemplateContent
|
1731
|
+
#
|
1732
|
+
# @example Request syntax with placeholder values
|
1733
|
+
#
|
1734
|
+
# resp = client.get_email_template({
|
1735
|
+
# template_name: "EmailTemplateName", # required
|
1736
|
+
# })
|
1737
|
+
#
|
1738
|
+
# @example Response structure
|
1739
|
+
#
|
1740
|
+
# resp.template_name #=> String
|
1741
|
+
# resp.template_content.subject #=> String
|
1742
|
+
# resp.template_content.text #=> String
|
1743
|
+
# resp.template_content.html #=> String
|
1744
|
+
#
|
1745
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/GetEmailTemplate AWS API Documentation
|
1746
|
+
#
|
1747
|
+
# @overload get_email_template(params = {})
|
1748
|
+
# @param [Hash] params ({})
|
1749
|
+
def get_email_template(params = {}, options = {})
|
1750
|
+
req = build_request(:get_email_template, params)
|
1751
|
+
req.send_request(options)
|
1752
|
+
end
|
1753
|
+
|
1754
|
+
# Provides information about an import job.
|
1755
|
+
#
|
1756
|
+
# @option params [required, String] :job_id
|
1757
|
+
# The ID of the import job.
|
1758
|
+
#
|
1759
|
+
# @return [Types::GetImportJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1760
|
+
#
|
1761
|
+
# * {Types::GetImportJobResponse#job_id #job_id} => String
|
1762
|
+
# * {Types::GetImportJobResponse#import_destination #import_destination} => Types::ImportDestination
|
1763
|
+
# * {Types::GetImportJobResponse#import_data_source #import_data_source} => Types::ImportDataSource
|
1764
|
+
# * {Types::GetImportJobResponse#failure_info #failure_info} => Types::FailureInfo
|
1765
|
+
# * {Types::GetImportJobResponse#job_status #job_status} => String
|
1766
|
+
# * {Types::GetImportJobResponse#created_timestamp #created_timestamp} => Time
|
1767
|
+
# * {Types::GetImportJobResponse#completed_timestamp #completed_timestamp} => Time
|
1768
|
+
# * {Types::GetImportJobResponse#processed_records_count #processed_records_count} => Integer
|
1769
|
+
# * {Types::GetImportJobResponse#failed_records_count #failed_records_count} => Integer
|
1770
|
+
#
|
1771
|
+
# @example Request syntax with placeholder values
|
1772
|
+
#
|
1773
|
+
# resp = client.get_import_job({
|
1774
|
+
# job_id: "JobId", # required
|
1775
|
+
# })
|
1776
|
+
#
|
1777
|
+
# @example Response structure
|
1778
|
+
#
|
1779
|
+
# resp.job_id #=> String
|
1780
|
+
# resp.import_destination.suppression_list_destination.suppression_list_import_action #=> String, one of "DELETE", "PUT"
|
1781
|
+
# resp.import_data_source.s3_url #=> String
|
1782
|
+
# resp.import_data_source.data_format #=> String, one of "CSV", "JSON"
|
1783
|
+
# resp.failure_info.failed_records_s3_url #=> String
|
1784
|
+
# resp.failure_info.error_message #=> String
|
1785
|
+
# resp.job_status #=> String, one of "CREATED", "PROCESSING", "COMPLETED", "FAILED"
|
1786
|
+
# resp.created_timestamp #=> Time
|
1787
|
+
# resp.completed_timestamp #=> Time
|
1788
|
+
# resp.processed_records_count #=> Integer
|
1789
|
+
# resp.failed_records_count #=> Integer
|
1790
|
+
#
|
1791
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/GetImportJob AWS API Documentation
|
1792
|
+
#
|
1793
|
+
# @overload get_import_job(params = {})
|
1794
|
+
# @param [Hash] params ({})
|
1795
|
+
def get_import_job(params = {}, options = {})
|
1796
|
+
req = build_request(:get_import_job, params)
|
1797
|
+
req.send_request(options)
|
1798
|
+
end
|
1799
|
+
|
1306
1800
|
# Retrieves information about a specific email address that's on the
|
1307
1801
|
# suppression list for your account.
|
1308
1802
|
#
|
@@ -1384,42 +1878,103 @@ module Aws::SESV2
|
|
1384
1878
|
req.send_request(options)
|
1385
1879
|
end
|
1386
1880
|
|
1387
|
-
#
|
1388
|
-
# the current Region.
|
1881
|
+
# Lists the existing custom verification email templates for your
|
1882
|
+
# account in the current AWS Region.
|
1883
|
+
#
|
1884
|
+
# For more information about custom verification email templates, see
|
1885
|
+
# [Using Custom Verification Email Templates][1] in the *Amazon SES
|
1886
|
+
# Developer Guide*.
|
1887
|
+
#
|
1888
|
+
# You can execute this operation no more than once per second.
|
1889
|
+
#
|
1890
|
+
#
|
1891
|
+
#
|
1892
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-email-verify-address-custom.html
|
1389
1893
|
#
|
1390
1894
|
# @option params [String] :next_token
|
1391
|
-
# A token returned from a previous call to
|
1392
|
-
# indicate the position in the
|
1895
|
+
# A token returned from a previous call to
|
1896
|
+
# `ListCustomVerificationEmailTemplates` to indicate the position in the
|
1897
|
+
# list of custom verification email templates.
|
1393
1898
|
#
|
1394
1899
|
# @option params [Integer] :page_size
|
1395
1900
|
# The number of results to show in a single call to
|
1396
|
-
# `
|
1397
|
-
# number you specified in this parameter, then the
|
1398
|
-
# `NextToken` element, which you can use to obtain
|
1901
|
+
# `ListCustomVerificationEmailTemplates`. If the number of results is
|
1902
|
+
# larger than the number you specified in this parameter, then the
|
1903
|
+
# response includes a `NextToken` element, which you can use to obtain
|
1904
|
+
# additional results.
|
1399
1905
|
#
|
1400
|
-
#
|
1906
|
+
# The value you specify has to be at least 1, and can be no more than
|
1907
|
+
# 50.
|
1401
1908
|
#
|
1402
|
-
#
|
1403
|
-
#
|
1909
|
+
# @return [Types::ListCustomVerificationEmailTemplatesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1910
|
+
#
|
1911
|
+
# * {Types::ListCustomVerificationEmailTemplatesResponse#custom_verification_email_templates #custom_verification_email_templates} => Array<Types::CustomVerificationEmailTemplateMetadata>
|
1912
|
+
# * {Types::ListCustomVerificationEmailTemplatesResponse#next_token #next_token} => String
|
1404
1913
|
#
|
1405
1914
|
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1406
1915
|
#
|
1407
1916
|
# @example Request syntax with placeholder values
|
1408
1917
|
#
|
1409
|
-
# resp = client.
|
1918
|
+
# resp = client.list_custom_verification_email_templates({
|
1410
1919
|
# next_token: "NextToken",
|
1411
1920
|
# page_size: 1,
|
1412
1921
|
# })
|
1413
1922
|
#
|
1414
1923
|
# @example Response structure
|
1415
1924
|
#
|
1416
|
-
# resp.
|
1417
|
-
# resp.
|
1925
|
+
# resp.custom_verification_email_templates #=> Array
|
1926
|
+
# resp.custom_verification_email_templates[0].template_name #=> String
|
1927
|
+
# resp.custom_verification_email_templates[0].from_email_address #=> String
|
1928
|
+
# resp.custom_verification_email_templates[0].template_subject #=> String
|
1929
|
+
# resp.custom_verification_email_templates[0].success_redirection_url #=> String
|
1930
|
+
# resp.custom_verification_email_templates[0].failure_redirection_url #=> String
|
1418
1931
|
# resp.next_token #=> String
|
1419
1932
|
#
|
1420
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/
|
1933
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/ListCustomVerificationEmailTemplates AWS API Documentation
|
1421
1934
|
#
|
1422
|
-
# @overload
|
1935
|
+
# @overload list_custom_verification_email_templates(params = {})
|
1936
|
+
# @param [Hash] params ({})
|
1937
|
+
def list_custom_verification_email_templates(params = {}, options = {})
|
1938
|
+
req = build_request(:list_custom_verification_email_templates, params)
|
1939
|
+
req.send_request(options)
|
1940
|
+
end
|
1941
|
+
|
1942
|
+
# List all of the dedicated IP pools that exist in your AWS account in
|
1943
|
+
# the current Region.
|
1944
|
+
#
|
1945
|
+
# @option params [String] :next_token
|
1946
|
+
# A token returned from a previous call to `ListDedicatedIpPools` to
|
1947
|
+
# indicate the position in the list of dedicated IP pools.
|
1948
|
+
#
|
1949
|
+
# @option params [Integer] :page_size
|
1950
|
+
# The number of results to show in a single call to
|
1951
|
+
# `ListDedicatedIpPools`. If the number of results is larger than the
|
1952
|
+
# number you specified in this parameter, then the response includes a
|
1953
|
+
# `NextToken` element, which you can use to obtain additional results.
|
1954
|
+
#
|
1955
|
+
# @return [Types::ListDedicatedIpPoolsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1956
|
+
#
|
1957
|
+
# * {Types::ListDedicatedIpPoolsResponse#dedicated_ip_pools #dedicated_ip_pools} => Array<String>
|
1958
|
+
# * {Types::ListDedicatedIpPoolsResponse#next_token #next_token} => String
|
1959
|
+
#
|
1960
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1961
|
+
#
|
1962
|
+
# @example Request syntax with placeholder values
|
1963
|
+
#
|
1964
|
+
# resp = client.list_dedicated_ip_pools({
|
1965
|
+
# next_token: "NextToken",
|
1966
|
+
# page_size: 1,
|
1967
|
+
# })
|
1968
|
+
#
|
1969
|
+
# @example Response structure
|
1970
|
+
#
|
1971
|
+
# resp.dedicated_ip_pools #=> Array
|
1972
|
+
# resp.dedicated_ip_pools[0] #=> String
|
1973
|
+
# resp.next_token #=> String
|
1974
|
+
#
|
1975
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/ListDedicatedIpPools AWS API Documentation
|
1976
|
+
#
|
1977
|
+
# @overload list_dedicated_ip_pools(params = {})
|
1423
1978
|
# @param [Hash] params ({})
|
1424
1979
|
def list_dedicated_ip_pools(params = {}, options = {})
|
1425
1980
|
req = build_request(:list_dedicated_ip_pools, params)
|
@@ -1606,6 +2161,106 @@ module Aws::SESV2
|
|
1606
2161
|
req.send_request(options)
|
1607
2162
|
end
|
1608
2163
|
|
2164
|
+
# Lists the email templates present in your Amazon SES account in the
|
2165
|
+
# current AWS Region.
|
2166
|
+
#
|
2167
|
+
# You can execute this operation no more than once per second.
|
2168
|
+
#
|
2169
|
+
# @option params [String] :next_token
|
2170
|
+
# A token returned from a previous call to `ListEmailTemplates` to
|
2171
|
+
# indicate the position in the list of email templates.
|
2172
|
+
#
|
2173
|
+
# @option params [Integer] :page_size
|
2174
|
+
# The number of results to show in a single call to
|
2175
|
+
# `ListEmailTemplates`. If the number of results is larger than the
|
2176
|
+
# number you specified in this parameter, then the response includes a
|
2177
|
+
# `NextToken` element, which you can use to obtain additional results.
|
2178
|
+
#
|
2179
|
+
# The value you specify has to be at least 1, and can be no more than
|
2180
|
+
# 10.
|
2181
|
+
#
|
2182
|
+
# @return [Types::ListEmailTemplatesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2183
|
+
#
|
2184
|
+
# * {Types::ListEmailTemplatesResponse#templates_metadata #templates_metadata} => Array<Types::EmailTemplateMetadata>
|
2185
|
+
# * {Types::ListEmailTemplatesResponse#next_token #next_token} => String
|
2186
|
+
#
|
2187
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2188
|
+
#
|
2189
|
+
# @example Request syntax with placeholder values
|
2190
|
+
#
|
2191
|
+
# resp = client.list_email_templates({
|
2192
|
+
# next_token: "NextToken",
|
2193
|
+
# page_size: 1,
|
2194
|
+
# })
|
2195
|
+
#
|
2196
|
+
# @example Response structure
|
2197
|
+
#
|
2198
|
+
# resp.templates_metadata #=> Array
|
2199
|
+
# resp.templates_metadata[0].template_name #=> String
|
2200
|
+
# resp.templates_metadata[0].created_timestamp #=> Time
|
2201
|
+
# resp.next_token #=> String
|
2202
|
+
#
|
2203
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/ListEmailTemplates AWS API Documentation
|
2204
|
+
#
|
2205
|
+
# @overload list_email_templates(params = {})
|
2206
|
+
# @param [Hash] params ({})
|
2207
|
+
def list_email_templates(params = {}, options = {})
|
2208
|
+
req = build_request(:list_email_templates, params)
|
2209
|
+
req.send_request(options)
|
2210
|
+
end
|
2211
|
+
|
2212
|
+
# Lists all of the import jobs.
|
2213
|
+
#
|
2214
|
+
# @option params [String] :import_destination_type
|
2215
|
+
# The destination of the import job, which can be used to list import
|
2216
|
+
# jobs that have a certain `ImportDestinationType`.
|
2217
|
+
#
|
2218
|
+
# @option params [String] :next_token
|
2219
|
+
# A string token indicating that there might be additional import jobs
|
2220
|
+
# available to be listed. Copy this token to a subsequent call to
|
2221
|
+
# `ListImportJobs` with the same parameters to retrieve the next page of
|
2222
|
+
# import jobs.
|
2223
|
+
#
|
2224
|
+
# @option params [Integer] :page_size
|
2225
|
+
# Maximum number of import jobs to return at once. Use this parameter to
|
2226
|
+
# paginate results. If additional import jobs exist beyond the specified
|
2227
|
+
# limit, the `NextToken` element is sent in the response. Use the
|
2228
|
+
# `NextToken` value in subsequent requests to retrieve additional
|
2229
|
+
# addresses.
|
2230
|
+
#
|
2231
|
+
# @return [Types::ListImportJobsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2232
|
+
#
|
2233
|
+
# * {Types::ListImportJobsResponse#import_jobs #import_jobs} => Array<Types::ImportJobSummary>
|
2234
|
+
# * {Types::ListImportJobsResponse#next_token #next_token} => String
|
2235
|
+
#
|
2236
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2237
|
+
#
|
2238
|
+
# @example Request syntax with placeholder values
|
2239
|
+
#
|
2240
|
+
# resp = client.list_import_jobs({
|
2241
|
+
# import_destination_type: "SUPPRESSION_LIST", # accepts SUPPRESSION_LIST
|
2242
|
+
# next_token: "NextToken",
|
2243
|
+
# page_size: 1,
|
2244
|
+
# })
|
2245
|
+
#
|
2246
|
+
# @example Response structure
|
2247
|
+
#
|
2248
|
+
# resp.import_jobs #=> Array
|
2249
|
+
# resp.import_jobs[0].job_id #=> String
|
2250
|
+
# resp.import_jobs[0].import_destination.suppression_list_destination.suppression_list_import_action #=> String, one of "DELETE", "PUT"
|
2251
|
+
# resp.import_jobs[0].job_status #=> String, one of "CREATED", "PROCESSING", "COMPLETED", "FAILED"
|
2252
|
+
# resp.import_jobs[0].created_timestamp #=> Time
|
2253
|
+
# resp.next_token #=> String
|
2254
|
+
#
|
2255
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/ListImportJobs AWS API Documentation
|
2256
|
+
#
|
2257
|
+
# @overload list_import_jobs(params = {})
|
2258
|
+
# @param [Hash] params ({})
|
2259
|
+
def list_import_jobs(params = {}, options = {})
|
2260
|
+
req = build_request(:list_import_jobs, params)
|
2261
|
+
req.send_request(options)
|
2262
|
+
end
|
2263
|
+
|
1609
2264
|
# Retrieves a list of email addresses that are on the suppression list
|
1610
2265
|
# for your account.
|
1611
2266
|
#
|
@@ -1728,6 +2383,62 @@ module Aws::SESV2
|
|
1728
2383
|
req.send_request(options)
|
1729
2384
|
end
|
1730
2385
|
|
2386
|
+
# Update your Amazon SES account details.
|
2387
|
+
#
|
2388
|
+
# @option params [required, String] :mail_type
|
2389
|
+
# The type of email your account will send.
|
2390
|
+
#
|
2391
|
+
# @option params [required, String] :website_url
|
2392
|
+
# The URL of your website. This information helps us better understand
|
2393
|
+
# the type of content that you plan to send.
|
2394
|
+
#
|
2395
|
+
# @option params [String] :contact_language
|
2396
|
+
# The language you would prefer to be contacted with.
|
2397
|
+
#
|
2398
|
+
# @option params [required, String] :use_case_description
|
2399
|
+
# A description of the types of email that you plan to send.
|
2400
|
+
#
|
2401
|
+
# @option params [Array<String>] :additional_contact_email_addresses
|
2402
|
+
# Additional email addresses that you would like to be notified
|
2403
|
+
# regarding Amazon SES matters.
|
2404
|
+
#
|
2405
|
+
# @option params [Boolean] :production_access_enabled
|
2406
|
+
# Indicates whether or not your account should have production access in
|
2407
|
+
# the current AWS Region.
|
2408
|
+
#
|
2409
|
+
# If the value is `false`, then your account is in the *sandbox*. When
|
2410
|
+
# your account is in the sandbox, you can only send email to verified
|
2411
|
+
# identities. Additionally, the maximum number of emails you can send in
|
2412
|
+
# a 24-hour period (your sending quota) is 200, and the maximum number
|
2413
|
+
# of emails you can send per second (your maximum sending rate) is 1.
|
2414
|
+
#
|
2415
|
+
# If the value is `true`, then your account has production access. When
|
2416
|
+
# your account has production access, you can send email to any address.
|
2417
|
+
# The sending quota and maximum sending rate for your account vary based
|
2418
|
+
# on your specific use case.
|
2419
|
+
#
|
2420
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2421
|
+
#
|
2422
|
+
# @example Request syntax with placeholder values
|
2423
|
+
#
|
2424
|
+
# resp = client.put_account_details({
|
2425
|
+
# mail_type: "MARKETING", # required, accepts MARKETING, TRANSACTIONAL
|
2426
|
+
# website_url: "WebsiteURL", # required
|
2427
|
+
# contact_language: "EN", # accepts EN, JA
|
2428
|
+
# use_case_description: "UseCaseDescription", # required
|
2429
|
+
# additional_contact_email_addresses: ["AdditionalContactEmailAddress"],
|
2430
|
+
# production_access_enabled: false,
|
2431
|
+
# })
|
2432
|
+
#
|
2433
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/PutAccountDetails AWS API Documentation
|
2434
|
+
#
|
2435
|
+
# @overload put_account_details(params = {})
|
2436
|
+
# @param [Hash] params ({})
|
2437
|
+
def put_account_details(params = {}, options = {})
|
2438
|
+
req = build_request(:put_account_details, params)
|
2439
|
+
req.send_request(options)
|
2440
|
+
end
|
2441
|
+
|
1731
2442
|
# Enable or disable the ability of your account to send email.
|
1732
2443
|
#
|
1733
2444
|
# @option params [Boolean] :sending_enabled
|
@@ -2290,6 +3001,193 @@ module Aws::SESV2
|
|
2290
3001
|
req.send_request(options)
|
2291
3002
|
end
|
2292
3003
|
|
3004
|
+
# Composes an email message to multiple destinations.
|
3005
|
+
#
|
3006
|
+
# @option params [String] :from_email_address
|
3007
|
+
# The email address that you want to use as the "From" address for the
|
3008
|
+
# email. The address that you specify has to be verified.
|
3009
|
+
#
|
3010
|
+
# @option params [String] :from_email_address_identity_arn
|
3011
|
+
# This parameter is used only for sending authorization. It is the ARN
|
3012
|
+
# of the identity that is associated with the sending authorization
|
3013
|
+
# policy that permits you to use the email address specified in the
|
3014
|
+
# `FromEmailAddress` parameter.
|
3015
|
+
#
|
3016
|
+
# For example, if the owner of example.com (which has ARN
|
3017
|
+
# arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a
|
3018
|
+
# policy to it that authorizes you to use sender@example.com, then you
|
3019
|
+
# would specify the `FromEmailAddressIdentityArn` to be
|
3020
|
+
# arn:aws:ses:us-east-1:123456789012:identity/example.com, and the
|
3021
|
+
# `FromEmailAddress` to be sender@example.com.
|
3022
|
+
#
|
3023
|
+
# For more information about sending authorization, see the [Amazon SES
|
3024
|
+
# Developer Guide][1].
|
3025
|
+
#
|
3026
|
+
#
|
3027
|
+
#
|
3028
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html
|
3029
|
+
#
|
3030
|
+
# @option params [Array<String>] :reply_to_addresses
|
3031
|
+
# The "Reply-to" email addresses for the message. When the recipient
|
3032
|
+
# replies to the message, each Reply-to address receives the reply.
|
3033
|
+
#
|
3034
|
+
# @option params [String] :feedback_forwarding_email_address
|
3035
|
+
# The address that you want bounce and complaint notifications to be
|
3036
|
+
# sent to.
|
3037
|
+
#
|
3038
|
+
# @option params [String] :feedback_forwarding_email_address_identity_arn
|
3039
|
+
# This parameter is used only for sending authorization. It is the ARN
|
3040
|
+
# of the identity that is associated with the sending authorization
|
3041
|
+
# policy that permits you to use the email address specified in the
|
3042
|
+
# `FeedbackForwardingEmailAddress` parameter.
|
3043
|
+
#
|
3044
|
+
# For example, if the owner of example.com (which has ARN
|
3045
|
+
# arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a
|
3046
|
+
# policy to it that authorizes you to use feedback@example.com, then you
|
3047
|
+
# would specify the `FeedbackForwardingEmailAddressIdentityArn` to be
|
3048
|
+
# arn:aws:ses:us-east-1:123456789012:identity/example.com, and the
|
3049
|
+
# `FeedbackForwardingEmailAddress` to be feedback@example.com.
|
3050
|
+
#
|
3051
|
+
# For more information about sending authorization, see the [Amazon SES
|
3052
|
+
# Developer Guide][1].
|
3053
|
+
#
|
3054
|
+
#
|
3055
|
+
#
|
3056
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html
|
3057
|
+
#
|
3058
|
+
# @option params [Array<Types::MessageTag>] :default_email_tags
|
3059
|
+
# A list of tags, in the form of name/value pairs, to apply to an email
|
3060
|
+
# that you send using the `SendEmail` operation. Tags correspond to
|
3061
|
+
# characteristics of the email that you define, so that you can publish
|
3062
|
+
# email sending events.
|
3063
|
+
#
|
3064
|
+
# @option params [required, Types::BulkEmailContent] :default_content
|
3065
|
+
# An object that contains the body of the message. You can specify a
|
3066
|
+
# template message.
|
3067
|
+
#
|
3068
|
+
# @option params [required, Array<Types::BulkEmailEntry>] :bulk_email_entries
|
3069
|
+
# The list of bulk email entry objects.
|
3070
|
+
#
|
3071
|
+
# @option params [String] :configuration_set_name
|
3072
|
+
# The name of the configuration set that you want to use when sending
|
3073
|
+
# the email.
|
3074
|
+
#
|
3075
|
+
# @return [Types::SendBulkEmailResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3076
|
+
#
|
3077
|
+
# * {Types::SendBulkEmailResponse#bulk_email_entry_results #bulk_email_entry_results} => Array<Types::BulkEmailEntryResult>
|
3078
|
+
#
|
3079
|
+
# @example Request syntax with placeholder values
|
3080
|
+
#
|
3081
|
+
# resp = client.send_bulk_email({
|
3082
|
+
# from_email_address: "EmailAddress",
|
3083
|
+
# from_email_address_identity_arn: "AmazonResourceName",
|
3084
|
+
# reply_to_addresses: ["EmailAddress"],
|
3085
|
+
# feedback_forwarding_email_address: "EmailAddress",
|
3086
|
+
# feedback_forwarding_email_address_identity_arn: "AmazonResourceName",
|
3087
|
+
# default_email_tags: [
|
3088
|
+
# {
|
3089
|
+
# name: "MessageTagName", # required
|
3090
|
+
# value: "MessageTagValue", # required
|
3091
|
+
# },
|
3092
|
+
# ],
|
3093
|
+
# default_content: { # required
|
3094
|
+
# template: {
|
3095
|
+
# template_name: "EmailTemplateName",
|
3096
|
+
# template_arn: "AmazonResourceName",
|
3097
|
+
# template_data: "EmailTemplateData",
|
3098
|
+
# },
|
3099
|
+
# },
|
3100
|
+
# bulk_email_entries: [ # required
|
3101
|
+
# {
|
3102
|
+
# destination: { # required
|
3103
|
+
# to_addresses: ["EmailAddress"],
|
3104
|
+
# cc_addresses: ["EmailAddress"],
|
3105
|
+
# bcc_addresses: ["EmailAddress"],
|
3106
|
+
# },
|
3107
|
+
# replacement_tags: [
|
3108
|
+
# {
|
3109
|
+
# name: "MessageTagName", # required
|
3110
|
+
# value: "MessageTagValue", # required
|
3111
|
+
# },
|
3112
|
+
# ],
|
3113
|
+
# replacement_email_content: {
|
3114
|
+
# replacement_template: {
|
3115
|
+
# replacement_template_data: "EmailTemplateData",
|
3116
|
+
# },
|
3117
|
+
# },
|
3118
|
+
# },
|
3119
|
+
# ],
|
3120
|
+
# configuration_set_name: "ConfigurationSetName",
|
3121
|
+
# })
|
3122
|
+
#
|
3123
|
+
# @example Response structure
|
3124
|
+
#
|
3125
|
+
# resp.bulk_email_entry_results #=> Array
|
3126
|
+
# resp.bulk_email_entry_results[0].status #=> String, one of "SUCCESS", "MESSAGE_REJECTED", "MAIL_FROM_DOMAIN_NOT_VERIFIED", "CONFIGURATION_SET_NOT_FOUND", "TEMPLATE_NOT_FOUND", "ACCOUNT_SUSPENDED", "ACCOUNT_THROTTLED", "ACCOUNT_DAILY_QUOTA_EXCEEDED", "INVALID_SENDING_POOL_NAME", "ACCOUNT_SENDING_PAUSED", "CONFIGURATION_SET_SENDING_PAUSED", "INVALID_PARAMETER", "TRANSIENT_FAILURE", "FAILED"
|
3127
|
+
# resp.bulk_email_entry_results[0].error #=> String
|
3128
|
+
# resp.bulk_email_entry_results[0].message_id #=> String
|
3129
|
+
#
|
3130
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/SendBulkEmail AWS API Documentation
|
3131
|
+
#
|
3132
|
+
# @overload send_bulk_email(params = {})
|
3133
|
+
# @param [Hash] params ({})
|
3134
|
+
def send_bulk_email(params = {}, options = {})
|
3135
|
+
req = build_request(:send_bulk_email, params)
|
3136
|
+
req.send_request(options)
|
3137
|
+
end
|
3138
|
+
|
3139
|
+
# Adds an email address to the list of identities for your Amazon SES
|
3140
|
+
# account in the current AWS Region and attempts to verify it. As a
|
3141
|
+
# result of executing this operation, a customized verification email is
|
3142
|
+
# sent to the specified address.
|
3143
|
+
#
|
3144
|
+
# To use this operation, you must first create a custom verification
|
3145
|
+
# email template. For more information about creating and using custom
|
3146
|
+
# verification email templates, see [Using Custom Verification Email
|
3147
|
+
# Templates][1] in the *Amazon SES Developer Guide*.
|
3148
|
+
#
|
3149
|
+
# You can execute this operation no more than once per second.
|
3150
|
+
#
|
3151
|
+
#
|
3152
|
+
#
|
3153
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-email-verify-address-custom.html
|
3154
|
+
#
|
3155
|
+
# @option params [required, String] :email_address
|
3156
|
+
# The email address to verify.
|
3157
|
+
#
|
3158
|
+
# @option params [required, String] :template_name
|
3159
|
+
# The name of the custom verification email template to use when sending
|
3160
|
+
# the verification email.
|
3161
|
+
#
|
3162
|
+
# @option params [String] :configuration_set_name
|
3163
|
+
# Name of a configuration set to use when sending the verification
|
3164
|
+
# email.
|
3165
|
+
#
|
3166
|
+
# @return [Types::SendCustomVerificationEmailResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3167
|
+
#
|
3168
|
+
# * {Types::SendCustomVerificationEmailResponse#message_id #message_id} => String
|
3169
|
+
#
|
3170
|
+
# @example Request syntax with placeholder values
|
3171
|
+
#
|
3172
|
+
# resp = client.send_custom_verification_email({
|
3173
|
+
# email_address: "EmailAddress", # required
|
3174
|
+
# template_name: "EmailTemplateName", # required
|
3175
|
+
# configuration_set_name: "ConfigurationSetName",
|
3176
|
+
# })
|
3177
|
+
#
|
3178
|
+
# @example Response structure
|
3179
|
+
#
|
3180
|
+
# resp.message_id #=> String
|
3181
|
+
#
|
3182
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/SendCustomVerificationEmail AWS API Documentation
|
3183
|
+
#
|
3184
|
+
# @overload send_custom_verification_email(params = {})
|
3185
|
+
# @param [Hash] params ({})
|
3186
|
+
def send_custom_verification_email(params = {}, options = {})
|
3187
|
+
req = build_request(:send_custom_verification_email, params)
|
3188
|
+
req.send_request(options)
|
3189
|
+
end
|
3190
|
+
|
2293
3191
|
# Sends an email message. You can use the Amazon SES API v2 to send two
|
2294
3192
|
# types of messages:
|
2295
3193
|
#
|
@@ -2303,11 +3201,39 @@ module Aws::SESV2
|
|
2303
3201
|
# messages that contain attachments. The message that you specify has
|
2304
3202
|
# to be a valid MIME message.
|
2305
3203
|
#
|
3204
|
+
# * **Templated** – A message that contains personalization tags. When
|
3205
|
+
# you send this type of email, Amazon SES API v2 automatically
|
3206
|
+
# replaces the tags with values that you specify.
|
3207
|
+
#
|
2306
3208
|
# @option params [String] :from_email_address
|
2307
3209
|
# The email address that you want to use as the "From" address for the
|
2308
3210
|
# email. The address that you specify has to be verified.
|
2309
3211
|
#
|
2310
|
-
# @option params [
|
3212
|
+
# @option params [String] :from_email_address_identity_arn
|
3213
|
+
# This parameter is used only for sending authorization. It is the ARN
|
3214
|
+
# of the identity that is associated with the sending authorization
|
3215
|
+
# policy that permits you to use the email address specified in the
|
3216
|
+
# `FromEmailAddress` parameter.
|
3217
|
+
#
|
3218
|
+
# For example, if the owner of example.com (which has ARN
|
3219
|
+
# arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a
|
3220
|
+
# policy to it that authorizes you to use sender@example.com, then you
|
3221
|
+
# would specify the `FromEmailAddressIdentityArn` to be
|
3222
|
+
# arn:aws:ses:us-east-1:123456789012:identity/example.com, and the
|
3223
|
+
# `FromEmailAddress` to be sender@example.com.
|
3224
|
+
#
|
3225
|
+
# For more information about sending authorization, see the [Amazon SES
|
3226
|
+
# Developer Guide][1].
|
3227
|
+
#
|
3228
|
+
# For Raw emails, the `FromEmailAddressIdentityArn` value overrides the
|
3229
|
+
# X-SES-SOURCE-ARN and X-SES-FROM-ARN headers specified in raw email
|
3230
|
+
# message content.
|
3231
|
+
#
|
3232
|
+
#
|
3233
|
+
#
|
3234
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html
|
3235
|
+
#
|
3236
|
+
# @option params [Types::Destination] :destination
|
2311
3237
|
# An object that contains the recipients of the email message.
|
2312
3238
|
#
|
2313
3239
|
# @option params [Array<String>] :reply_to_addresses
|
@@ -2318,9 +3244,29 @@ module Aws::SESV2
|
|
2318
3244
|
# The address that you want bounce and complaint notifications to be
|
2319
3245
|
# sent to.
|
2320
3246
|
#
|
3247
|
+
# @option params [String] :feedback_forwarding_email_address_identity_arn
|
3248
|
+
# This parameter is used only for sending authorization. It is the ARN
|
3249
|
+
# of the identity that is associated with the sending authorization
|
3250
|
+
# policy that permits you to use the email address specified in the
|
3251
|
+
# `FeedbackForwardingEmailAddress` parameter.
|
3252
|
+
#
|
3253
|
+
# For example, if the owner of example.com (which has ARN
|
3254
|
+
# arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a
|
3255
|
+
# policy to it that authorizes you to use feedback@example.com, then you
|
3256
|
+
# would specify the `FeedbackForwardingEmailAddressIdentityArn` to be
|
3257
|
+
# arn:aws:ses:us-east-1:123456789012:identity/example.com, and the
|
3258
|
+
# `FeedbackForwardingEmailAddress` to be feedback@example.com.
|
3259
|
+
#
|
3260
|
+
# For more information about sending authorization, see the [Amazon SES
|
3261
|
+
# Developer Guide][1].
|
3262
|
+
#
|
3263
|
+
#
|
3264
|
+
#
|
3265
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html
|
3266
|
+
#
|
2321
3267
|
# @option params [required, Types::EmailContent] :content
|
2322
3268
|
# An object that contains the body of the message. You can send either a
|
2323
|
-
# Simple message or a
|
3269
|
+
# Simple message Raw message or a template Message.
|
2324
3270
|
#
|
2325
3271
|
# @option params [Array<Types::MessageTag>] :email_tags
|
2326
3272
|
# A list of tags, in the form of name/value pairs, to apply to an email
|
@@ -2340,13 +3286,15 @@ module Aws::SESV2
|
|
2340
3286
|
#
|
2341
3287
|
# resp = client.send_email({
|
2342
3288
|
# from_email_address: "EmailAddress",
|
2343
|
-
#
|
3289
|
+
# from_email_address_identity_arn: "AmazonResourceName",
|
3290
|
+
# destination: {
|
2344
3291
|
# to_addresses: ["EmailAddress"],
|
2345
3292
|
# cc_addresses: ["EmailAddress"],
|
2346
3293
|
# bcc_addresses: ["EmailAddress"],
|
2347
3294
|
# },
|
2348
3295
|
# reply_to_addresses: ["EmailAddress"],
|
2349
3296
|
# feedback_forwarding_email_address: "EmailAddress",
|
3297
|
+
# feedback_forwarding_email_address_identity_arn: "AmazonResourceName",
|
2350
3298
|
# content: { # required
|
2351
3299
|
# simple: {
|
2352
3300
|
# subject: { # required
|
@@ -2368,8 +3316,9 @@ module Aws::SESV2
|
|
2368
3316
|
# data: "data", # required
|
2369
3317
|
# },
|
2370
3318
|
# template: {
|
2371
|
-
#
|
2372
|
-
#
|
3319
|
+
# template_name: "EmailTemplateName",
|
3320
|
+
# template_arn: "AmazonResourceName",
|
3321
|
+
# template_data: "EmailTemplateData",
|
2373
3322
|
# },
|
2374
3323
|
# },
|
2375
3324
|
# email_tags: [
|
@@ -2438,6 +3387,43 @@ module Aws::SESV2
|
|
2438
3387
|
req.send_request(options)
|
2439
3388
|
end
|
2440
3389
|
|
3390
|
+
# Creates a preview of the MIME content of an email when provided with a
|
3391
|
+
# template and a set of replacement data.
|
3392
|
+
#
|
3393
|
+
# You can execute this operation no more than once per second.
|
3394
|
+
#
|
3395
|
+
# @option params [required, String] :template_name
|
3396
|
+
# The name of the template that you want to render.
|
3397
|
+
#
|
3398
|
+
# @option params [required, String] :template_data
|
3399
|
+
# A list of replacement values to apply to the template. This parameter
|
3400
|
+
# is a JSON object, typically consisting of key-value pairs in which the
|
3401
|
+
# keys correspond to replacement tags in the email template.
|
3402
|
+
#
|
3403
|
+
# @return [Types::TestRenderEmailTemplateResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3404
|
+
#
|
3405
|
+
# * {Types::TestRenderEmailTemplateResponse#rendered_template #rendered_template} => String
|
3406
|
+
#
|
3407
|
+
# @example Request syntax with placeholder values
|
3408
|
+
#
|
3409
|
+
# resp = client.test_render_email_template({
|
3410
|
+
# template_name: "EmailTemplateName", # required
|
3411
|
+
# template_data: "EmailTemplateData", # required
|
3412
|
+
# })
|
3413
|
+
#
|
3414
|
+
# @example Response structure
|
3415
|
+
#
|
3416
|
+
# resp.rendered_template #=> String
|
3417
|
+
#
|
3418
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/TestRenderEmailTemplate AWS API Documentation
|
3419
|
+
#
|
3420
|
+
# @overload test_render_email_template(params = {})
|
3421
|
+
# @param [Hash] params ({})
|
3422
|
+
def test_render_email_template(params = {}, options = {})
|
3423
|
+
req = build_request(:test_render_email_template, params)
|
3424
|
+
req.send_request(options)
|
3425
|
+
end
|
3426
|
+
|
2441
3427
|
# Remove one or more tags (keys and values) from a specified resource.
|
2442
3428
|
#
|
2443
3429
|
# @option params [required, String] :resource_arn
|
@@ -2501,7 +3487,7 @@ module Aws::SESV2
|
|
2501
3487
|
# event_destination_name: "EventDestinationName", # required
|
2502
3488
|
# event_destination: { # required
|
2503
3489
|
# enabled: false,
|
2504
|
-
# matching_event_types: ["SEND"], # accepts SEND, REJECT, BOUNCE, COMPLAINT, DELIVERY, OPEN, CLICK, RENDERING_FAILURE
|
3490
|
+
# matching_event_types: ["SEND"], # accepts SEND, REJECT, BOUNCE, COMPLAINT, DELIVERY, OPEN, CLICK, RENDERING_FAILURE, DELIVERY_DELAY
|
2505
3491
|
# kinesis_firehose_destination: {
|
2506
3492
|
# iam_role_arn: "AmazonResourceName", # required
|
2507
3493
|
# delivery_stream_arn: "AmazonResourceName", # required
|
@@ -2533,6 +3519,165 @@ module Aws::SESV2
|
|
2533
3519
|
req.send_request(options)
|
2534
3520
|
end
|
2535
3521
|
|
3522
|
+
# Updates an existing custom verification email template.
|
3523
|
+
#
|
3524
|
+
# For more information about custom verification email templates, see
|
3525
|
+
# [Using Custom Verification Email Templates][1] in the *Amazon SES
|
3526
|
+
# Developer Guide*.
|
3527
|
+
#
|
3528
|
+
# You can execute this operation no more than once per second.
|
3529
|
+
#
|
3530
|
+
#
|
3531
|
+
#
|
3532
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-email-verify-address-custom.html
|
3533
|
+
#
|
3534
|
+
# @option params [required, String] :template_name
|
3535
|
+
# The name of the custom verification email template that you want to
|
3536
|
+
# update.
|
3537
|
+
#
|
3538
|
+
# @option params [required, String] :from_email_address
|
3539
|
+
# The email address that the custom verification email is sent from.
|
3540
|
+
#
|
3541
|
+
# @option params [required, String] :template_subject
|
3542
|
+
# The subject line of the custom verification email.
|
3543
|
+
#
|
3544
|
+
# @option params [required, String] :template_content
|
3545
|
+
# The content of the custom verification email. The total size of the
|
3546
|
+
# email must be less than 10 MB. The message body may contain HTML, with
|
3547
|
+
# some limitations. For more information, see [Custom Verification Email
|
3548
|
+
# Frequently Asked Questions][1] in the *Amazon SES Developer Guide*.
|
3549
|
+
#
|
3550
|
+
#
|
3551
|
+
#
|
3552
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-email-verify-address-custom.html#custom-verification-emails-faq
|
3553
|
+
#
|
3554
|
+
# @option params [required, String] :success_redirection_url
|
3555
|
+
# The URL that the recipient of the verification email is sent to if his
|
3556
|
+
# or her address is successfully verified.
|
3557
|
+
#
|
3558
|
+
# @option params [required, String] :failure_redirection_url
|
3559
|
+
# The URL that the recipient of the verification email is sent to if his
|
3560
|
+
# or her address is not successfully verified.
|
3561
|
+
#
|
3562
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
3563
|
+
#
|
3564
|
+
# @example Request syntax with placeholder values
|
3565
|
+
#
|
3566
|
+
# resp = client.update_custom_verification_email_template({
|
3567
|
+
# template_name: "EmailTemplateName", # required
|
3568
|
+
# from_email_address: "EmailAddress", # required
|
3569
|
+
# template_subject: "EmailTemplateSubject", # required
|
3570
|
+
# template_content: "TemplateContent", # required
|
3571
|
+
# success_redirection_url: "SuccessRedirectionURL", # required
|
3572
|
+
# failure_redirection_url: "FailureRedirectionURL", # required
|
3573
|
+
# })
|
3574
|
+
#
|
3575
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/UpdateCustomVerificationEmailTemplate AWS API Documentation
|
3576
|
+
#
|
3577
|
+
# @overload update_custom_verification_email_template(params = {})
|
3578
|
+
# @param [Hash] params ({})
|
3579
|
+
def update_custom_verification_email_template(params = {}, options = {})
|
3580
|
+
req = build_request(:update_custom_verification_email_template, params)
|
3581
|
+
req.send_request(options)
|
3582
|
+
end
|
3583
|
+
|
3584
|
+
# Updates the specified sending authorization policy for the given
|
3585
|
+
# identity (an email address or a domain). This API returns successfully
|
3586
|
+
# even if a policy with the specified name does not exist.
|
3587
|
+
#
|
3588
|
+
# <note markdown="1"> This API is for the identity owner only. If you have not verified the
|
3589
|
+
# identity, this API will return an error.
|
3590
|
+
#
|
3591
|
+
# </note>
|
3592
|
+
#
|
3593
|
+
# Sending authorization is a feature that enables an identity owner to
|
3594
|
+
# authorize other senders to use its identities. For information about
|
3595
|
+
# using sending authorization, see the [Amazon SES Developer Guide][1].
|
3596
|
+
#
|
3597
|
+
# You can execute this operation no more than once per second.
|
3598
|
+
#
|
3599
|
+
#
|
3600
|
+
#
|
3601
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html
|
3602
|
+
#
|
3603
|
+
# @option params [required, String] :email_identity
|
3604
|
+
# The email identity for which you want to update policy.
|
3605
|
+
#
|
3606
|
+
# @option params [required, String] :policy_name
|
3607
|
+
# The name of the policy.
|
3608
|
+
#
|
3609
|
+
# The policy name cannot exceed 64 characters and can only include
|
3610
|
+
# alphanumeric characters, dashes, and underscores.
|
3611
|
+
#
|
3612
|
+
# @option params [required, String] :policy
|
3613
|
+
# The text of the policy in JSON format. The policy cannot exceed 4 KB.
|
3614
|
+
#
|
3615
|
+
# For information about the syntax of sending authorization policies,
|
3616
|
+
# see the [Amazon SES Developer Guide][1].
|
3617
|
+
#
|
3618
|
+
#
|
3619
|
+
#
|
3620
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization-policies.html
|
3621
|
+
#
|
3622
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
3623
|
+
#
|
3624
|
+
# @example Request syntax with placeholder values
|
3625
|
+
#
|
3626
|
+
# resp = client.update_email_identity_policy({
|
3627
|
+
# email_identity: "Identity", # required
|
3628
|
+
# policy_name: "PolicyName", # required
|
3629
|
+
# policy: "Policy", # required
|
3630
|
+
# })
|
3631
|
+
#
|
3632
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/UpdateEmailIdentityPolicy AWS API Documentation
|
3633
|
+
#
|
3634
|
+
# @overload update_email_identity_policy(params = {})
|
3635
|
+
# @param [Hash] params ({})
|
3636
|
+
def update_email_identity_policy(params = {}, options = {})
|
3637
|
+
req = build_request(:update_email_identity_policy, params)
|
3638
|
+
req.send_request(options)
|
3639
|
+
end
|
3640
|
+
|
3641
|
+
# Updates an email template. Email templates enable you to send
|
3642
|
+
# personalized email to one or more destinations in a single API
|
3643
|
+
# operation. For more information, see the [Amazon SES Developer
|
3644
|
+
# Guide][1].
|
3645
|
+
#
|
3646
|
+
# You can execute this operation no more than once per second.
|
3647
|
+
#
|
3648
|
+
#
|
3649
|
+
#
|
3650
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-personalized-email-api.html
|
3651
|
+
#
|
3652
|
+
# @option params [required, String] :template_name
|
3653
|
+
# The name of the template you want to update.
|
3654
|
+
#
|
3655
|
+
# @option params [required, Types::EmailTemplateContent] :template_content
|
3656
|
+
# The content of the email template, composed of a subject line, an HTML
|
3657
|
+
# part, and a text-only part.
|
3658
|
+
#
|
3659
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
3660
|
+
#
|
3661
|
+
# @example Request syntax with placeholder values
|
3662
|
+
#
|
3663
|
+
# resp = client.update_email_template({
|
3664
|
+
# template_name: "EmailTemplateName", # required
|
3665
|
+
# template_content: { # required
|
3666
|
+
# subject: "EmailTemplateSubject",
|
3667
|
+
# text: "EmailTemplateText",
|
3668
|
+
# html: "EmailTemplateHtml",
|
3669
|
+
# },
|
3670
|
+
# })
|
3671
|
+
#
|
3672
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/UpdateEmailTemplate AWS API Documentation
|
3673
|
+
#
|
3674
|
+
# @overload update_email_template(params = {})
|
3675
|
+
# @param [Hash] params ({})
|
3676
|
+
def update_email_template(params = {}, options = {})
|
3677
|
+
req = build_request(:update_email_template, params)
|
3678
|
+
req.send_request(options)
|
3679
|
+
end
|
3680
|
+
|
2536
3681
|
# @!endgroup
|
2537
3682
|
|
2538
3683
|
# @param params ({})
|
@@ -2546,7 +3691,7 @@ module Aws::SESV2
|
|
2546
3691
|
params: params,
|
2547
3692
|
config: config)
|
2548
3693
|
context[:gem_name] = 'aws-sdk-sesv2'
|
2549
|
-
context[:gem_version] = '1.
|
3694
|
+
context[:gem_version] = '1.10.0'
|
2550
3695
|
Seahorse::Client::Request.new(handlers, context)
|
2551
3696
|
end
|
2552
3697
|
|