aws-sdk-sesv2 1.8.0 → 1.9.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 +1 -1
- data/lib/aws-sdk-sesv2/client.rb +1014 -10
- data/lib/aws-sdk-sesv2/client_api.rb +507 -5
- data/lib/aws-sdk-sesv2/errors.rb +11 -0
- data/lib/aws-sdk-sesv2/types.rb +1556 -38
- metadata +2 -2
data/lib/aws-sdk-sesv2/errors.rb
CHANGED
@@ -31,6 +31,7 @@ module Aws::SESV2
|
|
31
31
|
# * {AlreadyExistsException}
|
32
32
|
# * {BadRequestException}
|
33
33
|
# * {ConcurrentModificationException}
|
34
|
+
# * {ConflictException}
|
34
35
|
# * {InvalidNextTokenException}
|
35
36
|
# * {LimitExceededException}
|
36
37
|
# * {MailFromDomainNotVerifiedException}
|
@@ -85,6 +86,16 @@ module Aws::SESV2
|
|
85
86
|
end
|
86
87
|
end
|
87
88
|
|
89
|
+
class ConflictException < ServiceError
|
90
|
+
|
91
|
+
# @param [Seahorse::Client::RequestContext] context
|
92
|
+
# @param [String] message
|
93
|
+
# @param [Aws::SESV2::Types::ConflictException] data
|
94
|
+
def initialize(context, message, data = Aws::EmptyStructure.new)
|
95
|
+
super(context, message, data)
|
96
|
+
end
|
97
|
+
end
|
98
|
+
|
88
99
|
class InvalidNextTokenException < ServiceError
|
89
100
|
|
90
101
|
# @param [Seahorse::Client::RequestContext] context
|
data/lib/aws-sdk-sesv2/types.rb
CHANGED
@@ -10,6 +10,55 @@
|
|
10
10
|
module Aws::SESV2
|
11
11
|
module Types
|
12
12
|
|
13
|
+
# An object that contains information about your account details.
|
14
|
+
#
|
15
|
+
# @!attribute [rw] mail_type
|
16
|
+
# The type of email your account is sending. The mail type can be one
|
17
|
+
# of the following:
|
18
|
+
#
|
19
|
+
# * `MARKETING` – Most of your sending traffic is to keep your
|
20
|
+
# customers informed of your latest offering.
|
21
|
+
#
|
22
|
+
# * `TRANSACTIONAL` – Most of your sending traffic is to communicate
|
23
|
+
# during a transaction with a customer.
|
24
|
+
# @return [String]
|
25
|
+
#
|
26
|
+
# @!attribute [rw] website_url
|
27
|
+
# The URL of your website. This information helps us better understand
|
28
|
+
# the type of content that you plan to send.
|
29
|
+
# @return [String]
|
30
|
+
#
|
31
|
+
# @!attribute [rw] contact_language
|
32
|
+
# The language you would prefer for the case. The contact language can
|
33
|
+
# be one of `ENGLISH` or `JAPANESE`.
|
34
|
+
# @return [String]
|
35
|
+
#
|
36
|
+
# @!attribute [rw] use_case_description
|
37
|
+
# A description of the types of email that you plan to send.
|
38
|
+
# @return [String]
|
39
|
+
#
|
40
|
+
# @!attribute [rw] additional_contact_email_addresses
|
41
|
+
# Additional email addresses where updates are sent about your account
|
42
|
+
# review process.
|
43
|
+
# @return [Array<String>]
|
44
|
+
#
|
45
|
+
# @!attribute [rw] review_details
|
46
|
+
# Information about the review of the latest details you submitted.
|
47
|
+
# @return [Types::ReviewDetails]
|
48
|
+
#
|
49
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/AccountDetails AWS API Documentation
|
50
|
+
#
|
51
|
+
class AccountDetails < Struct.new(
|
52
|
+
:mail_type,
|
53
|
+
:website_url,
|
54
|
+
:contact_language,
|
55
|
+
:use_case_description,
|
56
|
+
:additional_contact_email_addresses,
|
57
|
+
:review_details)
|
58
|
+
SENSITIVE = [:website_url, :use_case_description, :additional_contact_email_addresses]
|
59
|
+
include Aws::Structure
|
60
|
+
end
|
61
|
+
|
13
62
|
# The message can't be sent because the account's ability to send
|
14
63
|
# email has been permanently restricted.
|
15
64
|
#
|
@@ -94,6 +143,176 @@ module Aws::SESV2
|
|
94
143
|
include Aws::Structure
|
95
144
|
end
|
96
145
|
|
146
|
+
# An object that contains the body of the message. You can specify a
|
147
|
+
# template message.
|
148
|
+
#
|
149
|
+
# @note When making an API call, you may pass BulkEmailContent
|
150
|
+
# data as a hash:
|
151
|
+
#
|
152
|
+
# {
|
153
|
+
# template: {
|
154
|
+
# template_name: "EmailTemplateName",
|
155
|
+
# template_arn: "AmazonResourceName",
|
156
|
+
# template_data: "EmailTemplateData",
|
157
|
+
# },
|
158
|
+
# }
|
159
|
+
#
|
160
|
+
# @!attribute [rw] template
|
161
|
+
# The template to use for the bulk email message.
|
162
|
+
# @return [Types::Template]
|
163
|
+
#
|
164
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/BulkEmailContent AWS API Documentation
|
165
|
+
#
|
166
|
+
class BulkEmailContent < Struct.new(
|
167
|
+
:template)
|
168
|
+
SENSITIVE = []
|
169
|
+
include Aws::Structure
|
170
|
+
end
|
171
|
+
|
172
|
+
# @note When making an API call, you may pass BulkEmailEntry
|
173
|
+
# data as a hash:
|
174
|
+
#
|
175
|
+
# {
|
176
|
+
# destination: { # required
|
177
|
+
# to_addresses: ["EmailAddress"],
|
178
|
+
# cc_addresses: ["EmailAddress"],
|
179
|
+
# bcc_addresses: ["EmailAddress"],
|
180
|
+
# },
|
181
|
+
# replacement_tags: [
|
182
|
+
# {
|
183
|
+
# name: "MessageTagName", # required
|
184
|
+
# value: "MessageTagValue", # required
|
185
|
+
# },
|
186
|
+
# ],
|
187
|
+
# replacement_email_content: {
|
188
|
+
# replacement_template: {
|
189
|
+
# replacement_template_data: "EmailTemplateData",
|
190
|
+
# },
|
191
|
+
# },
|
192
|
+
# }
|
193
|
+
#
|
194
|
+
# @!attribute [rw] destination
|
195
|
+
# Represents the destination of the message, consisting of To:, CC:,
|
196
|
+
# and BCC: fields.
|
197
|
+
#
|
198
|
+
# <note markdown="1"> Amazon SES does not support the SMTPUTF8 extension, as described in
|
199
|
+
# [RFC6531][1]. For this reason, the local part of a destination email
|
200
|
+
# address (the part of the email address that precedes the @ sign) may
|
201
|
+
# only contain [7-bit ASCII characters][2]. If the domain part of an
|
202
|
+
# address (the part after the @ sign) contains non-ASCII characters,
|
203
|
+
# they must be encoded using Punycode, as described in [RFC3492][3].
|
204
|
+
#
|
205
|
+
# </note>
|
206
|
+
#
|
207
|
+
#
|
208
|
+
#
|
209
|
+
# [1]: https://tools.ietf.org/html/rfc6531
|
210
|
+
# [2]: https://en.wikipedia.org/wiki/Email_address#Local-part
|
211
|
+
# [3]: https://tools.ietf.org/html/rfc3492.html
|
212
|
+
# @return [Types::Destination]
|
213
|
+
#
|
214
|
+
# @!attribute [rw] replacement_tags
|
215
|
+
# A list of tags, in the form of name/value pairs, to apply to an
|
216
|
+
# email that you send using the `SendBulkTemplatedEmail` operation.
|
217
|
+
# Tags correspond to characteristics of the email that you define, so
|
218
|
+
# that you can publish email sending events.
|
219
|
+
# @return [Array<Types::MessageTag>]
|
220
|
+
#
|
221
|
+
# @!attribute [rw] replacement_email_content
|
222
|
+
# The `ReplacementEmailContent` associated with a `BulkEmailEntry`.
|
223
|
+
# @return [Types::ReplacementEmailContent]
|
224
|
+
#
|
225
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/BulkEmailEntry AWS API Documentation
|
226
|
+
#
|
227
|
+
class BulkEmailEntry < Struct.new(
|
228
|
+
:destination,
|
229
|
+
:replacement_tags,
|
230
|
+
:replacement_email_content)
|
231
|
+
SENSITIVE = []
|
232
|
+
include Aws::Structure
|
233
|
+
end
|
234
|
+
|
235
|
+
# The result of the `SendBulkEmail` operation of each specified
|
236
|
+
# `BulkEmailEntry`.
|
237
|
+
#
|
238
|
+
# @!attribute [rw] status
|
239
|
+
# The status of a message sent using the `SendBulkTemplatedEmail`
|
240
|
+
# operation.
|
241
|
+
#
|
242
|
+
# Possible values for this parameter include:
|
243
|
+
#
|
244
|
+
# * SUCCESS: Amazon SES accepted the message, and will attempt to
|
245
|
+
# deliver it to the recipients.
|
246
|
+
#
|
247
|
+
# * MESSAGE\_REJECTED: The message was rejected because it contained a
|
248
|
+
# virus.
|
249
|
+
#
|
250
|
+
# * MAIL\_FROM\_DOMAIN\_NOT\_VERIFIED: The sender's email address or
|
251
|
+
# domain was not verified.
|
252
|
+
#
|
253
|
+
# * CONFIGURATION\_SET\_DOES\_NOT\_EXIST: The configuration set you
|
254
|
+
# specified does not exist.
|
255
|
+
#
|
256
|
+
# * TEMPLATE\_DOES\_NOT\_EXIST: The template you specified does not
|
257
|
+
# exist.
|
258
|
+
#
|
259
|
+
# * ACCOUNT\_SUSPENDED: Your account has been shut down because of
|
260
|
+
# issues related to your email sending practices.
|
261
|
+
#
|
262
|
+
# * ACCOUNT\_THROTTLED: The number of emails you can send has been
|
263
|
+
# reduced because your account has exceeded its allocated sending
|
264
|
+
# limit.
|
265
|
+
#
|
266
|
+
# * ACCOUNT\_DAILY\_QUOTA\_EXCEEDED: You have reached or exceeded the
|
267
|
+
# maximum number of emails you can send from your account in a
|
268
|
+
# 24-hour period.
|
269
|
+
#
|
270
|
+
# * INVALID\_SENDING\_POOL\_NAME: The configuration set you specified
|
271
|
+
# refers to an IP pool that does not exist.
|
272
|
+
#
|
273
|
+
# * ACCOUNT\_SENDING\_PAUSED: Email sending for the Amazon SES account
|
274
|
+
# was disabled using the [UpdateAccountSendingEnabled][1] operation.
|
275
|
+
#
|
276
|
+
# * CONFIGURATION\_SET\_SENDING\_PAUSED: Email sending for this
|
277
|
+
# configuration set was disabled using the
|
278
|
+
# [UpdateConfigurationSetSendingEnabled][2] operation.
|
279
|
+
#
|
280
|
+
# * INVALID\_PARAMETER\_VALUE: One or more of the parameters you
|
281
|
+
# specified when calling this operation was invalid. See the error
|
282
|
+
# message for additional information.
|
283
|
+
#
|
284
|
+
# * TRANSIENT\_FAILURE: Amazon SES was unable to process your request
|
285
|
+
# because of a temporary issue.
|
286
|
+
#
|
287
|
+
# * FAILED: Amazon SES was unable to process your request. See the
|
288
|
+
# error message for additional information.
|
289
|
+
#
|
290
|
+
#
|
291
|
+
#
|
292
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/APIReference/API_UpdateAccountSendingEnabled.html
|
293
|
+
# [2]: https://docs.aws.amazon.com/ses/latest/APIReference/API_UpdateConfigurationSetSendingEnabled.html
|
294
|
+
# @return [String]
|
295
|
+
#
|
296
|
+
# @!attribute [rw] error
|
297
|
+
# A description of an error that prevented a message being sent using
|
298
|
+
# the `SendBulkTemplatedEmail` operation.
|
299
|
+
# @return [String]
|
300
|
+
#
|
301
|
+
# @!attribute [rw] message_id
|
302
|
+
# The unique message identifier returned from the
|
303
|
+
# `SendBulkTemplatedEmail` operation.
|
304
|
+
# @return [String]
|
305
|
+
#
|
306
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/BulkEmailEntryResult AWS API Documentation
|
307
|
+
#
|
308
|
+
class BulkEmailEntryResult < Struct.new(
|
309
|
+
:status,
|
310
|
+
:error,
|
311
|
+
:message_id)
|
312
|
+
SENSITIVE = []
|
313
|
+
include Aws::Structure
|
314
|
+
end
|
315
|
+
|
97
316
|
# An object that defines an Amazon CloudWatch destination for email
|
98
317
|
# events. You can use Amazon CloudWatch to monitor and gain insights on
|
99
318
|
# your email sending metrics.
|
@@ -182,6 +401,12 @@ module Aws::SESV2
|
|
182
401
|
#
|
183
402
|
class ConcurrentModificationException < Aws::EmptyStructure; end
|
184
403
|
|
404
|
+
# If there is already an ongoing account details update under review.
|
405
|
+
#
|
406
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/ConflictException AWS API Documentation
|
407
|
+
#
|
408
|
+
class ConflictException < Aws::EmptyStructure; end
|
409
|
+
|
185
410
|
# An object that represents the content of the email, and optionally a
|
186
411
|
# character set specification.
|
187
412
|
#
|
@@ -365,6 +590,74 @@ module Aws::SESV2
|
|
365
590
|
#
|
366
591
|
class CreateConfigurationSetResponse < Aws::EmptyStructure; end
|
367
592
|
|
593
|
+
# Represents a request to create a custom verification email template.
|
594
|
+
#
|
595
|
+
# @note When making an API call, you may pass CreateCustomVerificationEmailTemplateRequest
|
596
|
+
# data as a hash:
|
597
|
+
#
|
598
|
+
# {
|
599
|
+
# template_name: "EmailTemplateName", # required
|
600
|
+
# from_email_address: "EmailAddress", # required
|
601
|
+
# template_subject: "EmailTemplateSubject", # required
|
602
|
+
# template_content: "TemplateContent", # required
|
603
|
+
# success_redirection_url: "SuccessRedirectionURL", # required
|
604
|
+
# failure_redirection_url: "FailureRedirectionURL", # required
|
605
|
+
# }
|
606
|
+
#
|
607
|
+
# @!attribute [rw] template_name
|
608
|
+
# The name of the custom verification email template.
|
609
|
+
# @return [String]
|
610
|
+
#
|
611
|
+
# @!attribute [rw] from_email_address
|
612
|
+
# The email address that the custom verification email is sent from.
|
613
|
+
# @return [String]
|
614
|
+
#
|
615
|
+
# @!attribute [rw] template_subject
|
616
|
+
# The subject line of the custom verification email.
|
617
|
+
# @return [String]
|
618
|
+
#
|
619
|
+
# @!attribute [rw] template_content
|
620
|
+
# The content of the custom verification email. The total size of the
|
621
|
+
# email must be less than 10 MB. The message body may contain HTML,
|
622
|
+
# with some limitations. For more information, see [Custom
|
623
|
+
# Verification Email Frequently Asked Questions][1] in the *Amazon SES
|
624
|
+
# Developer Guide*.
|
625
|
+
#
|
626
|
+
#
|
627
|
+
#
|
628
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-email-verify-address-custom.html#custom-verification-emails-faq
|
629
|
+
# @return [String]
|
630
|
+
#
|
631
|
+
# @!attribute [rw] success_redirection_url
|
632
|
+
# The URL that the recipient of the verification email is sent to if
|
633
|
+
# his or her address is successfully verified.
|
634
|
+
# @return [String]
|
635
|
+
#
|
636
|
+
# @!attribute [rw] failure_redirection_url
|
637
|
+
# The URL that the recipient of the verification email is sent to if
|
638
|
+
# his or her address is not successfully verified.
|
639
|
+
# @return [String]
|
640
|
+
#
|
641
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/CreateCustomVerificationEmailTemplateRequest AWS API Documentation
|
642
|
+
#
|
643
|
+
class CreateCustomVerificationEmailTemplateRequest < Struct.new(
|
644
|
+
:template_name,
|
645
|
+
:from_email_address,
|
646
|
+
:template_subject,
|
647
|
+
:template_content,
|
648
|
+
:success_redirection_url,
|
649
|
+
:failure_redirection_url)
|
650
|
+
SENSITIVE = []
|
651
|
+
include Aws::Structure
|
652
|
+
end
|
653
|
+
|
654
|
+
# If the action is successful, the service sends back an HTTP 200
|
655
|
+
# response with an empty HTTP body.
|
656
|
+
#
|
657
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/CreateCustomVerificationEmailTemplateResponse AWS API Documentation
|
658
|
+
#
|
659
|
+
class CreateCustomVerificationEmailTemplateResponse < Aws::EmptyStructure; end
|
660
|
+
|
368
661
|
# A request to create a new dedicated IP pool.
|
369
662
|
#
|
370
663
|
# @note When making an API call, you may pass CreateDedicatedIpPoolRequest
|
@@ -443,8 +736,9 @@ module Aws::SESV2
|
|
443
736
|
# data: "data", # required
|
444
737
|
# },
|
445
738
|
# template: {
|
446
|
-
#
|
447
|
-
#
|
739
|
+
# template_name: "EmailTemplateName",
|
740
|
+
# template_arn: "AmazonResourceName",
|
741
|
+
# template_data: "EmailTemplateData",
|
448
742
|
# },
|
449
743
|
# },
|
450
744
|
# tags: [
|
@@ -511,6 +805,64 @@ module Aws::SESV2
|
|
511
805
|
include Aws::Structure
|
512
806
|
end
|
513
807
|
|
808
|
+
# Represents a request to create a sending authorization policy for an
|
809
|
+
# identity. Sending authorization is an Amazon SES feature that enables
|
810
|
+
# you to authorize other senders to use your identities. For
|
811
|
+
# information, see the [Amazon SES Developer Guide][1].
|
812
|
+
#
|
813
|
+
#
|
814
|
+
#
|
815
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization-identity-owner-tasks-management.html
|
816
|
+
#
|
817
|
+
# @note When making an API call, you may pass CreateEmailIdentityPolicyRequest
|
818
|
+
# data as a hash:
|
819
|
+
#
|
820
|
+
# {
|
821
|
+
# email_identity: "Identity", # required
|
822
|
+
# policy_name: "PolicyName", # required
|
823
|
+
# policy: "Policy", # required
|
824
|
+
# }
|
825
|
+
#
|
826
|
+
# @!attribute [rw] email_identity
|
827
|
+
# The email identity for which you want to create a policy.
|
828
|
+
# @return [String]
|
829
|
+
#
|
830
|
+
# @!attribute [rw] policy_name
|
831
|
+
# The name of the policy.
|
832
|
+
#
|
833
|
+
# The policy name cannot exceed 64 characters and can only include
|
834
|
+
# alphanumeric characters, dashes, and underscores.
|
835
|
+
# @return [String]
|
836
|
+
#
|
837
|
+
# @!attribute [rw] policy
|
838
|
+
# The text of the policy in JSON format. The policy cannot exceed 4
|
839
|
+
# KB.
|
840
|
+
#
|
841
|
+
# For information about the syntax of sending authorization policies,
|
842
|
+
# see the [Amazon SES Developer Guide][1].
|
843
|
+
#
|
844
|
+
#
|
845
|
+
#
|
846
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization-policies.html
|
847
|
+
# @return [String]
|
848
|
+
#
|
849
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/CreateEmailIdentityPolicyRequest AWS API Documentation
|
850
|
+
#
|
851
|
+
class CreateEmailIdentityPolicyRequest < Struct.new(
|
852
|
+
:email_identity,
|
853
|
+
:policy_name,
|
854
|
+
:policy)
|
855
|
+
SENSITIVE = []
|
856
|
+
include Aws::Structure
|
857
|
+
end
|
858
|
+
|
859
|
+
# An HTTP 200 response if the request succeeds, or an error message if
|
860
|
+
# the request fails.
|
861
|
+
#
|
862
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/CreateEmailIdentityPolicyResponse AWS API Documentation
|
863
|
+
#
|
864
|
+
class CreateEmailIdentityPolicyResponse < Aws::EmptyStructure; end
|
865
|
+
|
514
866
|
# A request to begin the verification process for an email identity (an
|
515
867
|
# email address or domain).
|
516
868
|
#
|
@@ -598,6 +950,86 @@ module Aws::SESV2
|
|
598
950
|
include Aws::Structure
|
599
951
|
end
|
600
952
|
|
953
|
+
# Represents a request to create an email template. For more
|
954
|
+
# information, see the [Amazon SES Developer Guide][1].
|
955
|
+
#
|
956
|
+
#
|
957
|
+
#
|
958
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-personalized-email-api.html
|
959
|
+
#
|
960
|
+
# @note When making an API call, you may pass CreateEmailTemplateRequest
|
961
|
+
# data as a hash:
|
962
|
+
#
|
963
|
+
# {
|
964
|
+
# template_name: "EmailTemplateName", # required
|
965
|
+
# template_content: { # required
|
966
|
+
# subject: "EmailTemplateSubject",
|
967
|
+
# text: "EmailTemplateText",
|
968
|
+
# html: "EmailTemplateHtml",
|
969
|
+
# },
|
970
|
+
# }
|
971
|
+
#
|
972
|
+
# @!attribute [rw] template_name
|
973
|
+
# The name of the template you want to create.
|
974
|
+
# @return [String]
|
975
|
+
#
|
976
|
+
# @!attribute [rw] template_content
|
977
|
+
# The content of the email template, composed of a subject line, an
|
978
|
+
# HTML part, and a text-only part.
|
979
|
+
# @return [Types::EmailTemplateContent]
|
980
|
+
#
|
981
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/CreateEmailTemplateRequest AWS API Documentation
|
982
|
+
#
|
983
|
+
class CreateEmailTemplateRequest < Struct.new(
|
984
|
+
:template_name,
|
985
|
+
:template_content)
|
986
|
+
SENSITIVE = []
|
987
|
+
include Aws::Structure
|
988
|
+
end
|
989
|
+
|
990
|
+
# If the action is successful, the service sends back an HTTP 200
|
991
|
+
# response with an empty HTTP body.
|
992
|
+
#
|
993
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/CreateEmailTemplateResponse AWS API Documentation
|
994
|
+
#
|
995
|
+
class CreateEmailTemplateResponse < Aws::EmptyStructure; end
|
996
|
+
|
997
|
+
# Contains information about a custom verification email template.
|
998
|
+
#
|
999
|
+
# @!attribute [rw] template_name
|
1000
|
+
# The name of the custom verification email template.
|
1001
|
+
# @return [String]
|
1002
|
+
#
|
1003
|
+
# @!attribute [rw] from_email_address
|
1004
|
+
# The email address that the custom verification email is sent from.
|
1005
|
+
# @return [String]
|
1006
|
+
#
|
1007
|
+
# @!attribute [rw] template_subject
|
1008
|
+
# The subject line of the custom verification email.
|
1009
|
+
# @return [String]
|
1010
|
+
#
|
1011
|
+
# @!attribute [rw] success_redirection_url
|
1012
|
+
# The URL that the recipient of the verification email is sent to if
|
1013
|
+
# his or her address is successfully verified.
|
1014
|
+
# @return [String]
|
1015
|
+
#
|
1016
|
+
# @!attribute [rw] failure_redirection_url
|
1017
|
+
# The URL that the recipient of the verification email is sent to if
|
1018
|
+
# his or her address is not successfully verified.
|
1019
|
+
# @return [String]
|
1020
|
+
#
|
1021
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/CustomVerificationEmailTemplateMetadata AWS API Documentation
|
1022
|
+
#
|
1023
|
+
class CustomVerificationEmailTemplateMetadata < Struct.new(
|
1024
|
+
:template_name,
|
1025
|
+
:from_email_address,
|
1026
|
+
:template_subject,
|
1027
|
+
:success_redirection_url,
|
1028
|
+
:failure_redirection_url)
|
1029
|
+
SENSITIVE = []
|
1030
|
+
include Aws::Structure
|
1031
|
+
end
|
1032
|
+
|
601
1033
|
# An object that contains information about the volume of email sent on
|
602
1034
|
# each day of the analysis period.
|
603
1035
|
#
|
@@ -737,6 +1169,36 @@ module Aws::SESV2
|
|
737
1169
|
#
|
738
1170
|
class DeleteConfigurationSetResponse < Aws::EmptyStructure; end
|
739
1171
|
|
1172
|
+
# Represents a request to delete an existing custom verification email
|
1173
|
+
# template.
|
1174
|
+
#
|
1175
|
+
# @note When making an API call, you may pass DeleteCustomVerificationEmailTemplateRequest
|
1176
|
+
# data as a hash:
|
1177
|
+
#
|
1178
|
+
# {
|
1179
|
+
# template_name: "EmailTemplateName", # required
|
1180
|
+
# }
|
1181
|
+
#
|
1182
|
+
# @!attribute [rw] template_name
|
1183
|
+
# The name of the custom verification email template that you want to
|
1184
|
+
# delete.
|
1185
|
+
# @return [String]
|
1186
|
+
#
|
1187
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/DeleteCustomVerificationEmailTemplateRequest AWS API Documentation
|
1188
|
+
#
|
1189
|
+
class DeleteCustomVerificationEmailTemplateRequest < Struct.new(
|
1190
|
+
:template_name)
|
1191
|
+
SENSITIVE = []
|
1192
|
+
include Aws::Structure
|
1193
|
+
end
|
1194
|
+
|
1195
|
+
# If the action is successful, the service sends back an HTTP 200
|
1196
|
+
# response with an empty HTTP body.
|
1197
|
+
#
|
1198
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/DeleteCustomVerificationEmailTemplateResponse AWS API Documentation
|
1199
|
+
#
|
1200
|
+
class DeleteCustomVerificationEmailTemplateResponse < Aws::EmptyStructure; end
|
1201
|
+
|
740
1202
|
# A request to delete a dedicated IP pool.
|
741
1203
|
#
|
742
1204
|
# @note When making an API call, you may pass DeleteDedicatedIpPoolRequest
|
@@ -765,27 +1227,39 @@ module Aws::SESV2
|
|
765
1227
|
#
|
766
1228
|
class DeleteDedicatedIpPoolResponse < Aws::EmptyStructure; end
|
767
1229
|
|
768
|
-
#
|
769
|
-
# identity
|
770
|
-
#
|
771
|
-
#
|
1230
|
+
# Represents a request to delete a sending authorization policy for an
|
1231
|
+
# identity. Sending authorization is an Amazon SES feature that enables
|
1232
|
+
# you to authorize other senders to use your identities. For
|
1233
|
+
# information, see the [Amazon SES Developer Guide][1].
|
772
1234
|
#
|
773
|
-
#
|
1235
|
+
#
|
1236
|
+
#
|
1237
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization-identity-owner-tasks-management.html
|
1238
|
+
#
|
1239
|
+
# @note When making an API call, you may pass DeleteEmailIdentityPolicyRequest
|
774
1240
|
# data as a hash:
|
775
1241
|
#
|
776
1242
|
# {
|
777
1243
|
# email_identity: "Identity", # required
|
1244
|
+
# policy_name: "PolicyName", # required
|
778
1245
|
# }
|
779
1246
|
#
|
780
1247
|
# @!attribute [rw] email_identity
|
781
|
-
# The
|
782
|
-
# delete.
|
1248
|
+
# The email identity for which you want to delete a policy.
|
783
1249
|
# @return [String]
|
784
1250
|
#
|
785
|
-
#
|
1251
|
+
# @!attribute [rw] policy_name
|
1252
|
+
# The name of the policy.
|
786
1253
|
#
|
787
|
-
|
788
|
-
|
1254
|
+
# The policy name cannot exceed 64 characters and can only include
|
1255
|
+
# alphanumeric characters, dashes, and underscores.
|
1256
|
+
# @return [String]
|
1257
|
+
#
|
1258
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/DeleteEmailIdentityPolicyRequest AWS API Documentation
|
1259
|
+
#
|
1260
|
+
class DeleteEmailIdentityPolicyRequest < Struct.new(
|
1261
|
+
:email_identity,
|
1262
|
+
:policy_name)
|
789
1263
|
SENSITIVE = []
|
790
1264
|
include Aws::Structure
|
791
1265
|
end
|
@@ -793,15 +1267,80 @@ module Aws::SESV2
|
|
793
1267
|
# An HTTP 200 response if the request succeeds, or an error message if
|
794
1268
|
# the request fails.
|
795
1269
|
#
|
796
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/
|
1270
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/DeleteEmailIdentityPolicyResponse AWS API Documentation
|
797
1271
|
#
|
798
|
-
class
|
1272
|
+
class DeleteEmailIdentityPolicyResponse < Aws::EmptyStructure; end
|
799
1273
|
|
800
|
-
# A request to
|
801
|
-
#
|
802
|
-
#
|
803
|
-
#
|
804
|
-
#
|
1274
|
+
# A request to delete an existing email identity. When you delete an
|
1275
|
+
# identity, you lose the ability to send email from that identity. You
|
1276
|
+
# can restore your ability to send email by completing the verification
|
1277
|
+
# process for the identity again.
|
1278
|
+
#
|
1279
|
+
# @note When making an API call, you may pass DeleteEmailIdentityRequest
|
1280
|
+
# data as a hash:
|
1281
|
+
#
|
1282
|
+
# {
|
1283
|
+
# email_identity: "Identity", # required
|
1284
|
+
# }
|
1285
|
+
#
|
1286
|
+
# @!attribute [rw] email_identity
|
1287
|
+
# The identity (that is, the email address or domain) that you want to
|
1288
|
+
# delete.
|
1289
|
+
# @return [String]
|
1290
|
+
#
|
1291
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/DeleteEmailIdentityRequest AWS API Documentation
|
1292
|
+
#
|
1293
|
+
class DeleteEmailIdentityRequest < Struct.new(
|
1294
|
+
:email_identity)
|
1295
|
+
SENSITIVE = []
|
1296
|
+
include Aws::Structure
|
1297
|
+
end
|
1298
|
+
|
1299
|
+
# An HTTP 200 response if the request succeeds, or an error message if
|
1300
|
+
# the request fails.
|
1301
|
+
#
|
1302
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/DeleteEmailIdentityResponse AWS API Documentation
|
1303
|
+
#
|
1304
|
+
class DeleteEmailIdentityResponse < Aws::EmptyStructure; end
|
1305
|
+
|
1306
|
+
# Represents a request to delete an email template. For more
|
1307
|
+
# information, see the [Amazon SES Developer Guide][1].
|
1308
|
+
#
|
1309
|
+
#
|
1310
|
+
#
|
1311
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-personalized-email-api.html
|
1312
|
+
#
|
1313
|
+
# @note When making an API call, you may pass DeleteEmailTemplateRequest
|
1314
|
+
# data as a hash:
|
1315
|
+
#
|
1316
|
+
# {
|
1317
|
+
# template_name: "EmailTemplateName", # required
|
1318
|
+
# }
|
1319
|
+
#
|
1320
|
+
# @!attribute [rw] template_name
|
1321
|
+
# The name of the template to be deleted.
|
1322
|
+
# @return [String]
|
1323
|
+
#
|
1324
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/DeleteEmailTemplateRequest AWS API Documentation
|
1325
|
+
#
|
1326
|
+
class DeleteEmailTemplateRequest < Struct.new(
|
1327
|
+
:template_name)
|
1328
|
+
SENSITIVE = []
|
1329
|
+
include Aws::Structure
|
1330
|
+
end
|
1331
|
+
|
1332
|
+
# If the action is successful, the service sends back an HTTP 200
|
1333
|
+
# response with an empty HTTP body.
|
1334
|
+
#
|
1335
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/DeleteEmailTemplateResponse AWS API Documentation
|
1336
|
+
#
|
1337
|
+
class DeleteEmailTemplateResponse < Aws::EmptyStructure; end
|
1338
|
+
|
1339
|
+
# A request to remove an email address from the suppression list for
|
1340
|
+
# your account.
|
1341
|
+
#
|
1342
|
+
# @note When making an API call, you may pass DeleteSuppressedDestinationRequest
|
1343
|
+
# data as a hash:
|
805
1344
|
#
|
806
1345
|
# {
|
807
1346
|
# email_address: "EmailAddress", # required
|
@@ -1288,8 +1827,9 @@ module Aws::SESV2
|
|
1288
1827
|
# data: "data", # required
|
1289
1828
|
# },
|
1290
1829
|
# template: {
|
1291
|
-
#
|
1292
|
-
#
|
1830
|
+
# template_name: "EmailTemplateName",
|
1831
|
+
# template_arn: "AmazonResourceName",
|
1832
|
+
# template_data: "EmailTemplateData",
|
1293
1833
|
# },
|
1294
1834
|
# }
|
1295
1835
|
#
|
@@ -1341,6 +1881,60 @@ module Aws::SESV2
|
|
1341
1881
|
include Aws::Structure
|
1342
1882
|
end
|
1343
1883
|
|
1884
|
+
# The content of the email, composed of a subject line, an HTML part,
|
1885
|
+
# and a text-only part.
|
1886
|
+
#
|
1887
|
+
# @note When making an API call, you may pass EmailTemplateContent
|
1888
|
+
# data as a hash:
|
1889
|
+
#
|
1890
|
+
# {
|
1891
|
+
# subject: "EmailTemplateSubject",
|
1892
|
+
# text: "EmailTemplateText",
|
1893
|
+
# html: "EmailTemplateHtml",
|
1894
|
+
# }
|
1895
|
+
#
|
1896
|
+
# @!attribute [rw] subject
|
1897
|
+
# The subject line of the email.
|
1898
|
+
# @return [String]
|
1899
|
+
#
|
1900
|
+
# @!attribute [rw] text
|
1901
|
+
# The email body that will be visible to recipients whose email
|
1902
|
+
# clients do not display HTML.
|
1903
|
+
# @return [String]
|
1904
|
+
#
|
1905
|
+
# @!attribute [rw] html
|
1906
|
+
# The HTML body of the email.
|
1907
|
+
# @return [String]
|
1908
|
+
#
|
1909
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/EmailTemplateContent AWS API Documentation
|
1910
|
+
#
|
1911
|
+
class EmailTemplateContent < Struct.new(
|
1912
|
+
:subject,
|
1913
|
+
:text,
|
1914
|
+
:html)
|
1915
|
+
SENSITIVE = []
|
1916
|
+
include Aws::Structure
|
1917
|
+
end
|
1918
|
+
|
1919
|
+
# Contains information about an email template.
|
1920
|
+
#
|
1921
|
+
# @!attribute [rw] template_name
|
1922
|
+
# The name of the template.
|
1923
|
+
# @return [String]
|
1924
|
+
#
|
1925
|
+
# @!attribute [rw] created_timestamp
|
1926
|
+
# The time and date the template was created.
|
1927
|
+
# @return [Time]
|
1928
|
+
#
|
1929
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/EmailTemplateMetadata AWS API Documentation
|
1930
|
+
#
|
1931
|
+
class EmailTemplateMetadata < Struct.new(
|
1932
|
+
:template_name,
|
1933
|
+
:created_timestamp)
|
1934
|
+
SENSITIVE = []
|
1935
|
+
include Aws::Structure
|
1936
|
+
end
|
1937
|
+
|
1344
1938
|
# In the Amazon SES API v2, *events* include message sends, deliveries,
|
1345
1939
|
# opens, clicks, bounces, complaints and delivery delays. *Event
|
1346
1940
|
# destinations* are places that you can send information about these
|
@@ -1571,6 +2165,10 @@ module Aws::SESV2
|
|
1571
2165
|
# suppression preferences for your account in the current AWS Region.
|
1572
2166
|
# @return [Types::SuppressionAttributes]
|
1573
2167
|
#
|
2168
|
+
# @!attribute [rw] details
|
2169
|
+
# An object that defines your account details.
|
2170
|
+
# @return [Types::AccountDetails]
|
2171
|
+
#
|
1574
2172
|
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/GetAccountResponse AWS API Documentation
|
1575
2173
|
#
|
1576
2174
|
class GetAccountResponse < Struct.new(
|
@@ -1579,7 +2177,8 @@ module Aws::SESV2
|
|
1579
2177
|
:production_access_enabled,
|
1580
2178
|
:send_quota,
|
1581
2179
|
:sending_enabled,
|
1582
|
-
:suppression_attributes
|
2180
|
+
:suppression_attributes,
|
2181
|
+
:details)
|
1583
2182
|
SENSITIVE = []
|
1584
2183
|
include Aws::Structure
|
1585
2184
|
end
|
@@ -1733,6 +2332,70 @@ module Aws::SESV2
|
|
1733
2332
|
include Aws::Structure
|
1734
2333
|
end
|
1735
2334
|
|
2335
|
+
# Represents a request to retrieve an existing custom verification email
|
2336
|
+
# template.
|
2337
|
+
#
|
2338
|
+
# @note When making an API call, you may pass GetCustomVerificationEmailTemplateRequest
|
2339
|
+
# data as a hash:
|
2340
|
+
#
|
2341
|
+
# {
|
2342
|
+
# template_name: "EmailTemplateName", # required
|
2343
|
+
# }
|
2344
|
+
#
|
2345
|
+
# @!attribute [rw] template_name
|
2346
|
+
# The name of the custom verification email template that you want to
|
2347
|
+
# retrieve.
|
2348
|
+
# @return [String]
|
2349
|
+
#
|
2350
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/GetCustomVerificationEmailTemplateRequest AWS API Documentation
|
2351
|
+
#
|
2352
|
+
class GetCustomVerificationEmailTemplateRequest < Struct.new(
|
2353
|
+
:template_name)
|
2354
|
+
SENSITIVE = []
|
2355
|
+
include Aws::Structure
|
2356
|
+
end
|
2357
|
+
|
2358
|
+
# The following elements are returned by the service.
|
2359
|
+
#
|
2360
|
+
# @!attribute [rw] template_name
|
2361
|
+
# The name of the custom verification email template.
|
2362
|
+
# @return [String]
|
2363
|
+
#
|
2364
|
+
# @!attribute [rw] from_email_address
|
2365
|
+
# The email address that the custom verification email is sent from.
|
2366
|
+
# @return [String]
|
2367
|
+
#
|
2368
|
+
# @!attribute [rw] template_subject
|
2369
|
+
# The subject line of the custom verification email.
|
2370
|
+
# @return [String]
|
2371
|
+
#
|
2372
|
+
# @!attribute [rw] template_content
|
2373
|
+
# The content of the custom verification email.
|
2374
|
+
# @return [String]
|
2375
|
+
#
|
2376
|
+
# @!attribute [rw] success_redirection_url
|
2377
|
+
# The URL that the recipient of the verification email is sent to if
|
2378
|
+
# his or her address is successfully verified.
|
2379
|
+
# @return [String]
|
2380
|
+
#
|
2381
|
+
# @!attribute [rw] failure_redirection_url
|
2382
|
+
# The URL that the recipient of the verification email is sent to if
|
2383
|
+
# his or her address is not successfully verified.
|
2384
|
+
# @return [String]
|
2385
|
+
#
|
2386
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/GetCustomVerificationEmailTemplateResponse AWS API Documentation
|
2387
|
+
#
|
2388
|
+
class GetCustomVerificationEmailTemplateResponse < Struct.new(
|
2389
|
+
:template_name,
|
2390
|
+
:from_email_address,
|
2391
|
+
:template_subject,
|
2392
|
+
:template_content,
|
2393
|
+
:success_redirection_url,
|
2394
|
+
:failure_redirection_url)
|
2395
|
+
SENSITIVE = []
|
2396
|
+
include Aws::Structure
|
2397
|
+
end
|
2398
|
+
|
1736
2399
|
# A request to obtain more information about a dedicated IP address.
|
1737
2400
|
#
|
1738
2401
|
# @note When making an API call, you may pass GetDedicatedIpRequest
|
@@ -2068,6 +2731,41 @@ module Aws::SESV2
|
|
2068
2731
|
include Aws::Structure
|
2069
2732
|
end
|
2070
2733
|
|
2734
|
+
# A request to return the policies of an email identity.
|
2735
|
+
#
|
2736
|
+
# @note When making an API call, you may pass GetEmailIdentityPoliciesRequest
|
2737
|
+
# data as a hash:
|
2738
|
+
#
|
2739
|
+
# {
|
2740
|
+
# email_identity: "Identity", # required
|
2741
|
+
# }
|
2742
|
+
#
|
2743
|
+
# @!attribute [rw] email_identity
|
2744
|
+
# The email identity that you want to retrieve policies for.
|
2745
|
+
# @return [String]
|
2746
|
+
#
|
2747
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/GetEmailIdentityPoliciesRequest AWS API Documentation
|
2748
|
+
#
|
2749
|
+
class GetEmailIdentityPoliciesRequest < Struct.new(
|
2750
|
+
:email_identity)
|
2751
|
+
SENSITIVE = []
|
2752
|
+
include Aws::Structure
|
2753
|
+
end
|
2754
|
+
|
2755
|
+
# Identity policies associated with email identity.
|
2756
|
+
#
|
2757
|
+
# @!attribute [rw] policies
|
2758
|
+
# A map of policy names to policies.
|
2759
|
+
# @return [Hash<String,String>]
|
2760
|
+
#
|
2761
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/GetEmailIdentityPoliciesResponse AWS API Documentation
|
2762
|
+
#
|
2763
|
+
class GetEmailIdentityPoliciesResponse < Struct.new(
|
2764
|
+
:policies)
|
2765
|
+
SENSITIVE = []
|
2766
|
+
include Aws::Structure
|
2767
|
+
end
|
2768
|
+
|
2071
2769
|
# A request to return details about an email identity.
|
2072
2770
|
#
|
2073
2771
|
# @note When making an API call, you may pass GetEmailIdentityRequest
|
@@ -2130,6 +2828,10 @@ module Aws::SESV2
|
|
2130
2828
|
# for the email identity.
|
2131
2829
|
# @return [Types::MailFromAttributes]
|
2132
2830
|
#
|
2831
|
+
# @!attribute [rw] policies
|
2832
|
+
# A map of policy names to policies.
|
2833
|
+
# @return [Hash<String,String>]
|
2834
|
+
#
|
2133
2835
|
# @!attribute [rw] tags
|
2134
2836
|
# An array of objects that define the tags (keys and values) that are
|
2135
2837
|
# associated with the email identity.
|
@@ -2143,11 +2845,55 @@ module Aws::SESV2
|
|
2143
2845
|
:verified_for_sending_status,
|
2144
2846
|
:dkim_attributes,
|
2145
2847
|
:mail_from_attributes,
|
2848
|
+
:policies,
|
2146
2849
|
:tags)
|
2147
2850
|
SENSITIVE = []
|
2148
2851
|
include Aws::Structure
|
2149
2852
|
end
|
2150
2853
|
|
2854
|
+
# Represents a request to display the template object (which includes
|
2855
|
+
# the subject line, HTML part and text part) for the template you
|
2856
|
+
# specify.
|
2857
|
+
#
|
2858
|
+
# @note When making an API call, you may pass GetEmailTemplateRequest
|
2859
|
+
# data as a hash:
|
2860
|
+
#
|
2861
|
+
# {
|
2862
|
+
# template_name: "EmailTemplateName", # required
|
2863
|
+
# }
|
2864
|
+
#
|
2865
|
+
# @!attribute [rw] template_name
|
2866
|
+
# The name of the template you want to retrieve.
|
2867
|
+
# @return [String]
|
2868
|
+
#
|
2869
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/GetEmailTemplateRequest AWS API Documentation
|
2870
|
+
#
|
2871
|
+
class GetEmailTemplateRequest < Struct.new(
|
2872
|
+
:template_name)
|
2873
|
+
SENSITIVE = []
|
2874
|
+
include Aws::Structure
|
2875
|
+
end
|
2876
|
+
|
2877
|
+
# The following element is returned by the service.
|
2878
|
+
#
|
2879
|
+
# @!attribute [rw] template_name
|
2880
|
+
# The name of the template you want to retrieve.
|
2881
|
+
# @return [String]
|
2882
|
+
#
|
2883
|
+
# @!attribute [rw] template_content
|
2884
|
+
# The content of the email template, composed of a subject line, an
|
2885
|
+
# HTML part, and a text-only part.
|
2886
|
+
# @return [Types::EmailTemplateContent]
|
2887
|
+
#
|
2888
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/GetEmailTemplateResponse AWS API Documentation
|
2889
|
+
#
|
2890
|
+
class GetEmailTemplateResponse < Struct.new(
|
2891
|
+
:template_name,
|
2892
|
+
:template_content)
|
2893
|
+
SENSITIVE = []
|
2894
|
+
include Aws::Structure
|
2895
|
+
end
|
2896
|
+
|
2151
2897
|
# A request to retrieve information about an email address that's on
|
2152
2898
|
# the suppression list for your account.
|
2153
2899
|
#
|
@@ -2375,6 +3121,66 @@ module Aws::SESV2
|
|
2375
3121
|
include Aws::Structure
|
2376
3122
|
end
|
2377
3123
|
|
3124
|
+
# Represents a request to list the existing custom verification email
|
3125
|
+
# templates for your account.
|
3126
|
+
#
|
3127
|
+
# @note When making an API call, you may pass ListCustomVerificationEmailTemplatesRequest
|
3128
|
+
# data as a hash:
|
3129
|
+
#
|
3130
|
+
# {
|
3131
|
+
# next_token: "NextToken",
|
3132
|
+
# page_size: 1,
|
3133
|
+
# }
|
3134
|
+
#
|
3135
|
+
# @!attribute [rw] next_token
|
3136
|
+
# A token returned from a previous call to
|
3137
|
+
# `ListCustomVerificationEmailTemplates` to indicate the position in
|
3138
|
+
# the list of custom verification email templates.
|
3139
|
+
# @return [String]
|
3140
|
+
#
|
3141
|
+
# @!attribute [rw] page_size
|
3142
|
+
# The number of results to show in a single call to
|
3143
|
+
# `ListCustomVerificationEmailTemplates`. If the number of results is
|
3144
|
+
# larger than the number you specified in this parameter, then the
|
3145
|
+
# response includes a `NextToken` element, which you can use to obtain
|
3146
|
+
# additional results.
|
3147
|
+
#
|
3148
|
+
# The value you specify has to be at least 1, and can be no more than
|
3149
|
+
# 50.
|
3150
|
+
# @return [Integer]
|
3151
|
+
#
|
3152
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/ListCustomVerificationEmailTemplatesRequest AWS API Documentation
|
3153
|
+
#
|
3154
|
+
class ListCustomVerificationEmailTemplatesRequest < Struct.new(
|
3155
|
+
:next_token,
|
3156
|
+
:page_size)
|
3157
|
+
SENSITIVE = []
|
3158
|
+
include Aws::Structure
|
3159
|
+
end
|
3160
|
+
|
3161
|
+
# The following elements are returned by the service.
|
3162
|
+
#
|
3163
|
+
# @!attribute [rw] custom_verification_email_templates
|
3164
|
+
# A list of the custom verification email templates that exist in your
|
3165
|
+
# account.
|
3166
|
+
# @return [Array<Types::CustomVerificationEmailTemplateMetadata>]
|
3167
|
+
#
|
3168
|
+
# @!attribute [rw] next_token
|
3169
|
+
# A token indicating that there are additional custom verification
|
3170
|
+
# email templates available to be listed. Pass this token to a
|
3171
|
+
# subsequent call to `ListCustomVerificationEmailTemplates` to
|
3172
|
+
# retrieve the next 50 custom verification email templates.
|
3173
|
+
# @return [String]
|
3174
|
+
#
|
3175
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/ListCustomVerificationEmailTemplatesResponse AWS API Documentation
|
3176
|
+
#
|
3177
|
+
class ListCustomVerificationEmailTemplatesResponse < Struct.new(
|
3178
|
+
:custom_verification_email_templates,
|
3179
|
+
:next_token)
|
3180
|
+
SENSITIVE = []
|
3181
|
+
include Aws::Structure
|
3182
|
+
end
|
3183
|
+
|
2378
3184
|
# A request to obtain a list of dedicated IP pools.
|
2379
3185
|
#
|
2380
3186
|
# @note When making an API call, you may pass ListDedicatedIpPoolsRequest
|
@@ -2636,6 +3442,68 @@ module Aws::SESV2
|
|
2636
3442
|
include Aws::Structure
|
2637
3443
|
end
|
2638
3444
|
|
3445
|
+
# Represents a request to list the email templates present in your
|
3446
|
+
# Amazon SES account in the current AWS Region. For more information,
|
3447
|
+
# see the [Amazon SES Developer Guide][1].
|
3448
|
+
#
|
3449
|
+
#
|
3450
|
+
#
|
3451
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-personalized-email-api.html
|
3452
|
+
#
|
3453
|
+
# @note When making an API call, you may pass ListEmailTemplatesRequest
|
3454
|
+
# data as a hash:
|
3455
|
+
#
|
3456
|
+
# {
|
3457
|
+
# next_token: "NextToken",
|
3458
|
+
# page_size: 1,
|
3459
|
+
# }
|
3460
|
+
#
|
3461
|
+
# @!attribute [rw] next_token
|
3462
|
+
# A token returned from a previous call to `ListEmailTemplates` to
|
3463
|
+
# indicate the position in the list of email templates.
|
3464
|
+
# @return [String]
|
3465
|
+
#
|
3466
|
+
# @!attribute [rw] page_size
|
3467
|
+
# The number of results to show in a single call to
|
3468
|
+
# `ListEmailTemplates`. If the number of results is larger than the
|
3469
|
+
# number you specified in this parameter, then the response includes a
|
3470
|
+
# `NextToken` element, which you can use to obtain additional results.
|
3471
|
+
#
|
3472
|
+
# The value you specify has to be at least 1, and can be no more than
|
3473
|
+
# 10.
|
3474
|
+
# @return [Integer]
|
3475
|
+
#
|
3476
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/ListEmailTemplatesRequest AWS API Documentation
|
3477
|
+
#
|
3478
|
+
class ListEmailTemplatesRequest < Struct.new(
|
3479
|
+
:next_token,
|
3480
|
+
:page_size)
|
3481
|
+
SENSITIVE = []
|
3482
|
+
include Aws::Structure
|
3483
|
+
end
|
3484
|
+
|
3485
|
+
# The following elements are returned by the service.
|
3486
|
+
#
|
3487
|
+
# @!attribute [rw] templates_metadata
|
3488
|
+
# An array the contains the name and creation time stamp for each
|
3489
|
+
# template in your Amazon SES account.
|
3490
|
+
# @return [Array<Types::EmailTemplateMetadata>]
|
3491
|
+
#
|
3492
|
+
# @!attribute [rw] next_token
|
3493
|
+
# A token indicating that there are additional email templates
|
3494
|
+
# available to be listed. Pass this token to a subsequent
|
3495
|
+
# `ListEmailTemplates` call to retrieve the next 10 email templates.
|
3496
|
+
# @return [String]
|
3497
|
+
#
|
3498
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/ListEmailTemplatesResponse AWS API Documentation
|
3499
|
+
#
|
3500
|
+
class ListEmailTemplatesResponse < Struct.new(
|
3501
|
+
:templates_metadata,
|
3502
|
+
:next_token)
|
3503
|
+
SENSITIVE = []
|
3504
|
+
include Aws::Structure
|
3505
|
+
end
|
3506
|
+
|
2639
3507
|
# A request to obtain a list of email destinations that are on the
|
2640
3508
|
# suppression list for your account.
|
2641
3509
|
#
|
@@ -3033,22 +3901,95 @@ module Aws::SESV2
|
|
3033
3901
|
#
|
3034
3902
|
class PutAccountDedicatedIpWarmupAttributesResponse < Aws::EmptyStructure; end
|
3035
3903
|
|
3036
|
-
# A request to
|
3904
|
+
# A request to submit new account details.
|
3037
3905
|
#
|
3038
|
-
# @note When making an API call, you may pass
|
3906
|
+
# @note When making an API call, you may pass PutAccountDetailsRequest
|
3039
3907
|
# data as a hash:
|
3040
3908
|
#
|
3041
3909
|
# {
|
3042
|
-
#
|
3910
|
+
# mail_type: "MARKETING", # required, accepts MARKETING, TRANSACTIONAL
|
3911
|
+
# website_url: "WebsiteURL", # required
|
3912
|
+
# contact_language: "EN", # accepts EN, JA
|
3913
|
+
# use_case_description: "UseCaseDescription", # required
|
3914
|
+
# additional_contact_email_addresses: ["AdditionalContactEmailAddress"],
|
3915
|
+
# production_access_enabled: false,
|
3043
3916
|
# }
|
3044
3917
|
#
|
3045
|
-
# @!attribute [rw]
|
3046
|
-
#
|
3047
|
-
#
|
3048
|
-
# sending.
|
3918
|
+
# @!attribute [rw] mail_type
|
3919
|
+
# The type of email your account will send.
|
3920
|
+
# @return [String]
|
3049
3921
|
#
|
3050
|
-
#
|
3051
|
-
#
|
3922
|
+
# @!attribute [rw] website_url
|
3923
|
+
# The URL of your website. This information helps us better understand
|
3924
|
+
# the type of content that you plan to send.
|
3925
|
+
# @return [String]
|
3926
|
+
#
|
3927
|
+
# @!attribute [rw] contact_language
|
3928
|
+
# The language you would prefer to be contacted with.
|
3929
|
+
# @return [String]
|
3930
|
+
#
|
3931
|
+
# @!attribute [rw] use_case_description
|
3932
|
+
# A description of the types of email that you plan to send.
|
3933
|
+
# @return [String]
|
3934
|
+
#
|
3935
|
+
# @!attribute [rw] additional_contact_email_addresses
|
3936
|
+
# Additional email addresses that you would like to be notified
|
3937
|
+
# regarding Amazon SES matters.
|
3938
|
+
# @return [Array<String>]
|
3939
|
+
#
|
3940
|
+
# @!attribute [rw] production_access_enabled
|
3941
|
+
# Indicates whether or not your account should have production access
|
3942
|
+
# in the current AWS Region.
|
3943
|
+
#
|
3944
|
+
# If the value is `false`, then your account is in the *sandbox*. When
|
3945
|
+
# your account is in the sandbox, you can only send email to verified
|
3946
|
+
# identities. Additionally, the maximum number of emails you can send
|
3947
|
+
# in a 24-hour period (your sending quota) is 200, and the maximum
|
3948
|
+
# number of emails you can send per second (your maximum sending rate)
|
3949
|
+
# is 1.
|
3950
|
+
#
|
3951
|
+
# If the value is `true`, then your account has production access.
|
3952
|
+
# When your account has production access, you can send email to any
|
3953
|
+
# address. The sending quota and maximum sending rate for your account
|
3954
|
+
# vary based on your specific use case.
|
3955
|
+
# @return [Boolean]
|
3956
|
+
#
|
3957
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/PutAccountDetailsRequest AWS API Documentation
|
3958
|
+
#
|
3959
|
+
class PutAccountDetailsRequest < Struct.new(
|
3960
|
+
:mail_type,
|
3961
|
+
:website_url,
|
3962
|
+
:contact_language,
|
3963
|
+
:use_case_description,
|
3964
|
+
:additional_contact_email_addresses,
|
3965
|
+
:production_access_enabled)
|
3966
|
+
SENSITIVE = [:website_url, :use_case_description, :additional_contact_email_addresses]
|
3967
|
+
include Aws::Structure
|
3968
|
+
end
|
3969
|
+
|
3970
|
+
# An HTTP 200 response if the request succeeds, or an error message if
|
3971
|
+
# the request fails.
|
3972
|
+
#
|
3973
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/PutAccountDetailsResponse AWS API Documentation
|
3974
|
+
#
|
3975
|
+
class PutAccountDetailsResponse < Aws::EmptyStructure; end
|
3976
|
+
|
3977
|
+
# A request to change the ability of your account to send email.
|
3978
|
+
#
|
3979
|
+
# @note When making an API call, you may pass PutAccountSendingAttributesRequest
|
3980
|
+
# data as a hash:
|
3981
|
+
#
|
3982
|
+
# {
|
3983
|
+
# sending_enabled: false,
|
3984
|
+
# }
|
3985
|
+
#
|
3986
|
+
# @!attribute [rw] sending_enabled
|
3987
|
+
# Enables or disables your account's ability to send email. Set to
|
3988
|
+
# `true` to enable email sending, or set to `false` to disable email
|
3989
|
+
# sending.
|
3990
|
+
#
|
3991
|
+
# <note markdown="1"> If AWS paused your account's ability to send email, you can't use
|
3992
|
+
# this operation to resume your account's ability to send email.
|
3052
3993
|
#
|
3053
3994
|
# </note>
|
3054
3995
|
# @return [Boolean]
|
@@ -3791,6 +4732,56 @@ module Aws::SESV2
|
|
3791
4732
|
include Aws::Structure
|
3792
4733
|
end
|
3793
4734
|
|
4735
|
+
# The `ReplaceEmailContent` object to be used for a specific
|
4736
|
+
# `BulkEmailEntry`. The `ReplacementTemplate` can be specified within
|
4737
|
+
# this object.
|
4738
|
+
#
|
4739
|
+
# @note When making an API call, you may pass ReplacementEmailContent
|
4740
|
+
# data as a hash:
|
4741
|
+
#
|
4742
|
+
# {
|
4743
|
+
# replacement_template: {
|
4744
|
+
# replacement_template_data: "EmailTemplateData",
|
4745
|
+
# },
|
4746
|
+
# }
|
4747
|
+
#
|
4748
|
+
# @!attribute [rw] replacement_template
|
4749
|
+
# The `ReplacementTemplate` associated with `ReplacementEmailContent`.
|
4750
|
+
# @return [Types::ReplacementTemplate]
|
4751
|
+
#
|
4752
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/ReplacementEmailContent AWS API Documentation
|
4753
|
+
#
|
4754
|
+
class ReplacementEmailContent < Struct.new(
|
4755
|
+
:replacement_template)
|
4756
|
+
SENSITIVE = []
|
4757
|
+
include Aws::Structure
|
4758
|
+
end
|
4759
|
+
|
4760
|
+
# An object which contains `ReplacementTemplateData` to be used for a
|
4761
|
+
# specific `BulkEmailEntry`.
|
4762
|
+
#
|
4763
|
+
# @note When making an API call, you may pass ReplacementTemplate
|
4764
|
+
# data as a hash:
|
4765
|
+
#
|
4766
|
+
# {
|
4767
|
+
# replacement_template_data: "EmailTemplateData",
|
4768
|
+
# }
|
4769
|
+
#
|
4770
|
+
# @!attribute [rw] replacement_template_data
|
4771
|
+
# A list of replacement values to apply to the template. This
|
4772
|
+
# parameter is a JSON object, typically consisting of key-value pairs
|
4773
|
+
# in which the keys correspond to replacement tags in the email
|
4774
|
+
# template.
|
4775
|
+
# @return [String]
|
4776
|
+
#
|
4777
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/ReplacementTemplate AWS API Documentation
|
4778
|
+
#
|
4779
|
+
class ReplacementTemplate < Struct.new(
|
4780
|
+
:replacement_template_data)
|
4781
|
+
SENSITIVE = []
|
4782
|
+
include Aws::Structure
|
4783
|
+
end
|
4784
|
+
|
3794
4785
|
# Enable or disable collection of reputation metrics for emails that you
|
3795
4786
|
# send using this configuration set in the current AWS Region.
|
3796
4787
|
#
|
@@ -3824,20 +4815,271 @@ module Aws::SESV2
|
|
3824
4815
|
include Aws::Structure
|
3825
4816
|
end
|
3826
4817
|
|
3827
|
-
#
|
4818
|
+
# An object that contains information about your account details review.
|
4819
|
+
#
|
4820
|
+
# @!attribute [rw] status
|
4821
|
+
# The status of the latest review of your account. The status can be
|
4822
|
+
# one of the following:
|
4823
|
+
#
|
4824
|
+
# * `PENDING` – We have received your appeal and are in the process of
|
4825
|
+
# reviewing it.
|
4826
|
+
#
|
4827
|
+
# * `GRANTED` – Your appeal has been reviewed and your production
|
4828
|
+
# access has been granted.
|
4829
|
+
#
|
4830
|
+
# * `DENIED` – Your appeal has been reviewed and your production
|
4831
|
+
# access has been denied.
|
4832
|
+
#
|
4833
|
+
# * `FAILED` – An internal error occurred and we didn't receive your
|
4834
|
+
# appeal. You can submit your appeal again.
|
4835
|
+
# @return [String]
|
4836
|
+
#
|
4837
|
+
# @!attribute [rw] case_id
|
4838
|
+
# The associated support center case ID (if any).
|
4839
|
+
# @return [String]
|
4840
|
+
#
|
4841
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/ReviewDetails AWS API Documentation
|
4842
|
+
#
|
4843
|
+
class ReviewDetails < Struct.new(
|
4844
|
+
:status,
|
4845
|
+
:case_id)
|
4846
|
+
SENSITIVE = []
|
4847
|
+
include Aws::Structure
|
4848
|
+
end
|
4849
|
+
|
4850
|
+
# Represents a request to send email messages to multiple destinations
|
4851
|
+
# using Amazon SES. For more information, see the [Amazon SES Developer
|
4852
|
+
# Guide][1].
|
4853
|
+
#
|
4854
|
+
#
|
4855
|
+
#
|
4856
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-personalized-email-api.html
|
4857
|
+
#
|
4858
|
+
# @note When making an API call, you may pass SendBulkEmailRequest
|
4859
|
+
# data as a hash:
|
4860
|
+
#
|
4861
|
+
# {
|
4862
|
+
# from_email_address: "EmailAddress",
|
4863
|
+
# from_email_address_identity_arn: "AmazonResourceName",
|
4864
|
+
# reply_to_addresses: ["EmailAddress"],
|
4865
|
+
# feedback_forwarding_email_address: "EmailAddress",
|
4866
|
+
# feedback_forwarding_email_address_identity_arn: "AmazonResourceName",
|
4867
|
+
# default_email_tags: [
|
4868
|
+
# {
|
4869
|
+
# name: "MessageTagName", # required
|
4870
|
+
# value: "MessageTagValue", # required
|
4871
|
+
# },
|
4872
|
+
# ],
|
4873
|
+
# default_content: { # required
|
4874
|
+
# template: {
|
4875
|
+
# template_name: "EmailTemplateName",
|
4876
|
+
# template_arn: "AmazonResourceName",
|
4877
|
+
# template_data: "EmailTemplateData",
|
4878
|
+
# },
|
4879
|
+
# },
|
4880
|
+
# bulk_email_entries: [ # required
|
4881
|
+
# {
|
4882
|
+
# destination: { # required
|
4883
|
+
# to_addresses: ["EmailAddress"],
|
4884
|
+
# cc_addresses: ["EmailAddress"],
|
4885
|
+
# bcc_addresses: ["EmailAddress"],
|
4886
|
+
# },
|
4887
|
+
# replacement_tags: [
|
4888
|
+
# {
|
4889
|
+
# name: "MessageTagName", # required
|
4890
|
+
# value: "MessageTagValue", # required
|
4891
|
+
# },
|
4892
|
+
# ],
|
4893
|
+
# replacement_email_content: {
|
4894
|
+
# replacement_template: {
|
4895
|
+
# replacement_template_data: "EmailTemplateData",
|
4896
|
+
# },
|
4897
|
+
# },
|
4898
|
+
# },
|
4899
|
+
# ],
|
4900
|
+
# configuration_set_name: "ConfigurationSetName",
|
4901
|
+
# }
|
4902
|
+
#
|
4903
|
+
# @!attribute [rw] from_email_address
|
4904
|
+
# The email address that you want to use as the "From" address for
|
4905
|
+
# the email. The address that you specify has to be verified.
|
4906
|
+
# @return [String]
|
4907
|
+
#
|
4908
|
+
# @!attribute [rw] from_email_address_identity_arn
|
4909
|
+
# This parameter is used only for sending authorization. It is the ARN
|
4910
|
+
# of the identity that is associated with the sending authorization
|
4911
|
+
# policy that permits you to use the email address specified in the
|
4912
|
+
# `FromEmailAddress` parameter.
|
4913
|
+
#
|
4914
|
+
# For example, if the owner of example.com (which has ARN
|
4915
|
+
# arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a
|
4916
|
+
# policy to it that authorizes you to use sender@example.com, then you
|
4917
|
+
# would specify the `FromEmailAddressIdentityArn` to be
|
4918
|
+
# arn:aws:ses:us-east-1:123456789012:identity/example.com, and the
|
4919
|
+
# `FromEmailAddress` to be sender@example.com.
|
4920
|
+
#
|
4921
|
+
# For more information about sending authorization, see the [Amazon
|
4922
|
+
# SES Developer Guide][1].
|
4923
|
+
#
|
4924
|
+
#
|
4925
|
+
#
|
4926
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html
|
4927
|
+
# @return [String]
|
4928
|
+
#
|
4929
|
+
# @!attribute [rw] reply_to_addresses
|
4930
|
+
# The "Reply-to" email addresses for the message. When the recipient
|
4931
|
+
# replies to the message, each Reply-to address receives the reply.
|
4932
|
+
# @return [Array<String>]
|
4933
|
+
#
|
4934
|
+
# @!attribute [rw] feedback_forwarding_email_address
|
4935
|
+
# The address that you want bounce and complaint notifications to be
|
4936
|
+
# sent to.
|
4937
|
+
# @return [String]
|
4938
|
+
#
|
4939
|
+
# @!attribute [rw] feedback_forwarding_email_address_identity_arn
|
4940
|
+
# This parameter is used only for sending authorization. It is the ARN
|
4941
|
+
# of the identity that is associated with the sending authorization
|
4942
|
+
# policy that permits you to use the email address specified in the
|
4943
|
+
# `FeedbackForwardingEmailAddress` parameter.
|
4944
|
+
#
|
4945
|
+
# For example, if the owner of example.com (which has ARN
|
4946
|
+
# arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a
|
4947
|
+
# policy to it that authorizes you to use feedback@example.com, then
|
4948
|
+
# you would specify the `FeedbackForwardingEmailAddressIdentityArn` to
|
4949
|
+
# be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the
|
4950
|
+
# `FeedbackForwardingEmailAddress` to be feedback@example.com.
|
4951
|
+
#
|
4952
|
+
# For more information about sending authorization, see the [Amazon
|
4953
|
+
# SES Developer Guide][1].
|
4954
|
+
#
|
4955
|
+
#
|
4956
|
+
#
|
4957
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html
|
4958
|
+
# @return [String]
|
4959
|
+
#
|
4960
|
+
# @!attribute [rw] default_email_tags
|
4961
|
+
# A list of tags, in the form of name/value pairs, to apply to an
|
4962
|
+
# email that you send using the `SendEmail` operation. Tags correspond
|
4963
|
+
# to characteristics of the email that you define, so that you can
|
4964
|
+
# publish email sending events.
|
4965
|
+
# @return [Array<Types::MessageTag>]
|
4966
|
+
#
|
4967
|
+
# @!attribute [rw] default_content
|
4968
|
+
# An object that contains the body of the message. You can specify a
|
4969
|
+
# template message.
|
4970
|
+
# @return [Types::BulkEmailContent]
|
4971
|
+
#
|
4972
|
+
# @!attribute [rw] bulk_email_entries
|
4973
|
+
# The list of bulk email entry objects.
|
4974
|
+
# @return [Array<Types::BulkEmailEntry>]
|
4975
|
+
#
|
4976
|
+
# @!attribute [rw] configuration_set_name
|
4977
|
+
# The name of the configuration set that you want to use when sending
|
4978
|
+
# the email.
|
4979
|
+
# @return [String]
|
4980
|
+
#
|
4981
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/SendBulkEmailRequest AWS API Documentation
|
4982
|
+
#
|
4983
|
+
class SendBulkEmailRequest < Struct.new(
|
4984
|
+
:from_email_address,
|
4985
|
+
:from_email_address_identity_arn,
|
4986
|
+
:reply_to_addresses,
|
4987
|
+
:feedback_forwarding_email_address,
|
4988
|
+
:feedback_forwarding_email_address_identity_arn,
|
4989
|
+
:default_email_tags,
|
4990
|
+
:default_content,
|
4991
|
+
:bulk_email_entries,
|
4992
|
+
:configuration_set_name)
|
4993
|
+
SENSITIVE = []
|
4994
|
+
include Aws::Structure
|
4995
|
+
end
|
4996
|
+
|
4997
|
+
# The following data is returned in JSON format by the service.
|
4998
|
+
#
|
4999
|
+
# @!attribute [rw] bulk_email_entry_results
|
5000
|
+
# A list of `BulkMailEntry` objects.
|
5001
|
+
# @return [Array<Types::BulkEmailEntryResult>]
|
5002
|
+
#
|
5003
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/SendBulkEmailResponse AWS API Documentation
|
5004
|
+
#
|
5005
|
+
class SendBulkEmailResponse < Struct.new(
|
5006
|
+
:bulk_email_entry_results)
|
5007
|
+
SENSITIVE = []
|
5008
|
+
include Aws::Structure
|
5009
|
+
end
|
5010
|
+
|
5011
|
+
# Represents a request to send a custom verification email to a
|
5012
|
+
# specified recipient.
|
5013
|
+
#
|
5014
|
+
# @note When making an API call, you may pass SendCustomVerificationEmailRequest
|
5015
|
+
# data as a hash:
|
5016
|
+
#
|
5017
|
+
# {
|
5018
|
+
# email_address: "EmailAddress", # required
|
5019
|
+
# template_name: "EmailTemplateName", # required
|
5020
|
+
# configuration_set_name: "ConfigurationSetName",
|
5021
|
+
# }
|
5022
|
+
#
|
5023
|
+
# @!attribute [rw] email_address
|
5024
|
+
# The email address to verify.
|
5025
|
+
# @return [String]
|
5026
|
+
#
|
5027
|
+
# @!attribute [rw] template_name
|
5028
|
+
# The name of the custom verification email template to use when
|
5029
|
+
# sending the verification email.
|
5030
|
+
# @return [String]
|
5031
|
+
#
|
5032
|
+
# @!attribute [rw] configuration_set_name
|
5033
|
+
# Name of a configuration set to use when sending the verification
|
5034
|
+
# email.
|
5035
|
+
# @return [String]
|
5036
|
+
#
|
5037
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/SendCustomVerificationEmailRequest AWS API Documentation
|
5038
|
+
#
|
5039
|
+
class SendCustomVerificationEmailRequest < Struct.new(
|
5040
|
+
:email_address,
|
5041
|
+
:template_name,
|
5042
|
+
:configuration_set_name)
|
5043
|
+
SENSITIVE = []
|
5044
|
+
include Aws::Structure
|
5045
|
+
end
|
5046
|
+
|
5047
|
+
# The following element is returned by the service.
|
5048
|
+
#
|
5049
|
+
# @!attribute [rw] message_id
|
5050
|
+
# The unique message identifier returned from the
|
5051
|
+
# `SendCustomVerificationEmail` operation.
|
5052
|
+
# @return [String]
|
5053
|
+
#
|
5054
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/SendCustomVerificationEmailResponse AWS API Documentation
|
5055
|
+
#
|
5056
|
+
class SendCustomVerificationEmailResponse < Struct.new(
|
5057
|
+
:message_id)
|
5058
|
+
SENSITIVE = []
|
5059
|
+
include Aws::Structure
|
5060
|
+
end
|
5061
|
+
|
5062
|
+
# Represents a request to send a single formatted email using Amazon
|
5063
|
+
# SES. For more information, see the [Amazon SES Developer Guide][1].
|
5064
|
+
#
|
5065
|
+
#
|
5066
|
+
#
|
5067
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-email-formatted.html
|
3828
5068
|
#
|
3829
5069
|
# @note When making an API call, you may pass SendEmailRequest
|
3830
5070
|
# data as a hash:
|
3831
5071
|
#
|
3832
5072
|
# {
|
3833
5073
|
# from_email_address: "EmailAddress",
|
3834
|
-
#
|
5074
|
+
# from_email_address_identity_arn: "AmazonResourceName",
|
5075
|
+
# destination: {
|
3835
5076
|
# to_addresses: ["EmailAddress"],
|
3836
5077
|
# cc_addresses: ["EmailAddress"],
|
3837
5078
|
# bcc_addresses: ["EmailAddress"],
|
3838
5079
|
# },
|
3839
5080
|
# reply_to_addresses: ["EmailAddress"],
|
3840
5081
|
# feedback_forwarding_email_address: "EmailAddress",
|
5082
|
+
# feedback_forwarding_email_address_identity_arn: "AmazonResourceName",
|
3841
5083
|
# content: { # required
|
3842
5084
|
# simple: {
|
3843
5085
|
# subject: { # required
|
@@ -3859,8 +5101,9 @@ module Aws::SESV2
|
|
3859
5101
|
# data: "data", # required
|
3860
5102
|
# },
|
3861
5103
|
# template: {
|
3862
|
-
#
|
3863
|
-
#
|
5104
|
+
# template_name: "EmailTemplateName",
|
5105
|
+
# template_arn: "AmazonResourceName",
|
5106
|
+
# template_data: "EmailTemplateData",
|
3864
5107
|
# },
|
3865
5108
|
# },
|
3866
5109
|
# email_tags: [
|
@@ -3877,6 +5120,31 @@ module Aws::SESV2
|
|
3877
5120
|
# the email. The address that you specify has to be verified.
|
3878
5121
|
# @return [String]
|
3879
5122
|
#
|
5123
|
+
# @!attribute [rw] from_email_address_identity_arn
|
5124
|
+
# This parameter is used only for sending authorization. It is the ARN
|
5125
|
+
# of the identity that is associated with the sending authorization
|
5126
|
+
# policy that permits you to use the email address specified in the
|
5127
|
+
# `FromEmailAddress` parameter.
|
5128
|
+
#
|
5129
|
+
# For example, if the owner of example.com (which has ARN
|
5130
|
+
# arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a
|
5131
|
+
# policy to it that authorizes you to use sender@example.com, then you
|
5132
|
+
# would specify the `FromEmailAddressIdentityArn` to be
|
5133
|
+
# arn:aws:ses:us-east-1:123456789012:identity/example.com, and the
|
5134
|
+
# `FromEmailAddress` to be sender@example.com.
|
5135
|
+
#
|
5136
|
+
# For more information about sending authorization, see the [Amazon
|
5137
|
+
# SES Developer Guide][1].
|
5138
|
+
#
|
5139
|
+
# For Raw emails, the `FromEmailAddressIdentityArn` value overrides
|
5140
|
+
# the X-SES-SOURCE-ARN and X-SES-FROM-ARN headers specified in raw
|
5141
|
+
# email message content.
|
5142
|
+
#
|
5143
|
+
#
|
5144
|
+
#
|
5145
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html
|
5146
|
+
# @return [String]
|
5147
|
+
#
|
3880
5148
|
# @!attribute [rw] destination
|
3881
5149
|
# An object that contains the recipients of the email message.
|
3882
5150
|
# @return [Types::Destination]
|
@@ -3891,9 +5159,30 @@ module Aws::SESV2
|
|
3891
5159
|
# sent to.
|
3892
5160
|
# @return [String]
|
3893
5161
|
#
|
5162
|
+
# @!attribute [rw] feedback_forwarding_email_address_identity_arn
|
5163
|
+
# This parameter is used only for sending authorization. It is the ARN
|
5164
|
+
# of the identity that is associated with the sending authorization
|
5165
|
+
# policy that permits you to use the email address specified in the
|
5166
|
+
# `FeedbackForwardingEmailAddress` parameter.
|
5167
|
+
#
|
5168
|
+
# For example, if the owner of example.com (which has ARN
|
5169
|
+
# arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a
|
5170
|
+
# policy to it that authorizes you to use feedback@example.com, then
|
5171
|
+
# you would specify the `FeedbackForwardingEmailAddressIdentityArn` to
|
5172
|
+
# be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the
|
5173
|
+
# `FeedbackForwardingEmailAddress` to be feedback@example.com.
|
5174
|
+
#
|
5175
|
+
# For more information about sending authorization, see the [Amazon
|
5176
|
+
# SES Developer Guide][1].
|
5177
|
+
#
|
5178
|
+
#
|
5179
|
+
#
|
5180
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html
|
5181
|
+
# @return [String]
|
5182
|
+
#
|
3894
5183
|
# @!attribute [rw] content
|
3895
5184
|
# An object that contains the body of the message. You can send either
|
3896
|
-
# a Simple message or a
|
5185
|
+
# a Simple message Raw message or a template Message.
|
3897
5186
|
# @return [Types::EmailContent]
|
3898
5187
|
#
|
3899
5188
|
# @!attribute [rw] email_tags
|
@@ -3912,9 +5201,11 @@ module Aws::SESV2
|
|
3912
5201
|
#
|
3913
5202
|
class SendEmailRequest < Struct.new(
|
3914
5203
|
:from_email_address,
|
5204
|
+
:from_email_address_identity_arn,
|
3915
5205
|
:destination,
|
3916
5206
|
:reply_to_addresses,
|
3917
5207
|
:feedback_forwarding_email_address,
|
5208
|
+
:feedback_forwarding_email_address_identity_arn,
|
3918
5209
|
:content,
|
3919
5210
|
:email_tags,
|
3920
5211
|
:configuration_set_name)
|
@@ -4282,10 +5573,17 @@ module Aws::SESV2
|
|
4282
5573
|
# data as a hash:
|
4283
5574
|
#
|
4284
5575
|
# {
|
4285
|
-
#
|
4286
|
-
#
|
5576
|
+
# template_name: "EmailTemplateName",
|
5577
|
+
# template_arn: "AmazonResourceName",
|
5578
|
+
# template_data: "EmailTemplateData",
|
4287
5579
|
# }
|
4288
5580
|
#
|
5581
|
+
# @!attribute [rw] template_name
|
5582
|
+
# The name of the template. You will refer to this name when you send
|
5583
|
+
# email using the `SendTemplatedEmail` or `SendBulkTemplatedEmail`
|
5584
|
+
# operations.
|
5585
|
+
# @return [String]
|
5586
|
+
#
|
4289
5587
|
# @!attribute [rw] template_arn
|
4290
5588
|
# The Amazon Resource Name (ARN) of the template.
|
4291
5589
|
# @return [String]
|
@@ -4300,12 +5598,60 @@ module Aws::SESV2
|
|
4300
5598
|
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/Template AWS API Documentation
|
4301
5599
|
#
|
4302
5600
|
class Template < Struct.new(
|
5601
|
+
:template_name,
|
4303
5602
|
:template_arn,
|
4304
5603
|
:template_data)
|
4305
5604
|
SENSITIVE = []
|
4306
5605
|
include Aws::Structure
|
4307
5606
|
end
|
4308
5607
|
|
5608
|
+
# >Represents a request to create a preview of the MIME content of an
|
5609
|
+
# email when provided with a template and a set of replacement data.
|
5610
|
+
#
|
5611
|
+
# @note When making an API call, you may pass TestRenderEmailTemplateRequest
|
5612
|
+
# data as a hash:
|
5613
|
+
#
|
5614
|
+
# {
|
5615
|
+
# template_name: "EmailTemplateName", # required
|
5616
|
+
# template_data: "EmailTemplateData", # required
|
5617
|
+
# }
|
5618
|
+
#
|
5619
|
+
# @!attribute [rw] template_name
|
5620
|
+
# The name of the template that you want to render.
|
5621
|
+
# @return [String]
|
5622
|
+
#
|
5623
|
+
# @!attribute [rw] template_data
|
5624
|
+
# A list of replacement values to apply to the template. This
|
5625
|
+
# parameter is a JSON object, typically consisting of key-value pairs
|
5626
|
+
# in which the keys correspond to replacement tags in the email
|
5627
|
+
# template.
|
5628
|
+
# @return [String]
|
5629
|
+
#
|
5630
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/TestRenderEmailTemplateRequest AWS API Documentation
|
5631
|
+
#
|
5632
|
+
class TestRenderEmailTemplateRequest < Struct.new(
|
5633
|
+
:template_name,
|
5634
|
+
:template_data)
|
5635
|
+
SENSITIVE = []
|
5636
|
+
include Aws::Structure
|
5637
|
+
end
|
5638
|
+
|
5639
|
+
# The following element is returned by the service.
|
5640
|
+
#
|
5641
|
+
# @!attribute [rw] rendered_template
|
5642
|
+
# The complete MIME message rendered by applying the data in the
|
5643
|
+
# `TemplateData` parameter to the template specified in the
|
5644
|
+
# TemplateName parameter.
|
5645
|
+
# @return [String]
|
5646
|
+
#
|
5647
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/TestRenderEmailTemplateResponse AWS API Documentation
|
5648
|
+
#
|
5649
|
+
class TestRenderEmailTemplateResponse < Struct.new(
|
5650
|
+
:rendered_template)
|
5651
|
+
SENSITIVE = []
|
5652
|
+
include Aws::Structure
|
5653
|
+
end
|
5654
|
+
|
4309
5655
|
# Too many requests have been made to the operation.
|
4310
5656
|
#
|
4311
5657
|
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/TooManyRequestsException AWS API Documentation
|
@@ -4442,6 +5788,178 @@ module Aws::SESV2
|
|
4442
5788
|
#
|
4443
5789
|
class UpdateConfigurationSetEventDestinationResponse < Aws::EmptyStructure; end
|
4444
5790
|
|
5791
|
+
# Represents a request to update an existing custom verification email
|
5792
|
+
# template.
|
5793
|
+
#
|
5794
|
+
# @note When making an API call, you may pass UpdateCustomVerificationEmailTemplateRequest
|
5795
|
+
# data as a hash:
|
5796
|
+
#
|
5797
|
+
# {
|
5798
|
+
# template_name: "EmailTemplateName", # required
|
5799
|
+
# from_email_address: "EmailAddress", # required
|
5800
|
+
# template_subject: "EmailTemplateSubject", # required
|
5801
|
+
# template_content: "TemplateContent", # required
|
5802
|
+
# success_redirection_url: "SuccessRedirectionURL", # required
|
5803
|
+
# failure_redirection_url: "FailureRedirectionURL", # required
|
5804
|
+
# }
|
5805
|
+
#
|
5806
|
+
# @!attribute [rw] template_name
|
5807
|
+
# The name of the custom verification email template that you want to
|
5808
|
+
# update.
|
5809
|
+
# @return [String]
|
5810
|
+
#
|
5811
|
+
# @!attribute [rw] from_email_address
|
5812
|
+
# The email address that the custom verification email is sent from.
|
5813
|
+
# @return [String]
|
5814
|
+
#
|
5815
|
+
# @!attribute [rw] template_subject
|
5816
|
+
# The subject line of the custom verification email.
|
5817
|
+
# @return [String]
|
5818
|
+
#
|
5819
|
+
# @!attribute [rw] template_content
|
5820
|
+
# The content of the custom verification email. The total size of the
|
5821
|
+
# email must be less than 10 MB. The message body may contain HTML,
|
5822
|
+
# with some limitations. For more information, see [Custom
|
5823
|
+
# Verification Email Frequently Asked Questions][1] in the *Amazon SES
|
5824
|
+
# Developer Guide*.
|
5825
|
+
#
|
5826
|
+
#
|
5827
|
+
#
|
5828
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-email-verify-address-custom.html#custom-verification-emails-faq
|
5829
|
+
# @return [String]
|
5830
|
+
#
|
5831
|
+
# @!attribute [rw] success_redirection_url
|
5832
|
+
# The URL that the recipient of the verification email is sent to if
|
5833
|
+
# his or her address is successfully verified.
|
5834
|
+
# @return [String]
|
5835
|
+
#
|
5836
|
+
# @!attribute [rw] failure_redirection_url
|
5837
|
+
# The URL that the recipient of the verification email is sent to if
|
5838
|
+
# his or her address is not successfully verified.
|
5839
|
+
# @return [String]
|
5840
|
+
#
|
5841
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/UpdateCustomVerificationEmailTemplateRequest AWS API Documentation
|
5842
|
+
#
|
5843
|
+
class UpdateCustomVerificationEmailTemplateRequest < Struct.new(
|
5844
|
+
:template_name,
|
5845
|
+
:from_email_address,
|
5846
|
+
:template_subject,
|
5847
|
+
:template_content,
|
5848
|
+
:success_redirection_url,
|
5849
|
+
:failure_redirection_url)
|
5850
|
+
SENSITIVE = []
|
5851
|
+
include Aws::Structure
|
5852
|
+
end
|
5853
|
+
|
5854
|
+
# If the action is successful, the service sends back an HTTP 200
|
5855
|
+
# response with an empty HTTP body.
|
5856
|
+
#
|
5857
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/UpdateCustomVerificationEmailTemplateResponse AWS API Documentation
|
5858
|
+
#
|
5859
|
+
class UpdateCustomVerificationEmailTemplateResponse < Aws::EmptyStructure; end
|
5860
|
+
|
5861
|
+
# Represents a request to update a sending authorization policy for an
|
5862
|
+
# identity. Sending authorization is an Amazon SES feature that enables
|
5863
|
+
# you to authorize other senders to use your identities. For
|
5864
|
+
# information, see the [Amazon SES Developer Guide][1].
|
5865
|
+
#
|
5866
|
+
#
|
5867
|
+
#
|
5868
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization-identity-owner-tasks-management.html
|
5869
|
+
#
|
5870
|
+
# @note When making an API call, you may pass UpdateEmailIdentityPolicyRequest
|
5871
|
+
# data as a hash:
|
5872
|
+
#
|
5873
|
+
# {
|
5874
|
+
# email_identity: "Identity", # required
|
5875
|
+
# policy_name: "PolicyName", # required
|
5876
|
+
# policy: "Policy", # required
|
5877
|
+
# }
|
5878
|
+
#
|
5879
|
+
# @!attribute [rw] email_identity
|
5880
|
+
# The email identity for which you want to update policy.
|
5881
|
+
# @return [String]
|
5882
|
+
#
|
5883
|
+
# @!attribute [rw] policy_name
|
5884
|
+
# The name of the policy.
|
5885
|
+
#
|
5886
|
+
# The policy name cannot exceed 64 characters and can only include
|
5887
|
+
# alphanumeric characters, dashes, and underscores.
|
5888
|
+
# @return [String]
|
5889
|
+
#
|
5890
|
+
# @!attribute [rw] policy
|
5891
|
+
# The text of the policy in JSON format. The policy cannot exceed 4
|
5892
|
+
# KB.
|
5893
|
+
#
|
5894
|
+
# For information about the syntax of sending authorization policies,
|
5895
|
+
# see the [Amazon SES Developer Guide][1].
|
5896
|
+
#
|
5897
|
+
#
|
5898
|
+
#
|
5899
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization-policies.html
|
5900
|
+
# @return [String]
|
5901
|
+
#
|
5902
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/UpdateEmailIdentityPolicyRequest AWS API Documentation
|
5903
|
+
#
|
5904
|
+
class UpdateEmailIdentityPolicyRequest < Struct.new(
|
5905
|
+
:email_identity,
|
5906
|
+
:policy_name,
|
5907
|
+
:policy)
|
5908
|
+
SENSITIVE = []
|
5909
|
+
include Aws::Structure
|
5910
|
+
end
|
5911
|
+
|
5912
|
+
# An HTTP 200 response if the request succeeds, or an error message if
|
5913
|
+
# the request fails.
|
5914
|
+
#
|
5915
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/UpdateEmailIdentityPolicyResponse AWS API Documentation
|
5916
|
+
#
|
5917
|
+
class UpdateEmailIdentityPolicyResponse < Aws::EmptyStructure; end
|
5918
|
+
|
5919
|
+
# Represents a request to update an email template. For more
|
5920
|
+
# information, see the [Amazon SES Developer Guide][1].
|
5921
|
+
#
|
5922
|
+
#
|
5923
|
+
#
|
5924
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-personalized-email-api.html
|
5925
|
+
#
|
5926
|
+
# @note When making an API call, you may pass UpdateEmailTemplateRequest
|
5927
|
+
# data as a hash:
|
5928
|
+
#
|
5929
|
+
# {
|
5930
|
+
# template_name: "EmailTemplateName", # required
|
5931
|
+
# template_content: { # required
|
5932
|
+
# subject: "EmailTemplateSubject",
|
5933
|
+
# text: "EmailTemplateText",
|
5934
|
+
# html: "EmailTemplateHtml",
|
5935
|
+
# },
|
5936
|
+
# }
|
5937
|
+
#
|
5938
|
+
# @!attribute [rw] template_name
|
5939
|
+
# The name of the template you want to update.
|
5940
|
+
# @return [String]
|
5941
|
+
#
|
5942
|
+
# @!attribute [rw] template_content
|
5943
|
+
# The content of the email template, composed of a subject line, an
|
5944
|
+
# HTML part, and a text-only part.
|
5945
|
+
# @return [Types::EmailTemplateContent]
|
5946
|
+
#
|
5947
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/UpdateEmailTemplateRequest AWS API Documentation
|
5948
|
+
#
|
5949
|
+
class UpdateEmailTemplateRequest < Struct.new(
|
5950
|
+
:template_name,
|
5951
|
+
:template_content)
|
5952
|
+
SENSITIVE = []
|
5953
|
+
include Aws::Structure
|
5954
|
+
end
|
5955
|
+
|
5956
|
+
# If the action is successful, the service sends back an HTTP 200
|
5957
|
+
# response with an empty HTTP body.
|
5958
|
+
#
|
5959
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/UpdateEmailTemplateResponse AWS API Documentation
|
5960
|
+
#
|
5961
|
+
class UpdateEmailTemplateResponse < Aws::EmptyStructure; end
|
5962
|
+
|
4445
5963
|
# An object that contains information about the amount of email that was
|
4446
5964
|
# delivered to recipients.
|
4447
5965
|
#
|