aws-sdk-sesv2 1.8.0 → 1.13.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/lib/aws-sdk-sesv2.rb +3 -2
- data/lib/aws-sdk-sesv2/client.rb +1181 -25
- data/lib/aws-sdk-sesv2/client_api.rb +618 -5
- data/lib/aws-sdk-sesv2/errors.rb +11 -0
- data/lib/aws-sdk-sesv2/types.rb +1902 -61
- 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: 342d0401e8d053ab7cad206dd78ffc6709bea2702d819e57192c2b599315fee8
|
4
|
+
data.tar.gz: 4752965704ff594ec36fbfd057568704312761a169d95e30f9b0cb07fa2d6e9e
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: a1777b5cbe044dd9a37390b3c787f4167f0b2202498d3bea3ac3c0ac29f110de305aeb1e99f073c9ff4622a2798fe7066556c017d899f3135be8dc92cc2f3985
|
7
|
+
data.tar.gz: 8fb0639aaf38957af91c41fb59f51b987baeee9d2444be2f4a17e05ba0085e55de1f40e6e97ef3aaefc4abe74a9b4392527e759d54f54b87b86f72ba7cd05d46
|
data/lib/aws-sdk-sesv2.rb
CHANGED
@@ -7,6 +7,7 @@
|
|
7
7
|
#
|
8
8
|
# WARNING ABOUT GENERATED CODE
|
9
9
|
|
10
|
+
|
10
11
|
require 'aws-sdk-core'
|
11
12
|
require 'aws-sigv4'
|
12
13
|
|
@@ -44,9 +45,9 @@ require_relative 'aws-sdk-sesv2/customizations'
|
|
44
45
|
#
|
45
46
|
# See {Errors} for more information.
|
46
47
|
#
|
47
|
-
#
|
48
|
+
# @!group service
|
48
49
|
module Aws::SESV2
|
49
50
|
|
50
|
-
GEM_VERSION = '1.
|
51
|
+
GEM_VERSION = '1.13.0'
|
51
52
|
|
52
53
|
end
|
data/lib/aws-sdk-sesv2/client.rb
CHANGED
@@ -85,13 +85,28 @@ module Aws::SESV2
|
|
85
85
|
# * `Aws::Credentials` - Used for configuring static, non-refreshing
|
86
86
|
# credentials.
|
87
87
|
#
|
88
|
+
# * `Aws::SharedCredentials` - Used for loading static credentials from a
|
89
|
+
# shared file, such as `~/.aws/config`.
|
90
|
+
#
|
91
|
+
# * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
|
92
|
+
#
|
93
|
+
# * `Aws::AssumeRoleWebIdentityCredentials` - Used when you need to
|
94
|
+
# assume a role after providing credentials via the web.
|
95
|
+
#
|
96
|
+
# * `Aws::SSOCredentials` - Used for loading credentials from AWS SSO using an
|
97
|
+
# access token generated from `aws login`.
|
98
|
+
#
|
99
|
+
# * `Aws::ProcessCredentials` - Used for loading credentials from a
|
100
|
+
# process that outputs to stdout.
|
101
|
+
#
|
88
102
|
# * `Aws::InstanceProfileCredentials` - Used for loading credentials
|
89
103
|
# from an EC2 IMDS on an EC2 instance.
|
90
104
|
#
|
91
|
-
# * `Aws::
|
92
|
-
#
|
105
|
+
# * `Aws::ECSCredentials` - Used for loading credentials from
|
106
|
+
# instances running in ECS.
|
93
107
|
#
|
94
|
-
# * `Aws::
|
108
|
+
# * `Aws::CognitoIdentityCredentials` - Used for loading credentials
|
109
|
+
# from the Cognito Identity service.
|
95
110
|
#
|
96
111
|
# When `:credentials` are not configured directly, the following
|
97
112
|
# locations will be searched for credentials:
|
@@ -101,10 +116,10 @@ module Aws::SESV2
|
|
101
116
|
# * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
|
102
117
|
# * `~/.aws/credentials`
|
103
118
|
# * `~/.aws/config`
|
104
|
-
# * EC2 IMDS instance profile - When used by default, the timeouts
|
105
|
-
# very aggressive. Construct and pass an instance of
|
106
|
-
# `Aws::InstanceProfileCredentails`
|
107
|
-
# timeouts.
|
119
|
+
# * EC2/ECS IMDS instance profile - When used by default, the timeouts
|
120
|
+
# are very aggressive. Construct and pass an instance of
|
121
|
+
# `Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to
|
122
|
+
# enable retries and extended timeouts.
|
108
123
|
#
|
109
124
|
# @option options [required, String] :region
|
110
125
|
# The AWS region to connect to. The configured `:region` is
|
@@ -449,6 +464,67 @@ module Aws::SESV2
|
|
449
464
|
req.send_request(options)
|
450
465
|
end
|
451
466
|
|
467
|
+
# Creates a new custom verification email template.
|
468
|
+
#
|
469
|
+
# For more information about custom verification email templates, see
|
470
|
+
# [Using Custom Verification Email Templates][1] in the *Amazon SES
|
471
|
+
# Developer Guide*.
|
472
|
+
#
|
473
|
+
# You can execute this operation no more than once per second.
|
474
|
+
#
|
475
|
+
#
|
476
|
+
#
|
477
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-email-verify-address-custom.html
|
478
|
+
#
|
479
|
+
# @option params [required, String] :template_name
|
480
|
+
# The name of the custom verification email template.
|
481
|
+
#
|
482
|
+
# @option params [required, String] :from_email_address
|
483
|
+
# The email address that the custom verification email is sent from.
|
484
|
+
#
|
485
|
+
# @option params [required, String] :template_subject
|
486
|
+
# The subject line of the custom verification email.
|
487
|
+
#
|
488
|
+
# @option params [required, String] :template_content
|
489
|
+
# The content of the custom verification email. The total size of the
|
490
|
+
# email must be less than 10 MB. The message body may contain HTML, with
|
491
|
+
# some limitations. For more information, see [Custom Verification Email
|
492
|
+
# Frequently Asked Questions][1] in the *Amazon SES Developer Guide*.
|
493
|
+
#
|
494
|
+
#
|
495
|
+
#
|
496
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-email-verify-address-custom.html#custom-verification-emails-faq
|
497
|
+
#
|
498
|
+
# @option params [required, String] :success_redirection_url
|
499
|
+
# The URL that the recipient of the verification email is sent to if his
|
500
|
+
# or her address is successfully verified.
|
501
|
+
#
|
502
|
+
# @option params [required, String] :failure_redirection_url
|
503
|
+
# The URL that the recipient of the verification email is sent to if his
|
504
|
+
# or her address is not successfully verified.
|
505
|
+
#
|
506
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
507
|
+
#
|
508
|
+
# @example Request syntax with placeholder values
|
509
|
+
#
|
510
|
+
# resp = client.create_custom_verification_email_template({
|
511
|
+
# template_name: "EmailTemplateName", # required
|
512
|
+
# from_email_address: "EmailAddress", # required
|
513
|
+
# template_subject: "EmailTemplateSubject", # required
|
514
|
+
# template_content: "TemplateContent", # required
|
515
|
+
# success_redirection_url: "SuccessRedirectionURL", # required
|
516
|
+
# failure_redirection_url: "FailureRedirectionURL", # required
|
517
|
+
# })
|
518
|
+
#
|
519
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/CreateCustomVerificationEmailTemplate AWS API Documentation
|
520
|
+
#
|
521
|
+
# @overload create_custom_verification_email_template(params = {})
|
522
|
+
# @param [Hash] params ({})
|
523
|
+
def create_custom_verification_email_template(params = {}, options = {})
|
524
|
+
req = build_request(:create_custom_verification_email_template, params)
|
525
|
+
req.send_request(options)
|
526
|
+
end
|
527
|
+
|
452
528
|
# Create a new pool of dedicated IP addresses. A pool can include one or
|
453
529
|
# more dedicated IP addresses that are associated with your AWS account.
|
454
530
|
# You can associate a pool with a configuration set. When you send an
|
@@ -542,8 +618,9 @@ module Aws::SESV2
|
|
542
618
|
# data: "data", # required
|
543
619
|
# },
|
544
620
|
# template: {
|
545
|
-
#
|
546
|
-
#
|
621
|
+
# template_name: "EmailTemplateName",
|
622
|
+
# template_arn: "AmazonResourceName",
|
623
|
+
# template_data: "EmailTemplateData",
|
547
624
|
# },
|
548
625
|
# },
|
549
626
|
# tags: [
|
@@ -660,6 +737,141 @@ module Aws::SESV2
|
|
660
737
|
req.send_request(options)
|
661
738
|
end
|
662
739
|
|
740
|
+
# Creates the specified sending authorization policy for the given
|
741
|
+
# identity (an email address or a domain).
|
742
|
+
#
|
743
|
+
# <note markdown="1"> This API is for the identity owner only. If you have not verified the
|
744
|
+
# identity, this API will return an error.
|
745
|
+
#
|
746
|
+
# </note>
|
747
|
+
#
|
748
|
+
# Sending authorization is a feature that enables an identity owner to
|
749
|
+
# authorize other senders to use its identities. For information about
|
750
|
+
# using sending authorization, see the [Amazon SES Developer Guide][1].
|
751
|
+
#
|
752
|
+
# You can execute this operation no more than once per second.
|
753
|
+
#
|
754
|
+
#
|
755
|
+
#
|
756
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html
|
757
|
+
#
|
758
|
+
# @option params [required, String] :email_identity
|
759
|
+
# The email identity for which you want to create a policy.
|
760
|
+
#
|
761
|
+
# @option params [required, String] :policy_name
|
762
|
+
# The name of the policy.
|
763
|
+
#
|
764
|
+
# The policy name cannot exceed 64 characters and can only include
|
765
|
+
# alphanumeric characters, dashes, and underscores.
|
766
|
+
#
|
767
|
+
# @option params [required, String] :policy
|
768
|
+
# The text of the policy in JSON format. The policy cannot exceed 4 KB.
|
769
|
+
#
|
770
|
+
# For information about the syntax of sending authorization policies,
|
771
|
+
# see the [Amazon SES Developer Guide][1].
|
772
|
+
#
|
773
|
+
#
|
774
|
+
#
|
775
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization-policies.html
|
776
|
+
#
|
777
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
778
|
+
#
|
779
|
+
# @example Request syntax with placeholder values
|
780
|
+
#
|
781
|
+
# resp = client.create_email_identity_policy({
|
782
|
+
# email_identity: "Identity", # required
|
783
|
+
# policy_name: "PolicyName", # required
|
784
|
+
# policy: "Policy", # required
|
785
|
+
# })
|
786
|
+
#
|
787
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/CreateEmailIdentityPolicy AWS API Documentation
|
788
|
+
#
|
789
|
+
# @overload create_email_identity_policy(params = {})
|
790
|
+
# @param [Hash] params ({})
|
791
|
+
def create_email_identity_policy(params = {}, options = {})
|
792
|
+
req = build_request(:create_email_identity_policy, params)
|
793
|
+
req.send_request(options)
|
794
|
+
end
|
795
|
+
|
796
|
+
# Creates an email template. Email templates enable you to send
|
797
|
+
# personalized email to one or more destinations in a single API
|
798
|
+
# operation. For more information, see the [Amazon SES Developer
|
799
|
+
# Guide][1].
|
800
|
+
#
|
801
|
+
# You can execute this operation no more than once per second.
|
802
|
+
#
|
803
|
+
#
|
804
|
+
#
|
805
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-personalized-email-api.html
|
806
|
+
#
|
807
|
+
# @option params [required, String] :template_name
|
808
|
+
# The name of the template you want to create.
|
809
|
+
#
|
810
|
+
# @option params [required, Types::EmailTemplateContent] :template_content
|
811
|
+
# The content of the email template, composed of a subject line, an HTML
|
812
|
+
# part, and a text-only part.
|
813
|
+
#
|
814
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
815
|
+
#
|
816
|
+
# @example Request syntax with placeholder values
|
817
|
+
#
|
818
|
+
# resp = client.create_email_template({
|
819
|
+
# template_name: "EmailTemplateName", # required
|
820
|
+
# template_content: { # required
|
821
|
+
# subject: "EmailTemplateSubject",
|
822
|
+
# text: "EmailTemplateText",
|
823
|
+
# html: "EmailTemplateHtml",
|
824
|
+
# },
|
825
|
+
# })
|
826
|
+
#
|
827
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/CreateEmailTemplate AWS API Documentation
|
828
|
+
#
|
829
|
+
# @overload create_email_template(params = {})
|
830
|
+
# @param [Hash] params ({})
|
831
|
+
def create_email_template(params = {}, options = {})
|
832
|
+
req = build_request(:create_email_template, params)
|
833
|
+
req.send_request(options)
|
834
|
+
end
|
835
|
+
|
836
|
+
# Creates an import job for a data destination.
|
837
|
+
#
|
838
|
+
# @option params [required, Types::ImportDestination] :import_destination
|
839
|
+
# The destination for the import job.
|
840
|
+
#
|
841
|
+
# @option params [required, Types::ImportDataSource] :import_data_source
|
842
|
+
# The data source for the import job.
|
843
|
+
#
|
844
|
+
# @return [Types::CreateImportJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
845
|
+
#
|
846
|
+
# * {Types::CreateImportJobResponse#job_id #job_id} => String
|
847
|
+
#
|
848
|
+
# @example Request syntax with placeholder values
|
849
|
+
#
|
850
|
+
# resp = client.create_import_job({
|
851
|
+
# import_destination: { # required
|
852
|
+
# suppression_list_destination: { # required
|
853
|
+
# suppression_list_import_action: "DELETE", # required, accepts DELETE, PUT
|
854
|
+
# },
|
855
|
+
# },
|
856
|
+
# import_data_source: { # required
|
857
|
+
# s3_url: "S3Url", # required
|
858
|
+
# data_format: "CSV", # required, accepts CSV, JSON
|
859
|
+
# },
|
860
|
+
# })
|
861
|
+
#
|
862
|
+
# @example Response structure
|
863
|
+
#
|
864
|
+
# resp.job_id #=> String
|
865
|
+
#
|
866
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/CreateImportJob AWS API Documentation
|
867
|
+
#
|
868
|
+
# @overload create_import_job(params = {})
|
869
|
+
# @param [Hash] params ({})
|
870
|
+
def create_import_job(params = {}, options = {})
|
871
|
+
req = build_request(:create_import_job, params)
|
872
|
+
req.send_request(options)
|
873
|
+
end
|
874
|
+
|
663
875
|
# Delete an existing configuration set.
|
664
876
|
#
|
665
877
|
# *Configuration sets* are groups of rules that you can apply to the
|
@@ -722,6 +934,39 @@ module Aws::SESV2
|
|
722
934
|
req.send_request(options)
|
723
935
|
end
|
724
936
|
|
937
|
+
# Deletes an existing custom verification email template.
|
938
|
+
#
|
939
|
+
# For more information about custom verification email templates, see
|
940
|
+
# [Using Custom Verification Email Templates][1] in the *Amazon SES
|
941
|
+
# Developer Guide*.
|
942
|
+
#
|
943
|
+
# You can execute this operation no more than once per second.
|
944
|
+
#
|
945
|
+
#
|
946
|
+
#
|
947
|
+
# [1]: https://docs.aws.amazon.com/es/latest/DeveloperGuide/send-email-verify-address-custom.html
|
948
|
+
#
|
949
|
+
# @option params [required, String] :template_name
|
950
|
+
# The name of the custom verification email template that you want to
|
951
|
+
# delete.
|
952
|
+
#
|
953
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
954
|
+
#
|
955
|
+
# @example Request syntax with placeholder values
|
956
|
+
#
|
957
|
+
# resp = client.delete_custom_verification_email_template({
|
958
|
+
# template_name: "EmailTemplateName", # required
|
959
|
+
# })
|
960
|
+
#
|
961
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/DeleteCustomVerificationEmailTemplate AWS API Documentation
|
962
|
+
#
|
963
|
+
# @overload delete_custom_verification_email_template(params = {})
|
964
|
+
# @param [Hash] params ({})
|
965
|
+
def delete_custom_verification_email_template(params = {}, options = {})
|
966
|
+
req = build_request(:delete_custom_verification_email_template, params)
|
967
|
+
req.send_request(options)
|
968
|
+
end
|
969
|
+
|
725
970
|
# Delete a dedicated IP pool.
|
726
971
|
#
|
727
972
|
# @option params [required, String] :pool_name
|
@@ -768,6 +1013,76 @@ module Aws::SESV2
|
|
768
1013
|
req.send_request(options)
|
769
1014
|
end
|
770
1015
|
|
1016
|
+
# Deletes the specified sending authorization policy for the given
|
1017
|
+
# identity (an email address or a domain). This API returns successfully
|
1018
|
+
# even if a policy with the specified name does not exist.
|
1019
|
+
#
|
1020
|
+
# <note markdown="1"> This API is for the identity owner only. If you have not verified the
|
1021
|
+
# identity, this API will return an error.
|
1022
|
+
#
|
1023
|
+
# </note>
|
1024
|
+
#
|
1025
|
+
# Sending authorization is a feature that enables an identity owner to
|
1026
|
+
# authorize other senders to use its identities. For information about
|
1027
|
+
# using sending authorization, see the [Amazon SES Developer Guide][1].
|
1028
|
+
#
|
1029
|
+
# You can execute this operation no more than once per second.
|
1030
|
+
#
|
1031
|
+
#
|
1032
|
+
#
|
1033
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html
|
1034
|
+
#
|
1035
|
+
# @option params [required, String] :email_identity
|
1036
|
+
# The email identity for which you want to delete a policy.
|
1037
|
+
#
|
1038
|
+
# @option params [required, String] :policy_name
|
1039
|
+
# The name of the policy.
|
1040
|
+
#
|
1041
|
+
# The policy name cannot exceed 64 characters and can only include
|
1042
|
+
# alphanumeric characters, dashes, and underscores.
|
1043
|
+
#
|
1044
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1045
|
+
#
|
1046
|
+
# @example Request syntax with placeholder values
|
1047
|
+
#
|
1048
|
+
# resp = client.delete_email_identity_policy({
|
1049
|
+
# email_identity: "Identity", # required
|
1050
|
+
# policy_name: "PolicyName", # required
|
1051
|
+
# })
|
1052
|
+
#
|
1053
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/DeleteEmailIdentityPolicy AWS API Documentation
|
1054
|
+
#
|
1055
|
+
# @overload delete_email_identity_policy(params = {})
|
1056
|
+
# @param [Hash] params ({})
|
1057
|
+
def delete_email_identity_policy(params = {}, options = {})
|
1058
|
+
req = build_request(:delete_email_identity_policy, params)
|
1059
|
+
req.send_request(options)
|
1060
|
+
end
|
1061
|
+
|
1062
|
+
# Deletes an email template.
|
1063
|
+
#
|
1064
|
+
# You can execute this operation no more than once per second.
|
1065
|
+
#
|
1066
|
+
# @option params [required, String] :template_name
|
1067
|
+
# The name of the template to be deleted.
|
1068
|
+
#
|
1069
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1070
|
+
#
|
1071
|
+
# @example Request syntax with placeholder values
|
1072
|
+
#
|
1073
|
+
# resp = client.delete_email_template({
|
1074
|
+
# template_name: "EmailTemplateName", # required
|
1075
|
+
# })
|
1076
|
+
#
|
1077
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/DeleteEmailTemplate AWS API Documentation
|
1078
|
+
#
|
1079
|
+
# @overload delete_email_template(params = {})
|
1080
|
+
# @param [Hash] params ({})
|
1081
|
+
def delete_email_template(params = {}, options = {})
|
1082
|
+
req = build_request(:delete_email_template, params)
|
1083
|
+
req.send_request(options)
|
1084
|
+
end
|
1085
|
+
|
771
1086
|
# Removes an email address from the suppression list for your account.
|
772
1087
|
#
|
773
1088
|
# @option params [required, String] :email_address
|
@@ -802,6 +1117,7 @@ module Aws::SESV2
|
|
802
1117
|
# * {Types::GetAccountResponse#send_quota #send_quota} => Types::SendQuota
|
803
1118
|
# * {Types::GetAccountResponse#sending_enabled #sending_enabled} => Boolean
|
804
1119
|
# * {Types::GetAccountResponse#suppression_attributes #suppression_attributes} => Types::SuppressionAttributes
|
1120
|
+
# * {Types::GetAccountResponse#details #details} => Types::AccountDetails
|
805
1121
|
#
|
806
1122
|
# @example Response structure
|
807
1123
|
#
|
@@ -814,6 +1130,14 @@ module Aws::SESV2
|
|
814
1130
|
# resp.sending_enabled #=> Boolean
|
815
1131
|
# resp.suppression_attributes.suppressed_reasons #=> Array
|
816
1132
|
# resp.suppression_attributes.suppressed_reasons[0] #=> String, one of "BOUNCE", "COMPLAINT"
|
1133
|
+
# resp.details.mail_type #=> String, one of "MARKETING", "TRANSACTIONAL"
|
1134
|
+
# resp.details.website_url #=> String
|
1135
|
+
# resp.details.contact_language #=> String, one of "EN", "JA"
|
1136
|
+
# resp.details.use_case_description #=> String
|
1137
|
+
# resp.details.additional_contact_email_addresses #=> Array
|
1138
|
+
# resp.details.additional_contact_email_addresses[0] #=> String
|
1139
|
+
# resp.details.review_details.status #=> String, one of "PENDING", "FAILED", "GRANTED", "DENIED"
|
1140
|
+
# resp.details.review_details.case_id #=> String
|
817
1141
|
#
|
818
1142
|
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/GetAccount AWS API Documentation
|
819
1143
|
#
|
@@ -961,6 +1285,56 @@ module Aws::SESV2
|
|
961
1285
|
req.send_request(options)
|
962
1286
|
end
|
963
1287
|
|
1288
|
+
# Returns the custom email verification template for the template name
|
1289
|
+
# you specify.
|
1290
|
+
#
|
1291
|
+
# For more information about custom verification email templates, see
|
1292
|
+
# [Using Custom Verification Email Templates][1] in the *Amazon SES
|
1293
|
+
# Developer Guide*.
|
1294
|
+
#
|
1295
|
+
# You can execute this operation no more than once per second.
|
1296
|
+
#
|
1297
|
+
#
|
1298
|
+
#
|
1299
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-email-verify-address-custom.html
|
1300
|
+
#
|
1301
|
+
# @option params [required, String] :template_name
|
1302
|
+
# The name of the custom verification email template that you want to
|
1303
|
+
# retrieve.
|
1304
|
+
#
|
1305
|
+
# @return [Types::GetCustomVerificationEmailTemplateResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1306
|
+
#
|
1307
|
+
# * {Types::GetCustomVerificationEmailTemplateResponse#template_name #template_name} => String
|
1308
|
+
# * {Types::GetCustomVerificationEmailTemplateResponse#from_email_address #from_email_address} => String
|
1309
|
+
# * {Types::GetCustomVerificationEmailTemplateResponse#template_subject #template_subject} => String
|
1310
|
+
# * {Types::GetCustomVerificationEmailTemplateResponse#template_content #template_content} => String
|
1311
|
+
# * {Types::GetCustomVerificationEmailTemplateResponse#success_redirection_url #success_redirection_url} => String
|
1312
|
+
# * {Types::GetCustomVerificationEmailTemplateResponse#failure_redirection_url #failure_redirection_url} => String
|
1313
|
+
#
|
1314
|
+
# @example Request syntax with placeholder values
|
1315
|
+
#
|
1316
|
+
# resp = client.get_custom_verification_email_template({
|
1317
|
+
# template_name: "EmailTemplateName", # required
|
1318
|
+
# })
|
1319
|
+
#
|
1320
|
+
# @example Response structure
|
1321
|
+
#
|
1322
|
+
# resp.template_name #=> String
|
1323
|
+
# resp.from_email_address #=> String
|
1324
|
+
# resp.template_subject #=> String
|
1325
|
+
# resp.template_content #=> String
|
1326
|
+
# resp.success_redirection_url #=> String
|
1327
|
+
# resp.failure_redirection_url #=> String
|
1328
|
+
#
|
1329
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/GetCustomVerificationEmailTemplate AWS API Documentation
|
1330
|
+
#
|
1331
|
+
# @overload get_custom_verification_email_template(params = {})
|
1332
|
+
# @param [Hash] params ({})
|
1333
|
+
def get_custom_verification_email_template(params = {}, options = {})
|
1334
|
+
req = build_request(:get_custom_verification_email_template, params)
|
1335
|
+
req.send_request(options)
|
1336
|
+
end
|
1337
|
+
|
964
1338
|
# Get information about a dedicated IP address, including the name of
|
965
1339
|
# the dedicated IP pool that it's associated with, as well information
|
966
1340
|
# about the automatic warm-up process for the address.
|
@@ -1260,8 +1634,8 @@ module Aws::SESV2
|
|
1260
1634
|
end
|
1261
1635
|
|
1262
1636
|
# Provides information about a specific identity, including the
|
1263
|
-
# identity's verification status,
|
1264
|
-
# its custom Mail-From settings.
|
1637
|
+
# identity's verification status, sending authorization policies, its
|
1638
|
+
# DKIM authentication status, and its custom Mail-From settings.
|
1265
1639
|
#
|
1266
1640
|
# @option params [required, String] :email_identity
|
1267
1641
|
# The email identity that you want to retrieve details for.
|
@@ -1273,6 +1647,7 @@ module Aws::SESV2
|
|
1273
1647
|
# * {Types::GetEmailIdentityResponse#verified_for_sending_status #verified_for_sending_status} => Boolean
|
1274
1648
|
# * {Types::GetEmailIdentityResponse#dkim_attributes #dkim_attributes} => Types::DkimAttributes
|
1275
1649
|
# * {Types::GetEmailIdentityResponse#mail_from_attributes #mail_from_attributes} => Types::MailFromAttributes
|
1650
|
+
# * {Types::GetEmailIdentityResponse#policies #policies} => Hash<String,String>
|
1276
1651
|
# * {Types::GetEmailIdentityResponse#tags #tags} => Array<Types::Tag>
|
1277
1652
|
#
|
1278
1653
|
# @example Request syntax with placeholder values
|
@@ -1294,6 +1669,8 @@ module Aws::SESV2
|
|
1294
1669
|
# resp.mail_from_attributes.mail_from_domain #=> String
|
1295
1670
|
# resp.mail_from_attributes.mail_from_domain_status #=> String, one of "PENDING", "SUCCESS", "FAILED", "TEMPORARY_FAILURE"
|
1296
1671
|
# resp.mail_from_attributes.behavior_on_mx_failure #=> String, one of "USE_DEFAULT_VALUE", "REJECT_MESSAGE"
|
1672
|
+
# resp.policies #=> Hash
|
1673
|
+
# resp.policies["PolicyName"] #=> String
|
1297
1674
|
# resp.tags #=> Array
|
1298
1675
|
# resp.tags[0].key #=> String
|
1299
1676
|
# resp.tags[0].value #=> String
|
@@ -1307,6 +1684,134 @@ module Aws::SESV2
|
|
1307
1684
|
req.send_request(options)
|
1308
1685
|
end
|
1309
1686
|
|
1687
|
+
# Returns the requested sending authorization policies for the given
|
1688
|
+
# identity (an email address or a domain). The policies are returned as
|
1689
|
+
# a map of policy names to policy contents. You can retrieve a maximum
|
1690
|
+
# of 20 policies at a time.
|
1691
|
+
#
|
1692
|
+
# <note markdown="1"> This API is for the identity owner only. If you have not verified the
|
1693
|
+
# identity, this API will return an error.
|
1694
|
+
#
|
1695
|
+
# </note>
|
1696
|
+
#
|
1697
|
+
# Sending authorization is a feature that enables an identity owner to
|
1698
|
+
# authorize other senders to use its identities. For information about
|
1699
|
+
# using sending authorization, see the [Amazon SES Developer Guide][1].
|
1700
|
+
#
|
1701
|
+
# You can execute this operation no more than once per second.
|
1702
|
+
#
|
1703
|
+
#
|
1704
|
+
#
|
1705
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html
|
1706
|
+
#
|
1707
|
+
# @option params [required, String] :email_identity
|
1708
|
+
# The email identity that you want to retrieve policies for.
|
1709
|
+
#
|
1710
|
+
# @return [Types::GetEmailIdentityPoliciesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1711
|
+
#
|
1712
|
+
# * {Types::GetEmailIdentityPoliciesResponse#policies #policies} => Hash<String,String>
|
1713
|
+
#
|
1714
|
+
# @example Request syntax with placeholder values
|
1715
|
+
#
|
1716
|
+
# resp = client.get_email_identity_policies({
|
1717
|
+
# email_identity: "Identity", # required
|
1718
|
+
# })
|
1719
|
+
#
|
1720
|
+
# @example Response structure
|
1721
|
+
#
|
1722
|
+
# resp.policies #=> Hash
|
1723
|
+
# resp.policies["PolicyName"] #=> String
|
1724
|
+
#
|
1725
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/GetEmailIdentityPolicies AWS API Documentation
|
1726
|
+
#
|
1727
|
+
# @overload get_email_identity_policies(params = {})
|
1728
|
+
# @param [Hash] params ({})
|
1729
|
+
def get_email_identity_policies(params = {}, options = {})
|
1730
|
+
req = build_request(:get_email_identity_policies, params)
|
1731
|
+
req.send_request(options)
|
1732
|
+
end
|
1733
|
+
|
1734
|
+
# Displays the template object (which includes the subject line, HTML
|
1735
|
+
# part and text part) for the template you specify.
|
1736
|
+
#
|
1737
|
+
# You can execute this operation no more than once per second.
|
1738
|
+
#
|
1739
|
+
# @option params [required, String] :template_name
|
1740
|
+
# The name of the template you want to retrieve.
|
1741
|
+
#
|
1742
|
+
# @return [Types::GetEmailTemplateResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1743
|
+
#
|
1744
|
+
# * {Types::GetEmailTemplateResponse#template_name #template_name} => String
|
1745
|
+
# * {Types::GetEmailTemplateResponse#template_content #template_content} => Types::EmailTemplateContent
|
1746
|
+
#
|
1747
|
+
# @example Request syntax with placeholder values
|
1748
|
+
#
|
1749
|
+
# resp = client.get_email_template({
|
1750
|
+
# template_name: "EmailTemplateName", # required
|
1751
|
+
# })
|
1752
|
+
#
|
1753
|
+
# @example Response structure
|
1754
|
+
#
|
1755
|
+
# resp.template_name #=> String
|
1756
|
+
# resp.template_content.subject #=> String
|
1757
|
+
# resp.template_content.text #=> String
|
1758
|
+
# resp.template_content.html #=> String
|
1759
|
+
#
|
1760
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/GetEmailTemplate AWS API Documentation
|
1761
|
+
#
|
1762
|
+
# @overload get_email_template(params = {})
|
1763
|
+
# @param [Hash] params ({})
|
1764
|
+
def get_email_template(params = {}, options = {})
|
1765
|
+
req = build_request(:get_email_template, params)
|
1766
|
+
req.send_request(options)
|
1767
|
+
end
|
1768
|
+
|
1769
|
+
# Provides information about an import job.
|
1770
|
+
#
|
1771
|
+
# @option params [required, String] :job_id
|
1772
|
+
# The ID of the import job.
|
1773
|
+
#
|
1774
|
+
# @return [Types::GetImportJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1775
|
+
#
|
1776
|
+
# * {Types::GetImportJobResponse#job_id #job_id} => String
|
1777
|
+
# * {Types::GetImportJobResponse#import_destination #import_destination} => Types::ImportDestination
|
1778
|
+
# * {Types::GetImportJobResponse#import_data_source #import_data_source} => Types::ImportDataSource
|
1779
|
+
# * {Types::GetImportJobResponse#failure_info #failure_info} => Types::FailureInfo
|
1780
|
+
# * {Types::GetImportJobResponse#job_status #job_status} => String
|
1781
|
+
# * {Types::GetImportJobResponse#created_timestamp #created_timestamp} => Time
|
1782
|
+
# * {Types::GetImportJobResponse#completed_timestamp #completed_timestamp} => Time
|
1783
|
+
# * {Types::GetImportJobResponse#processed_records_count #processed_records_count} => Integer
|
1784
|
+
# * {Types::GetImportJobResponse#failed_records_count #failed_records_count} => Integer
|
1785
|
+
#
|
1786
|
+
# @example Request syntax with placeholder values
|
1787
|
+
#
|
1788
|
+
# resp = client.get_import_job({
|
1789
|
+
# job_id: "JobId", # required
|
1790
|
+
# })
|
1791
|
+
#
|
1792
|
+
# @example Response structure
|
1793
|
+
#
|
1794
|
+
# resp.job_id #=> String
|
1795
|
+
# resp.import_destination.suppression_list_destination.suppression_list_import_action #=> String, one of "DELETE", "PUT"
|
1796
|
+
# resp.import_data_source.s3_url #=> String
|
1797
|
+
# resp.import_data_source.data_format #=> String, one of "CSV", "JSON"
|
1798
|
+
# resp.failure_info.failed_records_s3_url #=> String
|
1799
|
+
# resp.failure_info.error_message #=> String
|
1800
|
+
# resp.job_status #=> String, one of "CREATED", "PROCESSING", "COMPLETED", "FAILED"
|
1801
|
+
# resp.created_timestamp #=> Time
|
1802
|
+
# resp.completed_timestamp #=> Time
|
1803
|
+
# resp.processed_records_count #=> Integer
|
1804
|
+
# resp.failed_records_count #=> Integer
|
1805
|
+
#
|
1806
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/GetImportJob AWS API Documentation
|
1807
|
+
#
|
1808
|
+
# @overload get_import_job(params = {})
|
1809
|
+
# @param [Hash] params ({})
|
1810
|
+
def get_import_job(params = {}, options = {})
|
1811
|
+
req = build_request(:get_import_job, params)
|
1812
|
+
req.send_request(options)
|
1813
|
+
end
|
1814
|
+
|
1310
1815
|
# Retrieves information about a specific email address that's on the
|
1311
1816
|
# suppression list for your account.
|
1312
1817
|
#
|
@@ -1388,20 +1893,81 @@ module Aws::SESV2
|
|
1388
1893
|
req.send_request(options)
|
1389
1894
|
end
|
1390
1895
|
|
1391
|
-
#
|
1392
|
-
# the current Region.
|
1896
|
+
# Lists the existing custom verification email templates for your
|
1897
|
+
# account in the current AWS Region.
|
1898
|
+
#
|
1899
|
+
# For more information about custom verification email templates, see
|
1900
|
+
# [Using Custom Verification Email Templates][1] in the *Amazon SES
|
1901
|
+
# Developer Guide*.
|
1902
|
+
#
|
1903
|
+
# You can execute this operation no more than once per second.
|
1904
|
+
#
|
1905
|
+
#
|
1906
|
+
#
|
1907
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-email-verify-address-custom.html
|
1393
1908
|
#
|
1394
1909
|
# @option params [String] :next_token
|
1395
|
-
# A token returned from a previous call to
|
1396
|
-
# indicate the position in the
|
1910
|
+
# A token returned from a previous call to
|
1911
|
+
# `ListCustomVerificationEmailTemplates` to indicate the position in the
|
1912
|
+
# list of custom verification email templates.
|
1397
1913
|
#
|
1398
1914
|
# @option params [Integer] :page_size
|
1399
1915
|
# The number of results to show in a single call to
|
1400
|
-
# `
|
1401
|
-
# number you specified in this parameter, then the
|
1402
|
-
# `NextToken` element, which you can use to obtain
|
1916
|
+
# `ListCustomVerificationEmailTemplates`. If the number of results is
|
1917
|
+
# larger than the number you specified in this parameter, then the
|
1918
|
+
# response includes a `NextToken` element, which you can use to obtain
|
1919
|
+
# additional results.
|
1403
1920
|
#
|
1404
|
-
#
|
1921
|
+
# The value you specify has to be at least 1, and can be no more than
|
1922
|
+
# 50.
|
1923
|
+
#
|
1924
|
+
# @return [Types::ListCustomVerificationEmailTemplatesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1925
|
+
#
|
1926
|
+
# * {Types::ListCustomVerificationEmailTemplatesResponse#custom_verification_email_templates #custom_verification_email_templates} => Array<Types::CustomVerificationEmailTemplateMetadata>
|
1927
|
+
# * {Types::ListCustomVerificationEmailTemplatesResponse#next_token #next_token} => String
|
1928
|
+
#
|
1929
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1930
|
+
#
|
1931
|
+
# @example Request syntax with placeholder values
|
1932
|
+
#
|
1933
|
+
# resp = client.list_custom_verification_email_templates({
|
1934
|
+
# next_token: "NextToken",
|
1935
|
+
# page_size: 1,
|
1936
|
+
# })
|
1937
|
+
#
|
1938
|
+
# @example Response structure
|
1939
|
+
#
|
1940
|
+
# resp.custom_verification_email_templates #=> Array
|
1941
|
+
# resp.custom_verification_email_templates[0].template_name #=> String
|
1942
|
+
# resp.custom_verification_email_templates[0].from_email_address #=> String
|
1943
|
+
# resp.custom_verification_email_templates[0].template_subject #=> String
|
1944
|
+
# resp.custom_verification_email_templates[0].success_redirection_url #=> String
|
1945
|
+
# resp.custom_verification_email_templates[0].failure_redirection_url #=> String
|
1946
|
+
# resp.next_token #=> String
|
1947
|
+
#
|
1948
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/ListCustomVerificationEmailTemplates AWS API Documentation
|
1949
|
+
#
|
1950
|
+
# @overload list_custom_verification_email_templates(params = {})
|
1951
|
+
# @param [Hash] params ({})
|
1952
|
+
def list_custom_verification_email_templates(params = {}, options = {})
|
1953
|
+
req = build_request(:list_custom_verification_email_templates, params)
|
1954
|
+
req.send_request(options)
|
1955
|
+
end
|
1956
|
+
|
1957
|
+
# List all of the dedicated IP pools that exist in your AWS account in
|
1958
|
+
# the current Region.
|
1959
|
+
#
|
1960
|
+
# @option params [String] :next_token
|
1961
|
+
# A token returned from a previous call to `ListDedicatedIpPools` to
|
1962
|
+
# indicate the position in the list of dedicated IP pools.
|
1963
|
+
#
|
1964
|
+
# @option params [Integer] :page_size
|
1965
|
+
# The number of results to show in a single call to
|
1966
|
+
# `ListDedicatedIpPools`. If the number of results is larger than the
|
1967
|
+
# number you specified in this parameter, then the response includes a
|
1968
|
+
# `NextToken` element, which you can use to obtain additional results.
|
1969
|
+
#
|
1970
|
+
# @return [Types::ListDedicatedIpPoolsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1405
1971
|
#
|
1406
1972
|
# * {Types::ListDedicatedIpPoolsResponse#dedicated_ip_pools #dedicated_ip_pools} => Array<String>
|
1407
1973
|
# * {Types::ListDedicatedIpPoolsResponse#next_token #next_token} => String
|
@@ -1610,6 +2176,106 @@ module Aws::SESV2
|
|
1610
2176
|
req.send_request(options)
|
1611
2177
|
end
|
1612
2178
|
|
2179
|
+
# Lists the email templates present in your Amazon SES account in the
|
2180
|
+
# current AWS Region.
|
2181
|
+
#
|
2182
|
+
# You can execute this operation no more than once per second.
|
2183
|
+
#
|
2184
|
+
# @option params [String] :next_token
|
2185
|
+
# A token returned from a previous call to `ListEmailTemplates` to
|
2186
|
+
# indicate the position in the list of email templates.
|
2187
|
+
#
|
2188
|
+
# @option params [Integer] :page_size
|
2189
|
+
# The number of results to show in a single call to
|
2190
|
+
# `ListEmailTemplates`. If the number of results is larger than the
|
2191
|
+
# number you specified in this parameter, then the response includes a
|
2192
|
+
# `NextToken` element, which you can use to obtain additional results.
|
2193
|
+
#
|
2194
|
+
# The value you specify has to be at least 1, and can be no more than
|
2195
|
+
# 10.
|
2196
|
+
#
|
2197
|
+
# @return [Types::ListEmailTemplatesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2198
|
+
#
|
2199
|
+
# * {Types::ListEmailTemplatesResponse#templates_metadata #templates_metadata} => Array<Types::EmailTemplateMetadata>
|
2200
|
+
# * {Types::ListEmailTemplatesResponse#next_token #next_token} => String
|
2201
|
+
#
|
2202
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2203
|
+
#
|
2204
|
+
# @example Request syntax with placeholder values
|
2205
|
+
#
|
2206
|
+
# resp = client.list_email_templates({
|
2207
|
+
# next_token: "NextToken",
|
2208
|
+
# page_size: 1,
|
2209
|
+
# })
|
2210
|
+
#
|
2211
|
+
# @example Response structure
|
2212
|
+
#
|
2213
|
+
# resp.templates_metadata #=> Array
|
2214
|
+
# resp.templates_metadata[0].template_name #=> String
|
2215
|
+
# resp.templates_metadata[0].created_timestamp #=> Time
|
2216
|
+
# resp.next_token #=> String
|
2217
|
+
#
|
2218
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/ListEmailTemplates AWS API Documentation
|
2219
|
+
#
|
2220
|
+
# @overload list_email_templates(params = {})
|
2221
|
+
# @param [Hash] params ({})
|
2222
|
+
def list_email_templates(params = {}, options = {})
|
2223
|
+
req = build_request(:list_email_templates, params)
|
2224
|
+
req.send_request(options)
|
2225
|
+
end
|
2226
|
+
|
2227
|
+
# Lists all of the import jobs.
|
2228
|
+
#
|
2229
|
+
# @option params [String] :import_destination_type
|
2230
|
+
# The destination of the import job, which can be used to list import
|
2231
|
+
# jobs that have a certain `ImportDestinationType`.
|
2232
|
+
#
|
2233
|
+
# @option params [String] :next_token
|
2234
|
+
# A string token indicating that there might be additional import jobs
|
2235
|
+
# available to be listed. Copy this token to a subsequent call to
|
2236
|
+
# `ListImportJobs` with the same parameters to retrieve the next page of
|
2237
|
+
# import jobs.
|
2238
|
+
#
|
2239
|
+
# @option params [Integer] :page_size
|
2240
|
+
# Maximum number of import jobs to return at once. Use this parameter to
|
2241
|
+
# paginate results. If additional import jobs exist beyond the specified
|
2242
|
+
# limit, the `NextToken` element is sent in the response. Use the
|
2243
|
+
# `NextToken` value in subsequent requests to retrieve additional
|
2244
|
+
# addresses.
|
2245
|
+
#
|
2246
|
+
# @return [Types::ListImportJobsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2247
|
+
#
|
2248
|
+
# * {Types::ListImportJobsResponse#import_jobs #import_jobs} => Array<Types::ImportJobSummary>
|
2249
|
+
# * {Types::ListImportJobsResponse#next_token #next_token} => String
|
2250
|
+
#
|
2251
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2252
|
+
#
|
2253
|
+
# @example Request syntax with placeholder values
|
2254
|
+
#
|
2255
|
+
# resp = client.list_import_jobs({
|
2256
|
+
# import_destination_type: "SUPPRESSION_LIST", # accepts SUPPRESSION_LIST
|
2257
|
+
# next_token: "NextToken",
|
2258
|
+
# page_size: 1,
|
2259
|
+
# })
|
2260
|
+
#
|
2261
|
+
# @example Response structure
|
2262
|
+
#
|
2263
|
+
# resp.import_jobs #=> Array
|
2264
|
+
# resp.import_jobs[0].job_id #=> String
|
2265
|
+
# resp.import_jobs[0].import_destination.suppression_list_destination.suppression_list_import_action #=> String, one of "DELETE", "PUT"
|
2266
|
+
# resp.import_jobs[0].job_status #=> String, one of "CREATED", "PROCESSING", "COMPLETED", "FAILED"
|
2267
|
+
# resp.import_jobs[0].created_timestamp #=> Time
|
2268
|
+
# resp.next_token #=> String
|
2269
|
+
#
|
2270
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/ListImportJobs AWS API Documentation
|
2271
|
+
#
|
2272
|
+
# @overload list_import_jobs(params = {})
|
2273
|
+
# @param [Hash] params ({})
|
2274
|
+
def list_import_jobs(params = {}, options = {})
|
2275
|
+
req = build_request(:list_import_jobs, params)
|
2276
|
+
req.send_request(options)
|
2277
|
+
end
|
2278
|
+
|
1613
2279
|
# Retrieves a list of email addresses that are on the suppression list
|
1614
2280
|
# for your account.
|
1615
2281
|
#
|
@@ -1732,6 +2398,62 @@ module Aws::SESV2
|
|
1732
2398
|
req.send_request(options)
|
1733
2399
|
end
|
1734
2400
|
|
2401
|
+
# Update your Amazon SES account details.
|
2402
|
+
#
|
2403
|
+
# @option params [required, String] :mail_type
|
2404
|
+
# The type of email your account will send.
|
2405
|
+
#
|
2406
|
+
# @option params [required, String] :website_url
|
2407
|
+
# The URL of your website. This information helps us better understand
|
2408
|
+
# the type of content that you plan to send.
|
2409
|
+
#
|
2410
|
+
# @option params [String] :contact_language
|
2411
|
+
# The language you would prefer to be contacted with.
|
2412
|
+
#
|
2413
|
+
# @option params [required, String] :use_case_description
|
2414
|
+
# A description of the types of email that you plan to send.
|
2415
|
+
#
|
2416
|
+
# @option params [Array<String>] :additional_contact_email_addresses
|
2417
|
+
# Additional email addresses that you would like to be notified
|
2418
|
+
# regarding Amazon SES matters.
|
2419
|
+
#
|
2420
|
+
# @option params [Boolean] :production_access_enabled
|
2421
|
+
# Indicates whether or not your account should have production access in
|
2422
|
+
# the current AWS Region.
|
2423
|
+
#
|
2424
|
+
# If the value is `false`, then your account is in the *sandbox*. When
|
2425
|
+
# your account is in the sandbox, you can only send email to verified
|
2426
|
+
# identities. Additionally, the maximum number of emails you can send in
|
2427
|
+
# a 24-hour period (your sending quota) is 200, and the maximum number
|
2428
|
+
# of emails you can send per second (your maximum sending rate) is 1.
|
2429
|
+
#
|
2430
|
+
# If the value is `true`, then your account has production access. When
|
2431
|
+
# your account has production access, you can send email to any address.
|
2432
|
+
# The sending quota and maximum sending rate for your account vary based
|
2433
|
+
# on your specific use case.
|
2434
|
+
#
|
2435
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2436
|
+
#
|
2437
|
+
# @example Request syntax with placeholder values
|
2438
|
+
#
|
2439
|
+
# resp = client.put_account_details({
|
2440
|
+
# mail_type: "MARKETING", # required, accepts MARKETING, TRANSACTIONAL
|
2441
|
+
# website_url: "WebsiteURL", # required
|
2442
|
+
# contact_language: "EN", # accepts EN, JA
|
2443
|
+
# use_case_description: "UseCaseDescription", # required
|
2444
|
+
# additional_contact_email_addresses: ["AdditionalContactEmailAddress"],
|
2445
|
+
# production_access_enabled: false,
|
2446
|
+
# })
|
2447
|
+
#
|
2448
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/PutAccountDetails AWS API Documentation
|
2449
|
+
#
|
2450
|
+
# @overload put_account_details(params = {})
|
2451
|
+
# @param [Hash] params ({})
|
2452
|
+
def put_account_details(params = {}, options = {})
|
2453
|
+
req = build_request(:put_account_details, params)
|
2454
|
+
req.send_request(options)
|
2455
|
+
end
|
2456
|
+
|
1735
2457
|
# Enable or disable the ability of your account to send email.
|
1736
2458
|
#
|
1737
2459
|
# @option params [Boolean] :sending_enabled
|
@@ -2294,6 +3016,193 @@ module Aws::SESV2
|
|
2294
3016
|
req.send_request(options)
|
2295
3017
|
end
|
2296
3018
|
|
3019
|
+
# Composes an email message to multiple destinations.
|
3020
|
+
#
|
3021
|
+
# @option params [String] :from_email_address
|
3022
|
+
# The email address that you want to use as the "From" address for the
|
3023
|
+
# email. The address that you specify has to be verified.
|
3024
|
+
#
|
3025
|
+
# @option params [String] :from_email_address_identity_arn
|
3026
|
+
# This parameter is used only for sending authorization. It is the ARN
|
3027
|
+
# of the identity that is associated with the sending authorization
|
3028
|
+
# policy that permits you to use the email address specified in the
|
3029
|
+
# `FromEmailAddress` parameter.
|
3030
|
+
#
|
3031
|
+
# For example, if the owner of example.com (which has ARN
|
3032
|
+
# arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a
|
3033
|
+
# policy to it that authorizes you to use sender@example.com, then you
|
3034
|
+
# would specify the `FromEmailAddressIdentityArn` to be
|
3035
|
+
# arn:aws:ses:us-east-1:123456789012:identity/example.com, and the
|
3036
|
+
# `FromEmailAddress` to be sender@example.com.
|
3037
|
+
#
|
3038
|
+
# For more information about sending authorization, see the [Amazon SES
|
3039
|
+
# Developer Guide][1].
|
3040
|
+
#
|
3041
|
+
#
|
3042
|
+
#
|
3043
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html
|
3044
|
+
#
|
3045
|
+
# @option params [Array<String>] :reply_to_addresses
|
3046
|
+
# The "Reply-to" email addresses for the message. When the recipient
|
3047
|
+
# replies to the message, each Reply-to address receives the reply.
|
3048
|
+
#
|
3049
|
+
# @option params [String] :feedback_forwarding_email_address
|
3050
|
+
# The address that you want bounce and complaint notifications to be
|
3051
|
+
# sent to.
|
3052
|
+
#
|
3053
|
+
# @option params [String] :feedback_forwarding_email_address_identity_arn
|
3054
|
+
# This parameter is used only for sending authorization. It is the ARN
|
3055
|
+
# of the identity that is associated with the sending authorization
|
3056
|
+
# policy that permits you to use the email address specified in the
|
3057
|
+
# `FeedbackForwardingEmailAddress` parameter.
|
3058
|
+
#
|
3059
|
+
# For example, if the owner of example.com (which has ARN
|
3060
|
+
# arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a
|
3061
|
+
# policy to it that authorizes you to use feedback@example.com, then you
|
3062
|
+
# would specify the `FeedbackForwardingEmailAddressIdentityArn` to be
|
3063
|
+
# arn:aws:ses:us-east-1:123456789012:identity/example.com, and the
|
3064
|
+
# `FeedbackForwardingEmailAddress` to be feedback@example.com.
|
3065
|
+
#
|
3066
|
+
# For more information about sending authorization, see the [Amazon SES
|
3067
|
+
# Developer Guide][1].
|
3068
|
+
#
|
3069
|
+
#
|
3070
|
+
#
|
3071
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html
|
3072
|
+
#
|
3073
|
+
# @option params [Array<Types::MessageTag>] :default_email_tags
|
3074
|
+
# A list of tags, in the form of name/value pairs, to apply to an email
|
3075
|
+
# that you send using the `SendEmail` operation. Tags correspond to
|
3076
|
+
# characteristics of the email that you define, so that you can publish
|
3077
|
+
# email sending events.
|
3078
|
+
#
|
3079
|
+
# @option params [required, Types::BulkEmailContent] :default_content
|
3080
|
+
# An object that contains the body of the message. You can specify a
|
3081
|
+
# template message.
|
3082
|
+
#
|
3083
|
+
# @option params [required, Array<Types::BulkEmailEntry>] :bulk_email_entries
|
3084
|
+
# The list of bulk email entry objects.
|
3085
|
+
#
|
3086
|
+
# @option params [String] :configuration_set_name
|
3087
|
+
# The name of the configuration set that you want to use when sending
|
3088
|
+
# the email.
|
3089
|
+
#
|
3090
|
+
# @return [Types::SendBulkEmailResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3091
|
+
#
|
3092
|
+
# * {Types::SendBulkEmailResponse#bulk_email_entry_results #bulk_email_entry_results} => Array<Types::BulkEmailEntryResult>
|
3093
|
+
#
|
3094
|
+
# @example Request syntax with placeholder values
|
3095
|
+
#
|
3096
|
+
# resp = client.send_bulk_email({
|
3097
|
+
# from_email_address: "EmailAddress",
|
3098
|
+
# from_email_address_identity_arn: "AmazonResourceName",
|
3099
|
+
# reply_to_addresses: ["EmailAddress"],
|
3100
|
+
# feedback_forwarding_email_address: "EmailAddress",
|
3101
|
+
# feedback_forwarding_email_address_identity_arn: "AmazonResourceName",
|
3102
|
+
# default_email_tags: [
|
3103
|
+
# {
|
3104
|
+
# name: "MessageTagName", # required
|
3105
|
+
# value: "MessageTagValue", # required
|
3106
|
+
# },
|
3107
|
+
# ],
|
3108
|
+
# default_content: { # required
|
3109
|
+
# template: {
|
3110
|
+
# template_name: "EmailTemplateName",
|
3111
|
+
# template_arn: "AmazonResourceName",
|
3112
|
+
# template_data: "EmailTemplateData",
|
3113
|
+
# },
|
3114
|
+
# },
|
3115
|
+
# bulk_email_entries: [ # required
|
3116
|
+
# {
|
3117
|
+
# destination: { # required
|
3118
|
+
# to_addresses: ["EmailAddress"],
|
3119
|
+
# cc_addresses: ["EmailAddress"],
|
3120
|
+
# bcc_addresses: ["EmailAddress"],
|
3121
|
+
# },
|
3122
|
+
# replacement_tags: [
|
3123
|
+
# {
|
3124
|
+
# name: "MessageTagName", # required
|
3125
|
+
# value: "MessageTagValue", # required
|
3126
|
+
# },
|
3127
|
+
# ],
|
3128
|
+
# replacement_email_content: {
|
3129
|
+
# replacement_template: {
|
3130
|
+
# replacement_template_data: "EmailTemplateData",
|
3131
|
+
# },
|
3132
|
+
# },
|
3133
|
+
# },
|
3134
|
+
# ],
|
3135
|
+
# configuration_set_name: "ConfigurationSetName",
|
3136
|
+
# })
|
3137
|
+
#
|
3138
|
+
# @example Response structure
|
3139
|
+
#
|
3140
|
+
# resp.bulk_email_entry_results #=> Array
|
3141
|
+
# 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"
|
3142
|
+
# resp.bulk_email_entry_results[0].error #=> String
|
3143
|
+
# resp.bulk_email_entry_results[0].message_id #=> String
|
3144
|
+
#
|
3145
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/SendBulkEmail AWS API Documentation
|
3146
|
+
#
|
3147
|
+
# @overload send_bulk_email(params = {})
|
3148
|
+
# @param [Hash] params ({})
|
3149
|
+
def send_bulk_email(params = {}, options = {})
|
3150
|
+
req = build_request(:send_bulk_email, params)
|
3151
|
+
req.send_request(options)
|
3152
|
+
end
|
3153
|
+
|
3154
|
+
# Adds an email address to the list of identities for your Amazon SES
|
3155
|
+
# account in the current AWS Region and attempts to verify it. As a
|
3156
|
+
# result of executing this operation, a customized verification email is
|
3157
|
+
# sent to the specified address.
|
3158
|
+
#
|
3159
|
+
# To use this operation, you must first create a custom verification
|
3160
|
+
# email template. For more information about creating and using custom
|
3161
|
+
# verification email templates, see [Using Custom Verification Email
|
3162
|
+
# Templates][1] in the *Amazon SES Developer Guide*.
|
3163
|
+
#
|
3164
|
+
# You can execute this operation no more than once per second.
|
3165
|
+
#
|
3166
|
+
#
|
3167
|
+
#
|
3168
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-email-verify-address-custom.html
|
3169
|
+
#
|
3170
|
+
# @option params [required, String] :email_address
|
3171
|
+
# The email address to verify.
|
3172
|
+
#
|
3173
|
+
# @option params [required, String] :template_name
|
3174
|
+
# The name of the custom verification email template to use when sending
|
3175
|
+
# the verification email.
|
3176
|
+
#
|
3177
|
+
# @option params [String] :configuration_set_name
|
3178
|
+
# Name of a configuration set to use when sending the verification
|
3179
|
+
# email.
|
3180
|
+
#
|
3181
|
+
# @return [Types::SendCustomVerificationEmailResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3182
|
+
#
|
3183
|
+
# * {Types::SendCustomVerificationEmailResponse#message_id #message_id} => String
|
3184
|
+
#
|
3185
|
+
# @example Request syntax with placeholder values
|
3186
|
+
#
|
3187
|
+
# resp = client.send_custom_verification_email({
|
3188
|
+
# email_address: "EmailAddress", # required
|
3189
|
+
# template_name: "EmailTemplateName", # required
|
3190
|
+
# configuration_set_name: "ConfigurationSetName",
|
3191
|
+
# })
|
3192
|
+
#
|
3193
|
+
# @example Response structure
|
3194
|
+
#
|
3195
|
+
# resp.message_id #=> String
|
3196
|
+
#
|
3197
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/SendCustomVerificationEmail AWS API Documentation
|
3198
|
+
#
|
3199
|
+
# @overload send_custom_verification_email(params = {})
|
3200
|
+
# @param [Hash] params ({})
|
3201
|
+
def send_custom_verification_email(params = {}, options = {})
|
3202
|
+
req = build_request(:send_custom_verification_email, params)
|
3203
|
+
req.send_request(options)
|
3204
|
+
end
|
3205
|
+
|
2297
3206
|
# Sends an email message. You can use the Amazon SES API v2 to send two
|
2298
3207
|
# types of messages:
|
2299
3208
|
#
|
@@ -2307,11 +3216,39 @@ module Aws::SESV2
|
|
2307
3216
|
# messages that contain attachments. The message that you specify has
|
2308
3217
|
# to be a valid MIME message.
|
2309
3218
|
#
|
3219
|
+
# * **Templated** – A message that contains personalization tags. When
|
3220
|
+
# you send this type of email, Amazon SES API v2 automatically
|
3221
|
+
# replaces the tags with values that you specify.
|
3222
|
+
#
|
2310
3223
|
# @option params [String] :from_email_address
|
2311
3224
|
# The email address that you want to use as the "From" address for the
|
2312
3225
|
# email. The address that you specify has to be verified.
|
2313
3226
|
#
|
2314
|
-
# @option params [
|
3227
|
+
# @option params [String] :from_email_address_identity_arn
|
3228
|
+
# This parameter is used only for sending authorization. It is the ARN
|
3229
|
+
# of the identity that is associated with the sending authorization
|
3230
|
+
# policy that permits you to use the email address specified in the
|
3231
|
+
# `FromEmailAddress` parameter.
|
3232
|
+
#
|
3233
|
+
# For example, if the owner of example.com (which has ARN
|
3234
|
+
# arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a
|
3235
|
+
# policy to it that authorizes you to use sender@example.com, then you
|
3236
|
+
# would specify the `FromEmailAddressIdentityArn` to be
|
3237
|
+
# arn:aws:ses:us-east-1:123456789012:identity/example.com, and the
|
3238
|
+
# `FromEmailAddress` to be sender@example.com.
|
3239
|
+
#
|
3240
|
+
# For more information about sending authorization, see the [Amazon SES
|
3241
|
+
# Developer Guide][1].
|
3242
|
+
#
|
3243
|
+
# For Raw emails, the `FromEmailAddressIdentityArn` value overrides the
|
3244
|
+
# X-SES-SOURCE-ARN and X-SES-FROM-ARN headers specified in raw email
|
3245
|
+
# message content.
|
3246
|
+
#
|
3247
|
+
#
|
3248
|
+
#
|
3249
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html
|
3250
|
+
#
|
3251
|
+
# @option params [Types::Destination] :destination
|
2315
3252
|
# An object that contains the recipients of the email message.
|
2316
3253
|
#
|
2317
3254
|
# @option params [Array<String>] :reply_to_addresses
|
@@ -2322,9 +3259,29 @@ module Aws::SESV2
|
|
2322
3259
|
# The address that you want bounce and complaint notifications to be
|
2323
3260
|
# sent to.
|
2324
3261
|
#
|
3262
|
+
# @option params [String] :feedback_forwarding_email_address_identity_arn
|
3263
|
+
# This parameter is used only for sending authorization. It is the ARN
|
3264
|
+
# of the identity that is associated with the sending authorization
|
3265
|
+
# policy that permits you to use the email address specified in the
|
3266
|
+
# `FeedbackForwardingEmailAddress` parameter.
|
3267
|
+
#
|
3268
|
+
# For example, if the owner of example.com (which has ARN
|
3269
|
+
# arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a
|
3270
|
+
# policy to it that authorizes you to use feedback@example.com, then you
|
3271
|
+
# would specify the `FeedbackForwardingEmailAddressIdentityArn` to be
|
3272
|
+
# arn:aws:ses:us-east-1:123456789012:identity/example.com, and the
|
3273
|
+
# `FeedbackForwardingEmailAddress` to be feedback@example.com.
|
3274
|
+
#
|
3275
|
+
# For more information about sending authorization, see the [Amazon SES
|
3276
|
+
# Developer Guide][1].
|
3277
|
+
#
|
3278
|
+
#
|
3279
|
+
#
|
3280
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html
|
3281
|
+
#
|
2325
3282
|
# @option params [required, Types::EmailContent] :content
|
2326
3283
|
# An object that contains the body of the message. You can send either a
|
2327
|
-
# Simple message or a
|
3284
|
+
# Simple message Raw message or a template Message.
|
2328
3285
|
#
|
2329
3286
|
# @option params [Array<Types::MessageTag>] :email_tags
|
2330
3287
|
# A list of tags, in the form of name/value pairs, to apply to an email
|
@@ -2344,13 +3301,15 @@ module Aws::SESV2
|
|
2344
3301
|
#
|
2345
3302
|
# resp = client.send_email({
|
2346
3303
|
# from_email_address: "EmailAddress",
|
2347
|
-
#
|
3304
|
+
# from_email_address_identity_arn: "AmazonResourceName",
|
3305
|
+
# destination: {
|
2348
3306
|
# to_addresses: ["EmailAddress"],
|
2349
3307
|
# cc_addresses: ["EmailAddress"],
|
2350
3308
|
# bcc_addresses: ["EmailAddress"],
|
2351
3309
|
# },
|
2352
3310
|
# reply_to_addresses: ["EmailAddress"],
|
2353
3311
|
# feedback_forwarding_email_address: "EmailAddress",
|
3312
|
+
# feedback_forwarding_email_address_identity_arn: "AmazonResourceName",
|
2354
3313
|
# content: { # required
|
2355
3314
|
# simple: {
|
2356
3315
|
# subject: { # required
|
@@ -2372,8 +3331,9 @@ module Aws::SESV2
|
|
2372
3331
|
# data: "data", # required
|
2373
3332
|
# },
|
2374
3333
|
# template: {
|
2375
|
-
#
|
2376
|
-
#
|
3334
|
+
# template_name: "EmailTemplateName",
|
3335
|
+
# template_arn: "AmazonResourceName",
|
3336
|
+
# template_data: "EmailTemplateData",
|
2377
3337
|
# },
|
2378
3338
|
# },
|
2379
3339
|
# email_tags: [
|
@@ -2442,6 +3402,43 @@ module Aws::SESV2
|
|
2442
3402
|
req.send_request(options)
|
2443
3403
|
end
|
2444
3404
|
|
3405
|
+
# Creates a preview of the MIME content of an email when provided with a
|
3406
|
+
# template and a set of replacement data.
|
3407
|
+
#
|
3408
|
+
# You can execute this operation no more than once per second.
|
3409
|
+
#
|
3410
|
+
# @option params [required, String] :template_name
|
3411
|
+
# The name of the template that you want to render.
|
3412
|
+
#
|
3413
|
+
# @option params [required, String] :template_data
|
3414
|
+
# A list of replacement values to apply to the template. This parameter
|
3415
|
+
# is a JSON object, typically consisting of key-value pairs in which the
|
3416
|
+
# keys correspond to replacement tags in the email template.
|
3417
|
+
#
|
3418
|
+
# @return [Types::TestRenderEmailTemplateResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3419
|
+
#
|
3420
|
+
# * {Types::TestRenderEmailTemplateResponse#rendered_template #rendered_template} => String
|
3421
|
+
#
|
3422
|
+
# @example Request syntax with placeholder values
|
3423
|
+
#
|
3424
|
+
# resp = client.test_render_email_template({
|
3425
|
+
# template_name: "EmailTemplateName", # required
|
3426
|
+
# template_data: "EmailTemplateData", # required
|
3427
|
+
# })
|
3428
|
+
#
|
3429
|
+
# @example Response structure
|
3430
|
+
#
|
3431
|
+
# resp.rendered_template #=> String
|
3432
|
+
#
|
3433
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/TestRenderEmailTemplate AWS API Documentation
|
3434
|
+
#
|
3435
|
+
# @overload test_render_email_template(params = {})
|
3436
|
+
# @param [Hash] params ({})
|
3437
|
+
def test_render_email_template(params = {}, options = {})
|
3438
|
+
req = build_request(:test_render_email_template, params)
|
3439
|
+
req.send_request(options)
|
3440
|
+
end
|
3441
|
+
|
2445
3442
|
# Remove one or more tags (keys and values) from a specified resource.
|
2446
3443
|
#
|
2447
3444
|
# @option params [required, String] :resource_arn
|
@@ -2537,6 +3534,165 @@ module Aws::SESV2
|
|
2537
3534
|
req.send_request(options)
|
2538
3535
|
end
|
2539
3536
|
|
3537
|
+
# Updates an existing custom verification email template.
|
3538
|
+
#
|
3539
|
+
# For more information about custom verification email templates, see
|
3540
|
+
# [Using Custom Verification Email Templates][1] in the *Amazon SES
|
3541
|
+
# Developer Guide*.
|
3542
|
+
#
|
3543
|
+
# You can execute this operation no more than once per second.
|
3544
|
+
#
|
3545
|
+
#
|
3546
|
+
#
|
3547
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-email-verify-address-custom.html
|
3548
|
+
#
|
3549
|
+
# @option params [required, String] :template_name
|
3550
|
+
# The name of the custom verification email template that you want to
|
3551
|
+
# update.
|
3552
|
+
#
|
3553
|
+
# @option params [required, String] :from_email_address
|
3554
|
+
# The email address that the custom verification email is sent from.
|
3555
|
+
#
|
3556
|
+
# @option params [required, String] :template_subject
|
3557
|
+
# The subject line of the custom verification email.
|
3558
|
+
#
|
3559
|
+
# @option params [required, String] :template_content
|
3560
|
+
# The content of the custom verification email. The total size of the
|
3561
|
+
# email must be less than 10 MB. The message body may contain HTML, with
|
3562
|
+
# some limitations. For more information, see [Custom Verification Email
|
3563
|
+
# Frequently Asked Questions][1] in the *Amazon SES Developer Guide*.
|
3564
|
+
#
|
3565
|
+
#
|
3566
|
+
#
|
3567
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-email-verify-address-custom.html#custom-verification-emails-faq
|
3568
|
+
#
|
3569
|
+
# @option params [required, String] :success_redirection_url
|
3570
|
+
# The URL that the recipient of the verification email is sent to if his
|
3571
|
+
# or her address is successfully verified.
|
3572
|
+
#
|
3573
|
+
# @option params [required, String] :failure_redirection_url
|
3574
|
+
# The URL that the recipient of the verification email is sent to if his
|
3575
|
+
# or her address is not successfully verified.
|
3576
|
+
#
|
3577
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
3578
|
+
#
|
3579
|
+
# @example Request syntax with placeholder values
|
3580
|
+
#
|
3581
|
+
# resp = client.update_custom_verification_email_template({
|
3582
|
+
# template_name: "EmailTemplateName", # required
|
3583
|
+
# from_email_address: "EmailAddress", # required
|
3584
|
+
# template_subject: "EmailTemplateSubject", # required
|
3585
|
+
# template_content: "TemplateContent", # required
|
3586
|
+
# success_redirection_url: "SuccessRedirectionURL", # required
|
3587
|
+
# failure_redirection_url: "FailureRedirectionURL", # required
|
3588
|
+
# })
|
3589
|
+
#
|
3590
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/UpdateCustomVerificationEmailTemplate AWS API Documentation
|
3591
|
+
#
|
3592
|
+
# @overload update_custom_verification_email_template(params = {})
|
3593
|
+
# @param [Hash] params ({})
|
3594
|
+
def update_custom_verification_email_template(params = {}, options = {})
|
3595
|
+
req = build_request(:update_custom_verification_email_template, params)
|
3596
|
+
req.send_request(options)
|
3597
|
+
end
|
3598
|
+
|
3599
|
+
# Updates the specified sending authorization policy for the given
|
3600
|
+
# identity (an email address or a domain). This API returns successfully
|
3601
|
+
# even if a policy with the specified name does not exist.
|
3602
|
+
#
|
3603
|
+
# <note markdown="1"> This API is for the identity owner only. If you have not verified the
|
3604
|
+
# identity, this API will return an error.
|
3605
|
+
#
|
3606
|
+
# </note>
|
3607
|
+
#
|
3608
|
+
# Sending authorization is a feature that enables an identity owner to
|
3609
|
+
# authorize other senders to use its identities. For information about
|
3610
|
+
# using sending authorization, see the [Amazon SES Developer Guide][1].
|
3611
|
+
#
|
3612
|
+
# You can execute this operation no more than once per second.
|
3613
|
+
#
|
3614
|
+
#
|
3615
|
+
#
|
3616
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html
|
3617
|
+
#
|
3618
|
+
# @option params [required, String] :email_identity
|
3619
|
+
# The email identity for which you want to update policy.
|
3620
|
+
#
|
3621
|
+
# @option params [required, String] :policy_name
|
3622
|
+
# The name of the policy.
|
3623
|
+
#
|
3624
|
+
# The policy name cannot exceed 64 characters and can only include
|
3625
|
+
# alphanumeric characters, dashes, and underscores.
|
3626
|
+
#
|
3627
|
+
# @option params [required, String] :policy
|
3628
|
+
# The text of the policy in JSON format. The policy cannot exceed 4 KB.
|
3629
|
+
#
|
3630
|
+
# For information about the syntax of sending authorization policies,
|
3631
|
+
# see the [Amazon SES Developer Guide][1].
|
3632
|
+
#
|
3633
|
+
#
|
3634
|
+
#
|
3635
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization-policies.html
|
3636
|
+
#
|
3637
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
3638
|
+
#
|
3639
|
+
# @example Request syntax with placeholder values
|
3640
|
+
#
|
3641
|
+
# resp = client.update_email_identity_policy({
|
3642
|
+
# email_identity: "Identity", # required
|
3643
|
+
# policy_name: "PolicyName", # required
|
3644
|
+
# policy: "Policy", # required
|
3645
|
+
# })
|
3646
|
+
#
|
3647
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/UpdateEmailIdentityPolicy AWS API Documentation
|
3648
|
+
#
|
3649
|
+
# @overload update_email_identity_policy(params = {})
|
3650
|
+
# @param [Hash] params ({})
|
3651
|
+
def update_email_identity_policy(params = {}, options = {})
|
3652
|
+
req = build_request(:update_email_identity_policy, params)
|
3653
|
+
req.send_request(options)
|
3654
|
+
end
|
3655
|
+
|
3656
|
+
# Updates an email template. Email templates enable you to send
|
3657
|
+
# personalized email to one or more destinations in a single API
|
3658
|
+
# operation. For more information, see the [Amazon SES Developer
|
3659
|
+
# Guide][1].
|
3660
|
+
#
|
3661
|
+
# You can execute this operation no more than once per second.
|
3662
|
+
#
|
3663
|
+
#
|
3664
|
+
#
|
3665
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-personalized-email-api.html
|
3666
|
+
#
|
3667
|
+
# @option params [required, String] :template_name
|
3668
|
+
# The name of the template you want to update.
|
3669
|
+
#
|
3670
|
+
# @option params [required, Types::EmailTemplateContent] :template_content
|
3671
|
+
# The content of the email template, composed of a subject line, an HTML
|
3672
|
+
# part, and a text-only part.
|
3673
|
+
#
|
3674
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
3675
|
+
#
|
3676
|
+
# @example Request syntax with placeholder values
|
3677
|
+
#
|
3678
|
+
# resp = client.update_email_template({
|
3679
|
+
# template_name: "EmailTemplateName", # required
|
3680
|
+
# template_content: { # required
|
3681
|
+
# subject: "EmailTemplateSubject",
|
3682
|
+
# text: "EmailTemplateText",
|
3683
|
+
# html: "EmailTemplateHtml",
|
3684
|
+
# },
|
3685
|
+
# })
|
3686
|
+
#
|
3687
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/UpdateEmailTemplate AWS API Documentation
|
3688
|
+
#
|
3689
|
+
# @overload update_email_template(params = {})
|
3690
|
+
# @param [Hash] params ({})
|
3691
|
+
def update_email_template(params = {}, options = {})
|
3692
|
+
req = build_request(:update_email_template, params)
|
3693
|
+
req.send_request(options)
|
3694
|
+
end
|
3695
|
+
|
2540
3696
|
# @!endgroup
|
2541
3697
|
|
2542
3698
|
# @param params ({})
|
@@ -2550,7 +3706,7 @@ module Aws::SESV2
|
|
2550
3706
|
params: params,
|
2551
3707
|
config: config)
|
2552
3708
|
context[:gem_name] = 'aws-sdk-sesv2'
|
2553
|
-
context[:gem_version] = '1.
|
3709
|
+
context[:gem_version] = '1.13.0'
|
2554
3710
|
Seahorse::Client::Request.new(handlers, context)
|
2555
3711
|
end
|
2556
3712
|
|