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
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,136 @@ 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
|
+
# Represents a request to create an import job from a data source for a
|
998
|
+
# data destination.
|
999
|
+
#
|
1000
|
+
# @note When making an API call, you may pass CreateImportJobRequest
|
1001
|
+
# data as a hash:
|
1002
|
+
#
|
1003
|
+
# {
|
1004
|
+
# import_destination: { # required
|
1005
|
+
# suppression_list_destination: { # required
|
1006
|
+
# suppression_list_import_action: "DELETE", # required, accepts DELETE, PUT
|
1007
|
+
# },
|
1008
|
+
# },
|
1009
|
+
# import_data_source: { # required
|
1010
|
+
# s3_url: "S3Url", # required
|
1011
|
+
# data_format: "CSV", # required, accepts CSV, JSON
|
1012
|
+
# },
|
1013
|
+
# }
|
1014
|
+
#
|
1015
|
+
# @!attribute [rw] import_destination
|
1016
|
+
# The destination for the import job.
|
1017
|
+
# @return [Types::ImportDestination]
|
1018
|
+
#
|
1019
|
+
# @!attribute [rw] import_data_source
|
1020
|
+
# The data source for the import job.
|
1021
|
+
# @return [Types::ImportDataSource]
|
1022
|
+
#
|
1023
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/CreateImportJobRequest AWS API Documentation
|
1024
|
+
#
|
1025
|
+
class CreateImportJobRequest < Struct.new(
|
1026
|
+
:import_destination,
|
1027
|
+
:import_data_source)
|
1028
|
+
SENSITIVE = []
|
1029
|
+
include Aws::Structure
|
1030
|
+
end
|
1031
|
+
|
1032
|
+
# An HTTP 200 response if the request succeeds, or an error message if
|
1033
|
+
# the request fails.
|
1034
|
+
#
|
1035
|
+
# @!attribute [rw] job_id
|
1036
|
+
# A string that represents the import job ID.
|
1037
|
+
# @return [String]
|
1038
|
+
#
|
1039
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/CreateImportJobResponse AWS API Documentation
|
1040
|
+
#
|
1041
|
+
class CreateImportJobResponse < Struct.new(
|
1042
|
+
:job_id)
|
1043
|
+
SENSITIVE = []
|
1044
|
+
include Aws::Structure
|
1045
|
+
end
|
1046
|
+
|
1047
|
+
# Contains information about a custom verification email template.
|
1048
|
+
#
|
1049
|
+
# @!attribute [rw] template_name
|
1050
|
+
# The name of the custom verification email template.
|
1051
|
+
# @return [String]
|
1052
|
+
#
|
1053
|
+
# @!attribute [rw] from_email_address
|
1054
|
+
# The email address that the custom verification email is sent from.
|
1055
|
+
# @return [String]
|
1056
|
+
#
|
1057
|
+
# @!attribute [rw] template_subject
|
1058
|
+
# The subject line of the custom verification email.
|
1059
|
+
# @return [String]
|
1060
|
+
#
|
1061
|
+
# @!attribute [rw] success_redirection_url
|
1062
|
+
# The URL that the recipient of the verification email is sent to if
|
1063
|
+
# his or her address is successfully verified.
|
1064
|
+
# @return [String]
|
1065
|
+
#
|
1066
|
+
# @!attribute [rw] failure_redirection_url
|
1067
|
+
# The URL that the recipient of the verification email is sent to if
|
1068
|
+
# his or her address is not successfully verified.
|
1069
|
+
# @return [String]
|
1070
|
+
#
|
1071
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/CustomVerificationEmailTemplateMetadata AWS API Documentation
|
1072
|
+
#
|
1073
|
+
class CustomVerificationEmailTemplateMetadata < Struct.new(
|
1074
|
+
:template_name,
|
1075
|
+
:from_email_address,
|
1076
|
+
:template_subject,
|
1077
|
+
:success_redirection_url,
|
1078
|
+
:failure_redirection_url)
|
1079
|
+
SENSITIVE = []
|
1080
|
+
include Aws::Structure
|
1081
|
+
end
|
1082
|
+
|
601
1083
|
# An object that contains information about the volume of email sent on
|
602
1084
|
# each day of the analysis period.
|
603
1085
|
#
|
@@ -737,36 +1219,110 @@ module Aws::SESV2
|
|
737
1219
|
#
|
738
1220
|
class DeleteConfigurationSetResponse < Aws::EmptyStructure; end
|
739
1221
|
|
740
|
-
#
|
1222
|
+
# Represents a request to delete an existing custom verification email
|
1223
|
+
# template.
|
741
1224
|
#
|
742
|
-
# @note When making an API call, you may pass
|
1225
|
+
# @note When making an API call, you may pass DeleteCustomVerificationEmailTemplateRequest
|
743
1226
|
# data as a hash:
|
744
1227
|
#
|
745
1228
|
# {
|
746
|
-
#
|
1229
|
+
# template_name: "EmailTemplateName", # required
|
747
1230
|
# }
|
748
1231
|
#
|
749
|
-
# @!attribute [rw]
|
750
|
-
# The name of the
|
1232
|
+
# @!attribute [rw] template_name
|
1233
|
+
# The name of the custom verification email template that you want to
|
1234
|
+
# delete.
|
751
1235
|
# @return [String]
|
752
1236
|
#
|
753
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/
|
1237
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/DeleteCustomVerificationEmailTemplateRequest AWS API Documentation
|
754
1238
|
#
|
755
|
-
class
|
756
|
-
:
|
1239
|
+
class DeleteCustomVerificationEmailTemplateRequest < Struct.new(
|
1240
|
+
:template_name)
|
757
1241
|
SENSITIVE = []
|
758
1242
|
include Aws::Structure
|
759
1243
|
end
|
760
1244
|
|
761
|
-
#
|
762
|
-
#
|
1245
|
+
# If the action is successful, the service sends back an HTTP 200
|
1246
|
+
# response with an empty HTTP body.
|
763
1247
|
#
|
764
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/
|
1248
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/DeleteCustomVerificationEmailTemplateResponse AWS API Documentation
|
765
1249
|
#
|
766
|
-
class
|
1250
|
+
class DeleteCustomVerificationEmailTemplateResponse < Aws::EmptyStructure; end
|
767
1251
|
|
768
|
-
# A request to delete
|
769
|
-
#
|
1252
|
+
# A request to delete a dedicated IP pool.
|
1253
|
+
#
|
1254
|
+
# @note When making an API call, you may pass DeleteDedicatedIpPoolRequest
|
1255
|
+
# data as a hash:
|
1256
|
+
#
|
1257
|
+
# {
|
1258
|
+
# pool_name: "PoolName", # required
|
1259
|
+
# }
|
1260
|
+
#
|
1261
|
+
# @!attribute [rw] pool_name
|
1262
|
+
# The name of the dedicated IP pool that you want to delete.
|
1263
|
+
# @return [String]
|
1264
|
+
#
|
1265
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/DeleteDedicatedIpPoolRequest AWS API Documentation
|
1266
|
+
#
|
1267
|
+
class DeleteDedicatedIpPoolRequest < Struct.new(
|
1268
|
+
:pool_name)
|
1269
|
+
SENSITIVE = []
|
1270
|
+
include Aws::Structure
|
1271
|
+
end
|
1272
|
+
|
1273
|
+
# An HTTP 200 response if the request succeeds, or an error message if
|
1274
|
+
# the request fails.
|
1275
|
+
#
|
1276
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/DeleteDedicatedIpPoolResponse AWS API Documentation
|
1277
|
+
#
|
1278
|
+
class DeleteDedicatedIpPoolResponse < Aws::EmptyStructure; end
|
1279
|
+
|
1280
|
+
# Represents a request to delete a sending authorization policy for an
|
1281
|
+
# identity. Sending authorization is an Amazon SES feature that enables
|
1282
|
+
# you to authorize other senders to use your identities. For
|
1283
|
+
# information, see the [Amazon SES Developer Guide][1].
|
1284
|
+
#
|
1285
|
+
#
|
1286
|
+
#
|
1287
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization-identity-owner-tasks-management.html
|
1288
|
+
#
|
1289
|
+
# @note When making an API call, you may pass DeleteEmailIdentityPolicyRequest
|
1290
|
+
# data as a hash:
|
1291
|
+
#
|
1292
|
+
# {
|
1293
|
+
# email_identity: "Identity", # required
|
1294
|
+
# policy_name: "PolicyName", # required
|
1295
|
+
# }
|
1296
|
+
#
|
1297
|
+
# @!attribute [rw] email_identity
|
1298
|
+
# The email identity for which you want to delete a policy.
|
1299
|
+
# @return [String]
|
1300
|
+
#
|
1301
|
+
# @!attribute [rw] policy_name
|
1302
|
+
# The name of the policy.
|
1303
|
+
#
|
1304
|
+
# The policy name cannot exceed 64 characters and can only include
|
1305
|
+
# alphanumeric characters, dashes, and underscores.
|
1306
|
+
# @return [String]
|
1307
|
+
#
|
1308
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/DeleteEmailIdentityPolicyRequest AWS API Documentation
|
1309
|
+
#
|
1310
|
+
class DeleteEmailIdentityPolicyRequest < Struct.new(
|
1311
|
+
:email_identity,
|
1312
|
+
:policy_name)
|
1313
|
+
SENSITIVE = []
|
1314
|
+
include Aws::Structure
|
1315
|
+
end
|
1316
|
+
|
1317
|
+
# An HTTP 200 response if the request succeeds, or an error message if
|
1318
|
+
# the request fails.
|
1319
|
+
#
|
1320
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/DeleteEmailIdentityPolicyResponse AWS API Documentation
|
1321
|
+
#
|
1322
|
+
class DeleteEmailIdentityPolicyResponse < Aws::EmptyStructure; end
|
1323
|
+
|
1324
|
+
# A request to delete an existing email identity. When you delete an
|
1325
|
+
# identity, you lose the ability to send email from that identity. You
|
770
1326
|
# can restore your ability to send email by completing the verification
|
771
1327
|
# process for the identity again.
|
772
1328
|
#
|
@@ -797,6 +1353,39 @@ module Aws::SESV2
|
|
797
1353
|
#
|
798
1354
|
class DeleteEmailIdentityResponse < Aws::EmptyStructure; end
|
799
1355
|
|
1356
|
+
# Represents a request to delete an email template. For more
|
1357
|
+
# information, see the [Amazon SES Developer Guide][1].
|
1358
|
+
#
|
1359
|
+
#
|
1360
|
+
#
|
1361
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-personalized-email-api.html
|
1362
|
+
#
|
1363
|
+
# @note When making an API call, you may pass DeleteEmailTemplateRequest
|
1364
|
+
# data as a hash:
|
1365
|
+
#
|
1366
|
+
# {
|
1367
|
+
# template_name: "EmailTemplateName", # required
|
1368
|
+
# }
|
1369
|
+
#
|
1370
|
+
# @!attribute [rw] template_name
|
1371
|
+
# The name of the template to be deleted.
|
1372
|
+
# @return [String]
|
1373
|
+
#
|
1374
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/DeleteEmailTemplateRequest AWS API Documentation
|
1375
|
+
#
|
1376
|
+
class DeleteEmailTemplateRequest < Struct.new(
|
1377
|
+
:template_name)
|
1378
|
+
SENSITIVE = []
|
1379
|
+
include Aws::Structure
|
1380
|
+
end
|
1381
|
+
|
1382
|
+
# If the action is successful, the service sends back an HTTP 200
|
1383
|
+
# response with an empty HTTP body.
|
1384
|
+
#
|
1385
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/DeleteEmailTemplateResponse AWS API Documentation
|
1386
|
+
#
|
1387
|
+
class DeleteEmailTemplateResponse < Aws::EmptyStructure; end
|
1388
|
+
|
800
1389
|
# A request to remove an email address from the suppression list for
|
801
1390
|
# your account.
|
802
1391
|
#
|
@@ -1288,8 +1877,9 @@ module Aws::SESV2
|
|
1288
1877
|
# data: "data", # required
|
1289
1878
|
# },
|
1290
1879
|
# template: {
|
1291
|
-
#
|
1292
|
-
#
|
1880
|
+
# template_name: "EmailTemplateName",
|
1881
|
+
# template_arn: "AmazonResourceName",
|
1882
|
+
# template_data: "EmailTemplateData",
|
1293
1883
|
# },
|
1294
1884
|
# }
|
1295
1885
|
#
|
@@ -1341,6 +1931,60 @@ module Aws::SESV2
|
|
1341
1931
|
include Aws::Structure
|
1342
1932
|
end
|
1343
1933
|
|
1934
|
+
# The content of the email, composed of a subject line, an HTML part,
|
1935
|
+
# and a text-only part.
|
1936
|
+
#
|
1937
|
+
# @note When making an API call, you may pass EmailTemplateContent
|
1938
|
+
# data as a hash:
|
1939
|
+
#
|
1940
|
+
# {
|
1941
|
+
# subject: "EmailTemplateSubject",
|
1942
|
+
# text: "EmailTemplateText",
|
1943
|
+
# html: "EmailTemplateHtml",
|
1944
|
+
# }
|
1945
|
+
#
|
1946
|
+
# @!attribute [rw] subject
|
1947
|
+
# The subject line of the email.
|
1948
|
+
# @return [String]
|
1949
|
+
#
|
1950
|
+
# @!attribute [rw] text
|
1951
|
+
# The email body that will be visible to recipients whose email
|
1952
|
+
# clients do not display HTML.
|
1953
|
+
# @return [String]
|
1954
|
+
#
|
1955
|
+
# @!attribute [rw] html
|
1956
|
+
# The HTML body of the email.
|
1957
|
+
# @return [String]
|
1958
|
+
#
|
1959
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/EmailTemplateContent AWS API Documentation
|
1960
|
+
#
|
1961
|
+
class EmailTemplateContent < Struct.new(
|
1962
|
+
:subject,
|
1963
|
+
:text,
|
1964
|
+
:html)
|
1965
|
+
SENSITIVE = []
|
1966
|
+
include Aws::Structure
|
1967
|
+
end
|
1968
|
+
|
1969
|
+
# Contains information about an email template.
|
1970
|
+
#
|
1971
|
+
# @!attribute [rw] template_name
|
1972
|
+
# The name of the template.
|
1973
|
+
# @return [String]
|
1974
|
+
#
|
1975
|
+
# @!attribute [rw] created_timestamp
|
1976
|
+
# The time and date the template was created.
|
1977
|
+
# @return [Time]
|
1978
|
+
#
|
1979
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/EmailTemplateMetadata AWS API Documentation
|
1980
|
+
#
|
1981
|
+
class EmailTemplateMetadata < Struct.new(
|
1982
|
+
:template_name,
|
1983
|
+
:created_timestamp)
|
1984
|
+
SENSITIVE = []
|
1985
|
+
include Aws::Structure
|
1986
|
+
end
|
1987
|
+
|
1344
1988
|
# In the Amazon SES API v2, *events* include message sends, deliveries,
|
1345
1989
|
# opens, clicks, bounces, complaints and delivery delays. *Event
|
1346
1990
|
# destinations* are places that you can send information about these
|
@@ -1504,6 +2148,26 @@ module Aws::SESV2
|
|
1504
2148
|
include Aws::Structure
|
1505
2149
|
end
|
1506
2150
|
|
2151
|
+
# An object that contains the failure details about an import job.
|
2152
|
+
#
|
2153
|
+
# @!attribute [rw] failed_records_s3_url
|
2154
|
+
# An Amazon S3 presigned URL that contains all the failed records and
|
2155
|
+
# related information.
|
2156
|
+
# @return [String]
|
2157
|
+
#
|
2158
|
+
# @!attribute [rw] error_message
|
2159
|
+
# A message about why the import job failed.
|
2160
|
+
# @return [String]
|
2161
|
+
#
|
2162
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/FailureInfo AWS API Documentation
|
2163
|
+
#
|
2164
|
+
class FailureInfo < Struct.new(
|
2165
|
+
:failed_records_s3_url,
|
2166
|
+
:error_message)
|
2167
|
+
SENSITIVE = []
|
2168
|
+
include Aws::Structure
|
2169
|
+
end
|
2170
|
+
|
1507
2171
|
# A request to obtain information about the email-sending capabilities
|
1508
2172
|
# of your Amazon SES account.
|
1509
2173
|
#
|
@@ -1571,6 +2235,10 @@ module Aws::SESV2
|
|
1571
2235
|
# suppression preferences for your account in the current AWS Region.
|
1572
2236
|
# @return [Types::SuppressionAttributes]
|
1573
2237
|
#
|
2238
|
+
# @!attribute [rw] details
|
2239
|
+
# An object that defines your account details.
|
2240
|
+
# @return [Types::AccountDetails]
|
2241
|
+
#
|
1574
2242
|
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/GetAccountResponse AWS API Documentation
|
1575
2243
|
#
|
1576
2244
|
class GetAccountResponse < Struct.new(
|
@@ -1579,7 +2247,8 @@ module Aws::SESV2
|
|
1579
2247
|
:production_access_enabled,
|
1580
2248
|
:send_quota,
|
1581
2249
|
:sending_enabled,
|
1582
|
-
:suppression_attributes
|
2250
|
+
:suppression_attributes,
|
2251
|
+
:details)
|
1583
2252
|
SENSITIVE = []
|
1584
2253
|
include Aws::Structure
|
1585
2254
|
end
|
@@ -1733,6 +2402,70 @@ module Aws::SESV2
|
|
1733
2402
|
include Aws::Structure
|
1734
2403
|
end
|
1735
2404
|
|
2405
|
+
# Represents a request to retrieve an existing custom verification email
|
2406
|
+
# template.
|
2407
|
+
#
|
2408
|
+
# @note When making an API call, you may pass GetCustomVerificationEmailTemplateRequest
|
2409
|
+
# data as a hash:
|
2410
|
+
#
|
2411
|
+
# {
|
2412
|
+
# template_name: "EmailTemplateName", # required
|
2413
|
+
# }
|
2414
|
+
#
|
2415
|
+
# @!attribute [rw] template_name
|
2416
|
+
# The name of the custom verification email template that you want to
|
2417
|
+
# retrieve.
|
2418
|
+
# @return [String]
|
2419
|
+
#
|
2420
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/GetCustomVerificationEmailTemplateRequest AWS API Documentation
|
2421
|
+
#
|
2422
|
+
class GetCustomVerificationEmailTemplateRequest < Struct.new(
|
2423
|
+
:template_name)
|
2424
|
+
SENSITIVE = []
|
2425
|
+
include Aws::Structure
|
2426
|
+
end
|
2427
|
+
|
2428
|
+
# The following elements are returned by the service.
|
2429
|
+
#
|
2430
|
+
# @!attribute [rw] template_name
|
2431
|
+
# The name of the custom verification email template.
|
2432
|
+
# @return [String]
|
2433
|
+
#
|
2434
|
+
# @!attribute [rw] from_email_address
|
2435
|
+
# The email address that the custom verification email is sent from.
|
2436
|
+
# @return [String]
|
2437
|
+
#
|
2438
|
+
# @!attribute [rw] template_subject
|
2439
|
+
# The subject line of the custom verification email.
|
2440
|
+
# @return [String]
|
2441
|
+
#
|
2442
|
+
# @!attribute [rw] template_content
|
2443
|
+
# The content of the custom verification email.
|
2444
|
+
# @return [String]
|
2445
|
+
#
|
2446
|
+
# @!attribute [rw] success_redirection_url
|
2447
|
+
# The URL that the recipient of the verification email is sent to if
|
2448
|
+
# his or her address is successfully verified.
|
2449
|
+
# @return [String]
|
2450
|
+
#
|
2451
|
+
# @!attribute [rw] failure_redirection_url
|
2452
|
+
# The URL that the recipient of the verification email is sent to if
|
2453
|
+
# his or her address is not successfully verified.
|
2454
|
+
# @return [String]
|
2455
|
+
#
|
2456
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/GetCustomVerificationEmailTemplateResponse AWS API Documentation
|
2457
|
+
#
|
2458
|
+
class GetCustomVerificationEmailTemplateResponse < Struct.new(
|
2459
|
+
:template_name,
|
2460
|
+
:from_email_address,
|
2461
|
+
:template_subject,
|
2462
|
+
:template_content,
|
2463
|
+
:success_redirection_url,
|
2464
|
+
:failure_redirection_url)
|
2465
|
+
SENSITIVE = []
|
2466
|
+
include Aws::Structure
|
2467
|
+
end
|
2468
|
+
|
1736
2469
|
# A request to obtain more information about a dedicated IP address.
|
1737
2470
|
#
|
1738
2471
|
# @note When making an API call, you may pass GetDedicatedIpRequest
|
@@ -2068,6 +2801,41 @@ module Aws::SESV2
|
|
2068
2801
|
include Aws::Structure
|
2069
2802
|
end
|
2070
2803
|
|
2804
|
+
# A request to return the policies of an email identity.
|
2805
|
+
#
|
2806
|
+
# @note When making an API call, you may pass GetEmailIdentityPoliciesRequest
|
2807
|
+
# data as a hash:
|
2808
|
+
#
|
2809
|
+
# {
|
2810
|
+
# email_identity: "Identity", # required
|
2811
|
+
# }
|
2812
|
+
#
|
2813
|
+
# @!attribute [rw] email_identity
|
2814
|
+
# The email identity that you want to retrieve policies for.
|
2815
|
+
# @return [String]
|
2816
|
+
#
|
2817
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/GetEmailIdentityPoliciesRequest AWS API Documentation
|
2818
|
+
#
|
2819
|
+
class GetEmailIdentityPoliciesRequest < Struct.new(
|
2820
|
+
:email_identity)
|
2821
|
+
SENSITIVE = []
|
2822
|
+
include Aws::Structure
|
2823
|
+
end
|
2824
|
+
|
2825
|
+
# Identity policies associated with email identity.
|
2826
|
+
#
|
2827
|
+
# @!attribute [rw] policies
|
2828
|
+
# A map of policy names to policies.
|
2829
|
+
# @return [Hash<String,String>]
|
2830
|
+
#
|
2831
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/GetEmailIdentityPoliciesResponse AWS API Documentation
|
2832
|
+
#
|
2833
|
+
class GetEmailIdentityPoliciesResponse < Struct.new(
|
2834
|
+
:policies)
|
2835
|
+
SENSITIVE = []
|
2836
|
+
include Aws::Structure
|
2837
|
+
end
|
2838
|
+
|
2071
2839
|
# A request to return details about an email identity.
|
2072
2840
|
#
|
2073
2841
|
# @note When making an API call, you may pass GetEmailIdentityRequest
|
@@ -2130,6 +2898,10 @@ module Aws::SESV2
|
|
2130
2898
|
# for the email identity.
|
2131
2899
|
# @return [Types::MailFromAttributes]
|
2132
2900
|
#
|
2901
|
+
# @!attribute [rw] policies
|
2902
|
+
# A map of policy names to policies.
|
2903
|
+
# @return [Hash<String,String>]
|
2904
|
+
#
|
2133
2905
|
# @!attribute [rw] tags
|
2134
2906
|
# An array of objects that define the tags (keys and values) that are
|
2135
2907
|
# associated with the email identity.
|
@@ -2143,11 +2915,133 @@ module Aws::SESV2
|
|
2143
2915
|
:verified_for_sending_status,
|
2144
2916
|
:dkim_attributes,
|
2145
2917
|
:mail_from_attributes,
|
2918
|
+
:policies,
|
2146
2919
|
:tags)
|
2147
2920
|
SENSITIVE = []
|
2148
2921
|
include Aws::Structure
|
2149
2922
|
end
|
2150
2923
|
|
2924
|
+
# Represents a request to display the template object (which includes
|
2925
|
+
# the subject line, HTML part and text part) for the template you
|
2926
|
+
# specify.
|
2927
|
+
#
|
2928
|
+
# @note When making an API call, you may pass GetEmailTemplateRequest
|
2929
|
+
# data as a hash:
|
2930
|
+
#
|
2931
|
+
# {
|
2932
|
+
# template_name: "EmailTemplateName", # required
|
2933
|
+
# }
|
2934
|
+
#
|
2935
|
+
# @!attribute [rw] template_name
|
2936
|
+
# The name of the template you want to retrieve.
|
2937
|
+
# @return [String]
|
2938
|
+
#
|
2939
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/GetEmailTemplateRequest AWS API Documentation
|
2940
|
+
#
|
2941
|
+
class GetEmailTemplateRequest < Struct.new(
|
2942
|
+
:template_name)
|
2943
|
+
SENSITIVE = []
|
2944
|
+
include Aws::Structure
|
2945
|
+
end
|
2946
|
+
|
2947
|
+
# The following element is returned by the service.
|
2948
|
+
#
|
2949
|
+
# @!attribute [rw] template_name
|
2950
|
+
# The name of the template you want to retrieve.
|
2951
|
+
# @return [String]
|
2952
|
+
#
|
2953
|
+
# @!attribute [rw] template_content
|
2954
|
+
# The content of the email template, composed of a subject line, an
|
2955
|
+
# HTML part, and a text-only part.
|
2956
|
+
# @return [Types::EmailTemplateContent]
|
2957
|
+
#
|
2958
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/GetEmailTemplateResponse AWS API Documentation
|
2959
|
+
#
|
2960
|
+
class GetEmailTemplateResponse < Struct.new(
|
2961
|
+
:template_name,
|
2962
|
+
:template_content)
|
2963
|
+
SENSITIVE = []
|
2964
|
+
include Aws::Structure
|
2965
|
+
end
|
2966
|
+
|
2967
|
+
# Represents a request for information about an import job using the
|
2968
|
+
# import job ID.
|
2969
|
+
#
|
2970
|
+
# @note When making an API call, you may pass GetImportJobRequest
|
2971
|
+
# data as a hash:
|
2972
|
+
#
|
2973
|
+
# {
|
2974
|
+
# job_id: "JobId", # required
|
2975
|
+
# }
|
2976
|
+
#
|
2977
|
+
# @!attribute [rw] job_id
|
2978
|
+
# The ID of the import job.
|
2979
|
+
# @return [String]
|
2980
|
+
#
|
2981
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/GetImportJobRequest AWS API Documentation
|
2982
|
+
#
|
2983
|
+
class GetImportJobRequest < Struct.new(
|
2984
|
+
:job_id)
|
2985
|
+
SENSITIVE = []
|
2986
|
+
include Aws::Structure
|
2987
|
+
end
|
2988
|
+
|
2989
|
+
# An HTTP 200 response if the request succeeds, or an error message if
|
2990
|
+
# the request fails.
|
2991
|
+
#
|
2992
|
+
# @!attribute [rw] job_id
|
2993
|
+
# A string that represents the import job ID.
|
2994
|
+
# @return [String]
|
2995
|
+
#
|
2996
|
+
# @!attribute [rw] import_destination
|
2997
|
+
# The destination of the import job.
|
2998
|
+
# @return [Types::ImportDestination]
|
2999
|
+
#
|
3000
|
+
# @!attribute [rw] import_data_source
|
3001
|
+
# The data source of the import job.
|
3002
|
+
# @return [Types::ImportDataSource]
|
3003
|
+
#
|
3004
|
+
# @!attribute [rw] failure_info
|
3005
|
+
# The failure details about an import job.
|
3006
|
+
# @return [Types::FailureInfo]
|
3007
|
+
#
|
3008
|
+
# @!attribute [rw] job_status
|
3009
|
+
# The status of the import job.
|
3010
|
+
# @return [String]
|
3011
|
+
#
|
3012
|
+
# @!attribute [rw] created_timestamp
|
3013
|
+
# The time stamp of when the import job was created.
|
3014
|
+
# @return [Time]
|
3015
|
+
#
|
3016
|
+
# @!attribute [rw] completed_timestamp
|
3017
|
+
# The time stamp of when the import job was completed.
|
3018
|
+
# @return [Time]
|
3019
|
+
#
|
3020
|
+
# @!attribute [rw] processed_records_count
|
3021
|
+
# The current number of records processed.
|
3022
|
+
# @return [Integer]
|
3023
|
+
#
|
3024
|
+
# @!attribute [rw] failed_records_count
|
3025
|
+
# The number of records that failed processing because of invalid
|
3026
|
+
# input or other reasons.
|
3027
|
+
# @return [Integer]
|
3028
|
+
#
|
3029
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/GetImportJobResponse AWS API Documentation
|
3030
|
+
#
|
3031
|
+
class GetImportJobResponse < Struct.new(
|
3032
|
+
:job_id,
|
3033
|
+
:import_destination,
|
3034
|
+
:import_data_source,
|
3035
|
+
:failure_info,
|
3036
|
+
:job_status,
|
3037
|
+
:created_timestamp,
|
3038
|
+
:completed_timestamp,
|
3039
|
+
:processed_records_count,
|
3040
|
+
:failed_records_count)
|
3041
|
+
SENSITIVE = []
|
3042
|
+
include Aws::Structure
|
3043
|
+
end
|
3044
|
+
|
2151
3045
|
# A request to retrieve information about an email address that's on
|
2152
3046
|
# the suppression list for your account.
|
2153
3047
|
#
|
@@ -2221,34 +3115,117 @@ module Aws::SESV2
|
|
2221
3115
|
include Aws::Structure
|
2222
3116
|
end
|
2223
3117
|
|
2224
|
-
# An object that contains
|
2225
|
-
#
|
2226
|
-
# account. This data is available only if you enabled the Deliverability
|
2227
|
-
# dashboard for the domain.
|
3118
|
+
# An object that contains details about the data source of the import
|
3119
|
+
# job.
|
2228
3120
|
#
|
2229
|
-
# @note When making an API call, you may pass
|
3121
|
+
# @note When making an API call, you may pass ImportDataSource
|
2230
3122
|
# data as a hash:
|
2231
3123
|
#
|
2232
3124
|
# {
|
2233
|
-
#
|
2234
|
-
#
|
3125
|
+
# s3_url: "S3Url", # required
|
3126
|
+
# data_format: "CSV", # required, accepts CSV, JSON
|
2235
3127
|
# }
|
2236
3128
|
#
|
2237
|
-
# @!attribute [rw]
|
2238
|
-
#
|
2239
|
-
#
|
2240
|
-
# @return [
|
3129
|
+
# @!attribute [rw] s3_url
|
3130
|
+
# An Amazon S3 URL in the format
|
3131
|
+
# s3://*<bucket\_name>*/*<object>*.
|
3132
|
+
# @return [String]
|
2241
3133
|
#
|
2242
|
-
# @!attribute [rw]
|
2243
|
-
#
|
2244
|
-
#
|
2245
|
-
# @return [Array<String>]
|
3134
|
+
# @!attribute [rw] data_format
|
3135
|
+
# The data format of the import job's data source.
|
3136
|
+
# @return [String]
|
2246
3137
|
#
|
2247
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/
|
3138
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/ImportDataSource AWS API Documentation
|
2248
3139
|
#
|
2249
|
-
class
|
2250
|
-
:
|
2251
|
-
:
|
3140
|
+
class ImportDataSource < Struct.new(
|
3141
|
+
:s3_url,
|
3142
|
+
:data_format)
|
3143
|
+
SENSITIVE = []
|
3144
|
+
include Aws::Structure
|
3145
|
+
end
|
3146
|
+
|
3147
|
+
# An object that contains details about the resource destination the
|
3148
|
+
# import job is going to target.
|
3149
|
+
#
|
3150
|
+
# @note When making an API call, you may pass ImportDestination
|
3151
|
+
# data as a hash:
|
3152
|
+
#
|
3153
|
+
# {
|
3154
|
+
# suppression_list_destination: { # required
|
3155
|
+
# suppression_list_import_action: "DELETE", # required, accepts DELETE, PUT
|
3156
|
+
# },
|
3157
|
+
# }
|
3158
|
+
#
|
3159
|
+
# @!attribute [rw] suppression_list_destination
|
3160
|
+
# An object that contains the action of the import job towards
|
3161
|
+
# suppression list.
|
3162
|
+
# @return [Types::SuppressionListDestination]
|
3163
|
+
#
|
3164
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/ImportDestination AWS API Documentation
|
3165
|
+
#
|
3166
|
+
class ImportDestination < Struct.new(
|
3167
|
+
:suppression_list_destination)
|
3168
|
+
SENSITIVE = []
|
3169
|
+
include Aws::Structure
|
3170
|
+
end
|
3171
|
+
|
3172
|
+
# A summary of the import job.
|
3173
|
+
#
|
3174
|
+
# @!attribute [rw] job_id
|
3175
|
+
# A string that represents the import job ID.
|
3176
|
+
# @return [String]
|
3177
|
+
#
|
3178
|
+
# @!attribute [rw] import_destination
|
3179
|
+
# An object that contains details about the resource destination the
|
3180
|
+
# import job is going to target.
|
3181
|
+
# @return [Types::ImportDestination]
|
3182
|
+
#
|
3183
|
+
# @!attribute [rw] job_status
|
3184
|
+
# The status of the import job.
|
3185
|
+
# @return [String]
|
3186
|
+
#
|
3187
|
+
# @!attribute [rw] created_timestamp
|
3188
|
+
# @return [Time]
|
3189
|
+
#
|
3190
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/ImportJobSummary AWS API Documentation
|
3191
|
+
#
|
3192
|
+
class ImportJobSummary < Struct.new(
|
3193
|
+
:job_id,
|
3194
|
+
:import_destination,
|
3195
|
+
:job_status,
|
3196
|
+
:created_timestamp)
|
3197
|
+
SENSITIVE = []
|
3198
|
+
include Aws::Structure
|
3199
|
+
end
|
3200
|
+
|
3201
|
+
# An object that contains information about the inbox placement data
|
3202
|
+
# settings for a verified domain that’s associated with your AWS
|
3203
|
+
# account. This data is available only if you enabled the Deliverability
|
3204
|
+
# dashboard for the domain.
|
3205
|
+
#
|
3206
|
+
# @note When making an API call, you may pass InboxPlacementTrackingOption
|
3207
|
+
# data as a hash:
|
3208
|
+
#
|
3209
|
+
# {
|
3210
|
+
# global: false,
|
3211
|
+
# tracked_isps: ["IspName"],
|
3212
|
+
# }
|
3213
|
+
#
|
3214
|
+
# @!attribute [rw] global
|
3215
|
+
# Specifies whether inbox placement data is being tracked for the
|
3216
|
+
# domain.
|
3217
|
+
# @return [Boolean]
|
3218
|
+
#
|
3219
|
+
# @!attribute [rw] tracked_isps
|
3220
|
+
# An array of strings, one for each major email provider that the
|
3221
|
+
# inbox placement data applies to.
|
3222
|
+
# @return [Array<String>]
|
3223
|
+
#
|
3224
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/InboxPlacementTrackingOption AWS API Documentation
|
3225
|
+
#
|
3226
|
+
class InboxPlacementTrackingOption < Struct.new(
|
3227
|
+
:global,
|
3228
|
+
:tracked_isps)
|
2252
3229
|
SENSITIVE = []
|
2253
3230
|
include Aws::Structure
|
2254
3231
|
end
|
@@ -2375,6 +3352,66 @@ module Aws::SESV2
|
|
2375
3352
|
include Aws::Structure
|
2376
3353
|
end
|
2377
3354
|
|
3355
|
+
# Represents a request to list the existing custom verification email
|
3356
|
+
# templates for your account.
|
3357
|
+
#
|
3358
|
+
# @note When making an API call, you may pass ListCustomVerificationEmailTemplatesRequest
|
3359
|
+
# data as a hash:
|
3360
|
+
#
|
3361
|
+
# {
|
3362
|
+
# next_token: "NextToken",
|
3363
|
+
# page_size: 1,
|
3364
|
+
# }
|
3365
|
+
#
|
3366
|
+
# @!attribute [rw] next_token
|
3367
|
+
# A token returned from a previous call to
|
3368
|
+
# `ListCustomVerificationEmailTemplates` to indicate the position in
|
3369
|
+
# the list of custom verification email templates.
|
3370
|
+
# @return [String]
|
3371
|
+
#
|
3372
|
+
# @!attribute [rw] page_size
|
3373
|
+
# The number of results to show in a single call to
|
3374
|
+
# `ListCustomVerificationEmailTemplates`. If the number of results is
|
3375
|
+
# larger than the number you specified in this parameter, then the
|
3376
|
+
# response includes a `NextToken` element, which you can use to obtain
|
3377
|
+
# additional results.
|
3378
|
+
#
|
3379
|
+
# The value you specify has to be at least 1, and can be no more than
|
3380
|
+
# 50.
|
3381
|
+
# @return [Integer]
|
3382
|
+
#
|
3383
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/ListCustomVerificationEmailTemplatesRequest AWS API Documentation
|
3384
|
+
#
|
3385
|
+
class ListCustomVerificationEmailTemplatesRequest < Struct.new(
|
3386
|
+
:next_token,
|
3387
|
+
:page_size)
|
3388
|
+
SENSITIVE = []
|
3389
|
+
include Aws::Structure
|
3390
|
+
end
|
3391
|
+
|
3392
|
+
# The following elements are returned by the service.
|
3393
|
+
#
|
3394
|
+
# @!attribute [rw] custom_verification_email_templates
|
3395
|
+
# A list of the custom verification email templates that exist in your
|
3396
|
+
# account.
|
3397
|
+
# @return [Array<Types::CustomVerificationEmailTemplateMetadata>]
|
3398
|
+
#
|
3399
|
+
# @!attribute [rw] next_token
|
3400
|
+
# A token indicating that there are additional custom verification
|
3401
|
+
# email templates available to be listed. Pass this token to a
|
3402
|
+
# subsequent call to `ListCustomVerificationEmailTemplates` to
|
3403
|
+
# retrieve the next 50 custom verification email templates.
|
3404
|
+
# @return [String]
|
3405
|
+
#
|
3406
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/ListCustomVerificationEmailTemplatesResponse AWS API Documentation
|
3407
|
+
#
|
3408
|
+
class ListCustomVerificationEmailTemplatesResponse < Struct.new(
|
3409
|
+
:custom_verification_email_templates,
|
3410
|
+
:next_token)
|
3411
|
+
SENSITIVE = []
|
3412
|
+
include Aws::Structure
|
3413
|
+
end
|
3414
|
+
|
2378
3415
|
# A request to obtain a list of dedicated IP pools.
|
2379
3416
|
#
|
2380
3417
|
# @note When making an API call, you may pass ListDedicatedIpPoolsRequest
|
@@ -2636,6 +3673,133 @@ module Aws::SESV2
|
|
2636
3673
|
include Aws::Structure
|
2637
3674
|
end
|
2638
3675
|
|
3676
|
+
# Represents a request to list the email templates present in your
|
3677
|
+
# Amazon SES account in the current AWS Region. For more information,
|
3678
|
+
# see the [Amazon SES Developer Guide][1].
|
3679
|
+
#
|
3680
|
+
#
|
3681
|
+
#
|
3682
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-personalized-email-api.html
|
3683
|
+
#
|
3684
|
+
# @note When making an API call, you may pass ListEmailTemplatesRequest
|
3685
|
+
# data as a hash:
|
3686
|
+
#
|
3687
|
+
# {
|
3688
|
+
# next_token: "NextToken",
|
3689
|
+
# page_size: 1,
|
3690
|
+
# }
|
3691
|
+
#
|
3692
|
+
# @!attribute [rw] next_token
|
3693
|
+
# A token returned from a previous call to `ListEmailTemplates` to
|
3694
|
+
# indicate the position in the list of email templates.
|
3695
|
+
# @return [String]
|
3696
|
+
#
|
3697
|
+
# @!attribute [rw] page_size
|
3698
|
+
# The number of results to show in a single call to
|
3699
|
+
# `ListEmailTemplates`. If the number of results is larger than the
|
3700
|
+
# number you specified in this parameter, then the response includes a
|
3701
|
+
# `NextToken` element, which you can use to obtain additional results.
|
3702
|
+
#
|
3703
|
+
# The value you specify has to be at least 1, and can be no more than
|
3704
|
+
# 10.
|
3705
|
+
# @return [Integer]
|
3706
|
+
#
|
3707
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/ListEmailTemplatesRequest AWS API Documentation
|
3708
|
+
#
|
3709
|
+
class ListEmailTemplatesRequest < Struct.new(
|
3710
|
+
:next_token,
|
3711
|
+
:page_size)
|
3712
|
+
SENSITIVE = []
|
3713
|
+
include Aws::Structure
|
3714
|
+
end
|
3715
|
+
|
3716
|
+
# The following elements are returned by the service.
|
3717
|
+
#
|
3718
|
+
# @!attribute [rw] templates_metadata
|
3719
|
+
# An array the contains the name and creation time stamp for each
|
3720
|
+
# template in your Amazon SES account.
|
3721
|
+
# @return [Array<Types::EmailTemplateMetadata>]
|
3722
|
+
#
|
3723
|
+
# @!attribute [rw] next_token
|
3724
|
+
# A token indicating that there are additional email templates
|
3725
|
+
# available to be listed. Pass this token to a subsequent
|
3726
|
+
# `ListEmailTemplates` call to retrieve the next 10 email templates.
|
3727
|
+
# @return [String]
|
3728
|
+
#
|
3729
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/ListEmailTemplatesResponse AWS API Documentation
|
3730
|
+
#
|
3731
|
+
class ListEmailTemplatesResponse < Struct.new(
|
3732
|
+
:templates_metadata,
|
3733
|
+
:next_token)
|
3734
|
+
SENSITIVE = []
|
3735
|
+
include Aws::Structure
|
3736
|
+
end
|
3737
|
+
|
3738
|
+
# Represents a request to list all of the import jobs for a data
|
3739
|
+
# destination within the specified maximum number of import jobs.
|
3740
|
+
#
|
3741
|
+
# @note When making an API call, you may pass ListImportJobsRequest
|
3742
|
+
# data as a hash:
|
3743
|
+
#
|
3744
|
+
# {
|
3745
|
+
# import_destination_type: "SUPPRESSION_LIST", # accepts SUPPRESSION_LIST
|
3746
|
+
# next_token: "NextToken",
|
3747
|
+
# page_size: 1,
|
3748
|
+
# }
|
3749
|
+
#
|
3750
|
+
# @!attribute [rw] import_destination_type
|
3751
|
+
# The destination of the import job, which can be used to list import
|
3752
|
+
# jobs that have a certain `ImportDestinationType`.
|
3753
|
+
# @return [String]
|
3754
|
+
#
|
3755
|
+
# @!attribute [rw] next_token
|
3756
|
+
# A string token indicating that there might be additional import jobs
|
3757
|
+
# available to be listed. Copy this token to a subsequent call to
|
3758
|
+
# `ListImportJobs` with the same parameters to retrieve the next page
|
3759
|
+
# of import jobs.
|
3760
|
+
# @return [String]
|
3761
|
+
#
|
3762
|
+
# @!attribute [rw] page_size
|
3763
|
+
# Maximum number of import jobs to return at once. Use this parameter
|
3764
|
+
# to paginate results. If additional import jobs exist beyond the
|
3765
|
+
# specified limit, the `NextToken` element is sent in the response.
|
3766
|
+
# Use the `NextToken` value in subsequent requests to retrieve
|
3767
|
+
# additional addresses.
|
3768
|
+
# @return [Integer]
|
3769
|
+
#
|
3770
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/ListImportJobsRequest AWS API Documentation
|
3771
|
+
#
|
3772
|
+
class ListImportJobsRequest < Struct.new(
|
3773
|
+
:import_destination_type,
|
3774
|
+
:next_token,
|
3775
|
+
:page_size)
|
3776
|
+
SENSITIVE = []
|
3777
|
+
include Aws::Structure
|
3778
|
+
end
|
3779
|
+
|
3780
|
+
# An HTTP 200 response if the request succeeds, or an error message if
|
3781
|
+
# the request fails.
|
3782
|
+
#
|
3783
|
+
# @!attribute [rw] import_jobs
|
3784
|
+
# A list of the import job summaries.
|
3785
|
+
# @return [Array<Types::ImportJobSummary>]
|
3786
|
+
#
|
3787
|
+
# @!attribute [rw] next_token
|
3788
|
+
# A string token indicating that there might be additional import jobs
|
3789
|
+
# available to be listed. Copy this token to a subsequent call to
|
3790
|
+
# `ListImportJobs` with the same parameters to retrieve the next page
|
3791
|
+
# of import jobs.
|
3792
|
+
# @return [String]
|
3793
|
+
#
|
3794
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/ListImportJobsResponse AWS API Documentation
|
3795
|
+
#
|
3796
|
+
class ListImportJobsResponse < Struct.new(
|
3797
|
+
:import_jobs,
|
3798
|
+
:next_token)
|
3799
|
+
SENSITIVE = []
|
3800
|
+
include Aws::Structure
|
3801
|
+
end
|
3802
|
+
|
2639
3803
|
# A request to obtain a list of email destinations that are on the
|
2640
3804
|
# suppression list for your account.
|
2641
3805
|
#
|
@@ -3033,6 +4197,79 @@ module Aws::SESV2
|
|
3033
4197
|
#
|
3034
4198
|
class PutAccountDedicatedIpWarmupAttributesResponse < Aws::EmptyStructure; end
|
3035
4199
|
|
4200
|
+
# A request to submit new account details.
|
4201
|
+
#
|
4202
|
+
# @note When making an API call, you may pass PutAccountDetailsRequest
|
4203
|
+
# data as a hash:
|
4204
|
+
#
|
4205
|
+
# {
|
4206
|
+
# mail_type: "MARKETING", # required, accepts MARKETING, TRANSACTIONAL
|
4207
|
+
# website_url: "WebsiteURL", # required
|
4208
|
+
# contact_language: "EN", # accepts EN, JA
|
4209
|
+
# use_case_description: "UseCaseDescription", # required
|
4210
|
+
# additional_contact_email_addresses: ["AdditionalContactEmailAddress"],
|
4211
|
+
# production_access_enabled: false,
|
4212
|
+
# }
|
4213
|
+
#
|
4214
|
+
# @!attribute [rw] mail_type
|
4215
|
+
# The type of email your account will send.
|
4216
|
+
# @return [String]
|
4217
|
+
#
|
4218
|
+
# @!attribute [rw] website_url
|
4219
|
+
# The URL of your website. This information helps us better understand
|
4220
|
+
# the type of content that you plan to send.
|
4221
|
+
# @return [String]
|
4222
|
+
#
|
4223
|
+
# @!attribute [rw] contact_language
|
4224
|
+
# The language you would prefer to be contacted with.
|
4225
|
+
# @return [String]
|
4226
|
+
#
|
4227
|
+
# @!attribute [rw] use_case_description
|
4228
|
+
# A description of the types of email that you plan to send.
|
4229
|
+
# @return [String]
|
4230
|
+
#
|
4231
|
+
# @!attribute [rw] additional_contact_email_addresses
|
4232
|
+
# Additional email addresses that you would like to be notified
|
4233
|
+
# regarding Amazon SES matters.
|
4234
|
+
# @return [Array<String>]
|
4235
|
+
#
|
4236
|
+
# @!attribute [rw] production_access_enabled
|
4237
|
+
# Indicates whether or not your account should have production access
|
4238
|
+
# in the current AWS Region.
|
4239
|
+
#
|
4240
|
+
# If the value is `false`, then your account is in the *sandbox*. When
|
4241
|
+
# your account is in the sandbox, you can only send email to verified
|
4242
|
+
# identities. Additionally, the maximum number of emails you can send
|
4243
|
+
# in a 24-hour period (your sending quota) is 200, and the maximum
|
4244
|
+
# number of emails you can send per second (your maximum sending rate)
|
4245
|
+
# is 1.
|
4246
|
+
#
|
4247
|
+
# If the value is `true`, then your account has production access.
|
4248
|
+
# When your account has production access, you can send email to any
|
4249
|
+
# address. The sending quota and maximum sending rate for your account
|
4250
|
+
# vary based on your specific use case.
|
4251
|
+
# @return [Boolean]
|
4252
|
+
#
|
4253
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/PutAccountDetailsRequest AWS API Documentation
|
4254
|
+
#
|
4255
|
+
class PutAccountDetailsRequest < Struct.new(
|
4256
|
+
:mail_type,
|
4257
|
+
:website_url,
|
4258
|
+
:contact_language,
|
4259
|
+
:use_case_description,
|
4260
|
+
:additional_contact_email_addresses,
|
4261
|
+
:production_access_enabled)
|
4262
|
+
SENSITIVE = [:website_url, :use_case_description, :additional_contact_email_addresses]
|
4263
|
+
include Aws::Structure
|
4264
|
+
end
|
4265
|
+
|
4266
|
+
# An HTTP 200 response if the request succeeds, or an error message if
|
4267
|
+
# the request fails.
|
4268
|
+
#
|
4269
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/PutAccountDetailsResponse AWS API Documentation
|
4270
|
+
#
|
4271
|
+
class PutAccountDetailsResponse < Aws::EmptyStructure; end
|
4272
|
+
|
3036
4273
|
# A request to change the ability of your account to send email.
|
3037
4274
|
#
|
3038
4275
|
# @note When making an API call, you may pass PutAccountSendingAttributesRequest
|
@@ -3791,6 +5028,56 @@ module Aws::SESV2
|
|
3791
5028
|
include Aws::Structure
|
3792
5029
|
end
|
3793
5030
|
|
5031
|
+
# The `ReplaceEmailContent` object to be used for a specific
|
5032
|
+
# `BulkEmailEntry`. The `ReplacementTemplate` can be specified within
|
5033
|
+
# this object.
|
5034
|
+
#
|
5035
|
+
# @note When making an API call, you may pass ReplacementEmailContent
|
5036
|
+
# data as a hash:
|
5037
|
+
#
|
5038
|
+
# {
|
5039
|
+
# replacement_template: {
|
5040
|
+
# replacement_template_data: "EmailTemplateData",
|
5041
|
+
# },
|
5042
|
+
# }
|
5043
|
+
#
|
5044
|
+
# @!attribute [rw] replacement_template
|
5045
|
+
# The `ReplacementTemplate` associated with `ReplacementEmailContent`.
|
5046
|
+
# @return [Types::ReplacementTemplate]
|
5047
|
+
#
|
5048
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/ReplacementEmailContent AWS API Documentation
|
5049
|
+
#
|
5050
|
+
class ReplacementEmailContent < Struct.new(
|
5051
|
+
:replacement_template)
|
5052
|
+
SENSITIVE = []
|
5053
|
+
include Aws::Structure
|
5054
|
+
end
|
5055
|
+
|
5056
|
+
# An object which contains `ReplacementTemplateData` to be used for a
|
5057
|
+
# specific `BulkEmailEntry`.
|
5058
|
+
#
|
5059
|
+
# @note When making an API call, you may pass ReplacementTemplate
|
5060
|
+
# data as a hash:
|
5061
|
+
#
|
5062
|
+
# {
|
5063
|
+
# replacement_template_data: "EmailTemplateData",
|
5064
|
+
# }
|
5065
|
+
#
|
5066
|
+
# @!attribute [rw] replacement_template_data
|
5067
|
+
# A list of replacement values to apply to the template. This
|
5068
|
+
# parameter is a JSON object, typically consisting of key-value pairs
|
5069
|
+
# in which the keys correspond to replacement tags in the email
|
5070
|
+
# template.
|
5071
|
+
# @return [String]
|
5072
|
+
#
|
5073
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/ReplacementTemplate AWS API Documentation
|
5074
|
+
#
|
5075
|
+
class ReplacementTemplate < Struct.new(
|
5076
|
+
:replacement_template_data)
|
5077
|
+
SENSITIVE = []
|
5078
|
+
include Aws::Structure
|
5079
|
+
end
|
5080
|
+
|
3794
5081
|
# Enable or disable collection of reputation metrics for emails that you
|
3795
5082
|
# send using this configuration set in the current AWS Region.
|
3796
5083
|
#
|
@@ -3824,26 +5111,277 @@ module Aws::SESV2
|
|
3824
5111
|
include Aws::Structure
|
3825
5112
|
end
|
3826
5113
|
|
3827
|
-
#
|
5114
|
+
# An object that contains information about your account details review.
|
3828
5115
|
#
|
3829
|
-
#
|
3830
|
-
#
|
5116
|
+
# @!attribute [rw] status
|
5117
|
+
# The status of the latest review of your account. The status can be
|
5118
|
+
# one of the following:
|
3831
5119
|
#
|
3832
|
-
#
|
3833
|
-
#
|
3834
|
-
#
|
3835
|
-
#
|
3836
|
-
#
|
3837
|
-
#
|
3838
|
-
#
|
3839
|
-
#
|
3840
|
-
#
|
3841
|
-
#
|
3842
|
-
#
|
3843
|
-
#
|
3844
|
-
#
|
3845
|
-
#
|
3846
|
-
#
|
5120
|
+
# * `PENDING` – We have received your appeal and are in the process of
|
5121
|
+
# reviewing it.
|
5122
|
+
#
|
5123
|
+
# * `GRANTED` – Your appeal has been reviewed and your production
|
5124
|
+
# access has been granted.
|
5125
|
+
#
|
5126
|
+
# * `DENIED` – Your appeal has been reviewed and your production
|
5127
|
+
# access has been denied.
|
5128
|
+
#
|
5129
|
+
# * `FAILED` – An internal error occurred and we didn't receive your
|
5130
|
+
# appeal. You can submit your appeal again.
|
5131
|
+
# @return [String]
|
5132
|
+
#
|
5133
|
+
# @!attribute [rw] case_id
|
5134
|
+
# The associated support center case ID (if any).
|
5135
|
+
# @return [String]
|
5136
|
+
#
|
5137
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/ReviewDetails AWS API Documentation
|
5138
|
+
#
|
5139
|
+
class ReviewDetails < Struct.new(
|
5140
|
+
:status,
|
5141
|
+
:case_id)
|
5142
|
+
SENSITIVE = []
|
5143
|
+
include Aws::Structure
|
5144
|
+
end
|
5145
|
+
|
5146
|
+
# Represents a request to send email messages to multiple destinations
|
5147
|
+
# using Amazon SES. For more information, see the [Amazon SES Developer
|
5148
|
+
# Guide][1].
|
5149
|
+
#
|
5150
|
+
#
|
5151
|
+
#
|
5152
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-personalized-email-api.html
|
5153
|
+
#
|
5154
|
+
# @note When making an API call, you may pass SendBulkEmailRequest
|
5155
|
+
# data as a hash:
|
5156
|
+
#
|
5157
|
+
# {
|
5158
|
+
# from_email_address: "EmailAddress",
|
5159
|
+
# from_email_address_identity_arn: "AmazonResourceName",
|
5160
|
+
# reply_to_addresses: ["EmailAddress"],
|
5161
|
+
# feedback_forwarding_email_address: "EmailAddress",
|
5162
|
+
# feedback_forwarding_email_address_identity_arn: "AmazonResourceName",
|
5163
|
+
# default_email_tags: [
|
5164
|
+
# {
|
5165
|
+
# name: "MessageTagName", # required
|
5166
|
+
# value: "MessageTagValue", # required
|
5167
|
+
# },
|
5168
|
+
# ],
|
5169
|
+
# default_content: { # required
|
5170
|
+
# template: {
|
5171
|
+
# template_name: "EmailTemplateName",
|
5172
|
+
# template_arn: "AmazonResourceName",
|
5173
|
+
# template_data: "EmailTemplateData",
|
5174
|
+
# },
|
5175
|
+
# },
|
5176
|
+
# bulk_email_entries: [ # required
|
5177
|
+
# {
|
5178
|
+
# destination: { # required
|
5179
|
+
# to_addresses: ["EmailAddress"],
|
5180
|
+
# cc_addresses: ["EmailAddress"],
|
5181
|
+
# bcc_addresses: ["EmailAddress"],
|
5182
|
+
# },
|
5183
|
+
# replacement_tags: [
|
5184
|
+
# {
|
5185
|
+
# name: "MessageTagName", # required
|
5186
|
+
# value: "MessageTagValue", # required
|
5187
|
+
# },
|
5188
|
+
# ],
|
5189
|
+
# replacement_email_content: {
|
5190
|
+
# replacement_template: {
|
5191
|
+
# replacement_template_data: "EmailTemplateData",
|
5192
|
+
# },
|
5193
|
+
# },
|
5194
|
+
# },
|
5195
|
+
# ],
|
5196
|
+
# configuration_set_name: "ConfigurationSetName",
|
5197
|
+
# }
|
5198
|
+
#
|
5199
|
+
# @!attribute [rw] from_email_address
|
5200
|
+
# The email address that you want to use as the "From" address for
|
5201
|
+
# the email. The address that you specify has to be verified.
|
5202
|
+
# @return [String]
|
5203
|
+
#
|
5204
|
+
# @!attribute [rw] from_email_address_identity_arn
|
5205
|
+
# This parameter is used only for sending authorization. It is the ARN
|
5206
|
+
# of the identity that is associated with the sending authorization
|
5207
|
+
# policy that permits you to use the email address specified in the
|
5208
|
+
# `FromEmailAddress` parameter.
|
5209
|
+
#
|
5210
|
+
# For example, if the owner of example.com (which has ARN
|
5211
|
+
# arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a
|
5212
|
+
# policy to it that authorizes you to use sender@example.com, then you
|
5213
|
+
# would specify the `FromEmailAddressIdentityArn` to be
|
5214
|
+
# arn:aws:ses:us-east-1:123456789012:identity/example.com, and the
|
5215
|
+
# `FromEmailAddress` to be sender@example.com.
|
5216
|
+
#
|
5217
|
+
# For more information about sending authorization, see the [Amazon
|
5218
|
+
# SES Developer Guide][1].
|
5219
|
+
#
|
5220
|
+
#
|
5221
|
+
#
|
5222
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html
|
5223
|
+
# @return [String]
|
5224
|
+
#
|
5225
|
+
# @!attribute [rw] reply_to_addresses
|
5226
|
+
# The "Reply-to" email addresses for the message. When the recipient
|
5227
|
+
# replies to the message, each Reply-to address receives the reply.
|
5228
|
+
# @return [Array<String>]
|
5229
|
+
#
|
5230
|
+
# @!attribute [rw] feedback_forwarding_email_address
|
5231
|
+
# The address that you want bounce and complaint notifications to be
|
5232
|
+
# sent to.
|
5233
|
+
# @return [String]
|
5234
|
+
#
|
5235
|
+
# @!attribute [rw] feedback_forwarding_email_address_identity_arn
|
5236
|
+
# This parameter is used only for sending authorization. It is the ARN
|
5237
|
+
# of the identity that is associated with the sending authorization
|
5238
|
+
# policy that permits you to use the email address specified in the
|
5239
|
+
# `FeedbackForwardingEmailAddress` parameter.
|
5240
|
+
#
|
5241
|
+
# For example, if the owner of example.com (which has ARN
|
5242
|
+
# arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a
|
5243
|
+
# policy to it that authorizes you to use feedback@example.com, then
|
5244
|
+
# you would specify the `FeedbackForwardingEmailAddressIdentityArn` to
|
5245
|
+
# be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the
|
5246
|
+
# `FeedbackForwardingEmailAddress` to be feedback@example.com.
|
5247
|
+
#
|
5248
|
+
# For more information about sending authorization, see the [Amazon
|
5249
|
+
# SES Developer Guide][1].
|
5250
|
+
#
|
5251
|
+
#
|
5252
|
+
#
|
5253
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html
|
5254
|
+
# @return [String]
|
5255
|
+
#
|
5256
|
+
# @!attribute [rw] default_email_tags
|
5257
|
+
# A list of tags, in the form of name/value pairs, to apply to an
|
5258
|
+
# email that you send using the `SendEmail` operation. Tags correspond
|
5259
|
+
# to characteristics of the email that you define, so that you can
|
5260
|
+
# publish email sending events.
|
5261
|
+
# @return [Array<Types::MessageTag>]
|
5262
|
+
#
|
5263
|
+
# @!attribute [rw] default_content
|
5264
|
+
# An object that contains the body of the message. You can specify a
|
5265
|
+
# template message.
|
5266
|
+
# @return [Types::BulkEmailContent]
|
5267
|
+
#
|
5268
|
+
# @!attribute [rw] bulk_email_entries
|
5269
|
+
# The list of bulk email entry objects.
|
5270
|
+
# @return [Array<Types::BulkEmailEntry>]
|
5271
|
+
#
|
5272
|
+
# @!attribute [rw] configuration_set_name
|
5273
|
+
# The name of the configuration set that you want to use when sending
|
5274
|
+
# the email.
|
5275
|
+
# @return [String]
|
5276
|
+
#
|
5277
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/SendBulkEmailRequest AWS API Documentation
|
5278
|
+
#
|
5279
|
+
class SendBulkEmailRequest < Struct.new(
|
5280
|
+
:from_email_address,
|
5281
|
+
:from_email_address_identity_arn,
|
5282
|
+
:reply_to_addresses,
|
5283
|
+
:feedback_forwarding_email_address,
|
5284
|
+
:feedback_forwarding_email_address_identity_arn,
|
5285
|
+
:default_email_tags,
|
5286
|
+
:default_content,
|
5287
|
+
:bulk_email_entries,
|
5288
|
+
:configuration_set_name)
|
5289
|
+
SENSITIVE = []
|
5290
|
+
include Aws::Structure
|
5291
|
+
end
|
5292
|
+
|
5293
|
+
# The following data is returned in JSON format by the service.
|
5294
|
+
#
|
5295
|
+
# @!attribute [rw] bulk_email_entry_results
|
5296
|
+
# A list of `BulkMailEntry` objects.
|
5297
|
+
# @return [Array<Types::BulkEmailEntryResult>]
|
5298
|
+
#
|
5299
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/SendBulkEmailResponse AWS API Documentation
|
5300
|
+
#
|
5301
|
+
class SendBulkEmailResponse < Struct.new(
|
5302
|
+
:bulk_email_entry_results)
|
5303
|
+
SENSITIVE = []
|
5304
|
+
include Aws::Structure
|
5305
|
+
end
|
5306
|
+
|
5307
|
+
# Represents a request to send a custom verification email to a
|
5308
|
+
# specified recipient.
|
5309
|
+
#
|
5310
|
+
# @note When making an API call, you may pass SendCustomVerificationEmailRequest
|
5311
|
+
# data as a hash:
|
5312
|
+
#
|
5313
|
+
# {
|
5314
|
+
# email_address: "EmailAddress", # required
|
5315
|
+
# template_name: "EmailTemplateName", # required
|
5316
|
+
# configuration_set_name: "ConfigurationSetName",
|
5317
|
+
# }
|
5318
|
+
#
|
5319
|
+
# @!attribute [rw] email_address
|
5320
|
+
# The email address to verify.
|
5321
|
+
# @return [String]
|
5322
|
+
#
|
5323
|
+
# @!attribute [rw] template_name
|
5324
|
+
# The name of the custom verification email template to use when
|
5325
|
+
# sending the verification email.
|
5326
|
+
# @return [String]
|
5327
|
+
#
|
5328
|
+
# @!attribute [rw] configuration_set_name
|
5329
|
+
# Name of a configuration set to use when sending the verification
|
5330
|
+
# email.
|
5331
|
+
# @return [String]
|
5332
|
+
#
|
5333
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/SendCustomVerificationEmailRequest AWS API Documentation
|
5334
|
+
#
|
5335
|
+
class SendCustomVerificationEmailRequest < Struct.new(
|
5336
|
+
:email_address,
|
5337
|
+
:template_name,
|
5338
|
+
:configuration_set_name)
|
5339
|
+
SENSITIVE = []
|
5340
|
+
include Aws::Structure
|
5341
|
+
end
|
5342
|
+
|
5343
|
+
# The following element is returned by the service.
|
5344
|
+
#
|
5345
|
+
# @!attribute [rw] message_id
|
5346
|
+
# The unique message identifier returned from the
|
5347
|
+
# `SendCustomVerificationEmail` operation.
|
5348
|
+
# @return [String]
|
5349
|
+
#
|
5350
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/SendCustomVerificationEmailResponse AWS API Documentation
|
5351
|
+
#
|
5352
|
+
class SendCustomVerificationEmailResponse < Struct.new(
|
5353
|
+
:message_id)
|
5354
|
+
SENSITIVE = []
|
5355
|
+
include Aws::Structure
|
5356
|
+
end
|
5357
|
+
|
5358
|
+
# Represents a request to send a single formatted email using Amazon
|
5359
|
+
# SES. For more information, see the [Amazon SES Developer Guide][1].
|
5360
|
+
#
|
5361
|
+
#
|
5362
|
+
#
|
5363
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-email-formatted.html
|
5364
|
+
#
|
5365
|
+
# @note When making an API call, you may pass SendEmailRequest
|
5366
|
+
# data as a hash:
|
5367
|
+
#
|
5368
|
+
# {
|
5369
|
+
# from_email_address: "EmailAddress",
|
5370
|
+
# from_email_address_identity_arn: "AmazonResourceName",
|
5371
|
+
# destination: {
|
5372
|
+
# to_addresses: ["EmailAddress"],
|
5373
|
+
# cc_addresses: ["EmailAddress"],
|
5374
|
+
# bcc_addresses: ["EmailAddress"],
|
5375
|
+
# },
|
5376
|
+
# reply_to_addresses: ["EmailAddress"],
|
5377
|
+
# feedback_forwarding_email_address: "EmailAddress",
|
5378
|
+
# feedback_forwarding_email_address_identity_arn: "AmazonResourceName",
|
5379
|
+
# content: { # required
|
5380
|
+
# simple: {
|
5381
|
+
# subject: { # required
|
5382
|
+
# data: "MessageData", # required
|
5383
|
+
# charset: "Charset",
|
5384
|
+
# },
|
3847
5385
|
# body: { # required
|
3848
5386
|
# text: {
|
3849
5387
|
# data: "MessageData", # required
|
@@ -3859,8 +5397,9 @@ module Aws::SESV2
|
|
3859
5397
|
# data: "data", # required
|
3860
5398
|
# },
|
3861
5399
|
# template: {
|
3862
|
-
#
|
3863
|
-
#
|
5400
|
+
# template_name: "EmailTemplateName",
|
5401
|
+
# template_arn: "AmazonResourceName",
|
5402
|
+
# template_data: "EmailTemplateData",
|
3864
5403
|
# },
|
3865
5404
|
# },
|
3866
5405
|
# email_tags: [
|
@@ -3877,6 +5416,31 @@ module Aws::SESV2
|
|
3877
5416
|
# the email. The address that you specify has to be verified.
|
3878
5417
|
# @return [String]
|
3879
5418
|
#
|
5419
|
+
# @!attribute [rw] from_email_address_identity_arn
|
5420
|
+
# This parameter is used only for sending authorization. It is the ARN
|
5421
|
+
# of the identity that is associated with the sending authorization
|
5422
|
+
# policy that permits you to use the email address specified in the
|
5423
|
+
# `FromEmailAddress` parameter.
|
5424
|
+
#
|
5425
|
+
# For example, if the owner of example.com (which has ARN
|
5426
|
+
# arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a
|
5427
|
+
# policy to it that authorizes you to use sender@example.com, then you
|
5428
|
+
# would specify the `FromEmailAddressIdentityArn` to be
|
5429
|
+
# arn:aws:ses:us-east-1:123456789012:identity/example.com, and the
|
5430
|
+
# `FromEmailAddress` to be sender@example.com.
|
5431
|
+
#
|
5432
|
+
# For more information about sending authorization, see the [Amazon
|
5433
|
+
# SES Developer Guide][1].
|
5434
|
+
#
|
5435
|
+
# For Raw emails, the `FromEmailAddressIdentityArn` value overrides
|
5436
|
+
# the X-SES-SOURCE-ARN and X-SES-FROM-ARN headers specified in raw
|
5437
|
+
# email message content.
|
5438
|
+
#
|
5439
|
+
#
|
5440
|
+
#
|
5441
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html
|
5442
|
+
# @return [String]
|
5443
|
+
#
|
3880
5444
|
# @!attribute [rw] destination
|
3881
5445
|
# An object that contains the recipients of the email message.
|
3882
5446
|
# @return [Types::Destination]
|
@@ -3891,9 +5455,30 @@ module Aws::SESV2
|
|
3891
5455
|
# sent to.
|
3892
5456
|
# @return [String]
|
3893
5457
|
#
|
5458
|
+
# @!attribute [rw] feedback_forwarding_email_address_identity_arn
|
5459
|
+
# This parameter is used only for sending authorization. It is the ARN
|
5460
|
+
# of the identity that is associated with the sending authorization
|
5461
|
+
# policy that permits you to use the email address specified in the
|
5462
|
+
# `FeedbackForwardingEmailAddress` parameter.
|
5463
|
+
#
|
5464
|
+
# For example, if the owner of example.com (which has ARN
|
5465
|
+
# arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a
|
5466
|
+
# policy to it that authorizes you to use feedback@example.com, then
|
5467
|
+
# you would specify the `FeedbackForwardingEmailAddressIdentityArn` to
|
5468
|
+
# be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the
|
5469
|
+
# `FeedbackForwardingEmailAddress` to be feedback@example.com.
|
5470
|
+
#
|
5471
|
+
# For more information about sending authorization, see the [Amazon
|
5472
|
+
# SES Developer Guide][1].
|
5473
|
+
#
|
5474
|
+
#
|
5475
|
+
#
|
5476
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html
|
5477
|
+
# @return [String]
|
5478
|
+
#
|
3894
5479
|
# @!attribute [rw] content
|
3895
5480
|
# An object that contains the body of the message. You can send either
|
3896
|
-
# a Simple message or a
|
5481
|
+
# a Simple message Raw message or a template Message.
|
3897
5482
|
# @return [Types::EmailContent]
|
3898
5483
|
#
|
3899
5484
|
# @!attribute [rw] email_tags
|
@@ -3912,9 +5497,11 @@ module Aws::SESV2
|
|
3912
5497
|
#
|
3913
5498
|
class SendEmailRequest < Struct.new(
|
3914
5499
|
:from_email_address,
|
5500
|
+
:from_email_address_identity_arn,
|
3915
5501
|
:destination,
|
3916
5502
|
:reply_to_addresses,
|
3917
5503
|
:feedback_forwarding_email_address,
|
5504
|
+
:feedback_forwarding_email_address_identity_arn,
|
3918
5505
|
:content,
|
3919
5506
|
:email_tags,
|
3920
5507
|
:configuration_set_name)
|
@@ -4141,6 +5728,33 @@ module Aws::SESV2
|
|
4141
5728
|
include Aws::Structure
|
4142
5729
|
end
|
4143
5730
|
|
5731
|
+
# An object that contains details about the action of suppression list.
|
5732
|
+
#
|
5733
|
+
# @note When making an API call, you may pass SuppressionListDestination
|
5734
|
+
# data as a hash:
|
5735
|
+
#
|
5736
|
+
# {
|
5737
|
+
# suppression_list_import_action: "DELETE", # required, accepts DELETE, PUT
|
5738
|
+
# }
|
5739
|
+
#
|
5740
|
+
# @!attribute [rw] suppression_list_import_action
|
5741
|
+
# The type of action that you want to perform on the address.
|
5742
|
+
# Acceptable values:
|
5743
|
+
#
|
5744
|
+
# * PUT: add the addresses to the suppression list. If the record
|
5745
|
+
# already exists, it will override it with the new value.
|
5746
|
+
#
|
5747
|
+
# * DELETE: remove the addresses from the suppression list.
|
5748
|
+
# @return [String]
|
5749
|
+
#
|
5750
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/SuppressionListDestination AWS API Documentation
|
5751
|
+
#
|
5752
|
+
class SuppressionListDestination < Struct.new(
|
5753
|
+
:suppression_list_import_action)
|
5754
|
+
SENSITIVE = []
|
5755
|
+
include Aws::Structure
|
5756
|
+
end
|
5757
|
+
|
4144
5758
|
# An object that contains information about the suppression list
|
4145
5759
|
# preferences for your account.
|
4146
5760
|
#
|
@@ -4282,10 +5896,17 @@ module Aws::SESV2
|
|
4282
5896
|
# data as a hash:
|
4283
5897
|
#
|
4284
5898
|
# {
|
4285
|
-
#
|
4286
|
-
#
|
5899
|
+
# template_name: "EmailTemplateName",
|
5900
|
+
# template_arn: "AmazonResourceName",
|
5901
|
+
# template_data: "EmailTemplateData",
|
4287
5902
|
# }
|
4288
5903
|
#
|
5904
|
+
# @!attribute [rw] template_name
|
5905
|
+
# The name of the template. You will refer to this name when you send
|
5906
|
+
# email using the `SendTemplatedEmail` or `SendBulkTemplatedEmail`
|
5907
|
+
# operations.
|
5908
|
+
# @return [String]
|
5909
|
+
#
|
4289
5910
|
# @!attribute [rw] template_arn
|
4290
5911
|
# The Amazon Resource Name (ARN) of the template.
|
4291
5912
|
# @return [String]
|
@@ -4300,12 +5921,60 @@ module Aws::SESV2
|
|
4300
5921
|
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/Template AWS API Documentation
|
4301
5922
|
#
|
4302
5923
|
class Template < Struct.new(
|
5924
|
+
:template_name,
|
4303
5925
|
:template_arn,
|
4304
5926
|
:template_data)
|
4305
5927
|
SENSITIVE = []
|
4306
5928
|
include Aws::Structure
|
4307
5929
|
end
|
4308
5930
|
|
5931
|
+
# >Represents a request to create a preview of the MIME content of an
|
5932
|
+
# email when provided with a template and a set of replacement data.
|
5933
|
+
#
|
5934
|
+
# @note When making an API call, you may pass TestRenderEmailTemplateRequest
|
5935
|
+
# data as a hash:
|
5936
|
+
#
|
5937
|
+
# {
|
5938
|
+
# template_name: "EmailTemplateName", # required
|
5939
|
+
# template_data: "EmailTemplateData", # required
|
5940
|
+
# }
|
5941
|
+
#
|
5942
|
+
# @!attribute [rw] template_name
|
5943
|
+
# The name of the template that you want to render.
|
5944
|
+
# @return [String]
|
5945
|
+
#
|
5946
|
+
# @!attribute [rw] template_data
|
5947
|
+
# A list of replacement values to apply to the template. This
|
5948
|
+
# parameter is a JSON object, typically consisting of key-value pairs
|
5949
|
+
# in which the keys correspond to replacement tags in the email
|
5950
|
+
# template.
|
5951
|
+
# @return [String]
|
5952
|
+
#
|
5953
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/TestRenderEmailTemplateRequest AWS API Documentation
|
5954
|
+
#
|
5955
|
+
class TestRenderEmailTemplateRequest < Struct.new(
|
5956
|
+
:template_name,
|
5957
|
+
:template_data)
|
5958
|
+
SENSITIVE = []
|
5959
|
+
include Aws::Structure
|
5960
|
+
end
|
5961
|
+
|
5962
|
+
# The following element is returned by the service.
|
5963
|
+
#
|
5964
|
+
# @!attribute [rw] rendered_template
|
5965
|
+
# The complete MIME message rendered by applying the data in the
|
5966
|
+
# `TemplateData` parameter to the template specified in the
|
5967
|
+
# TemplateName parameter.
|
5968
|
+
# @return [String]
|
5969
|
+
#
|
5970
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/TestRenderEmailTemplateResponse AWS API Documentation
|
5971
|
+
#
|
5972
|
+
class TestRenderEmailTemplateResponse < Struct.new(
|
5973
|
+
:rendered_template)
|
5974
|
+
SENSITIVE = []
|
5975
|
+
include Aws::Structure
|
5976
|
+
end
|
5977
|
+
|
4309
5978
|
# Too many requests have been made to the operation.
|
4310
5979
|
#
|
4311
5980
|
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/TooManyRequestsException AWS API Documentation
|
@@ -4442,6 +6111,178 @@ module Aws::SESV2
|
|
4442
6111
|
#
|
4443
6112
|
class UpdateConfigurationSetEventDestinationResponse < Aws::EmptyStructure; end
|
4444
6113
|
|
6114
|
+
# Represents a request to update an existing custom verification email
|
6115
|
+
# template.
|
6116
|
+
#
|
6117
|
+
# @note When making an API call, you may pass UpdateCustomVerificationEmailTemplateRequest
|
6118
|
+
# data as a hash:
|
6119
|
+
#
|
6120
|
+
# {
|
6121
|
+
# template_name: "EmailTemplateName", # required
|
6122
|
+
# from_email_address: "EmailAddress", # required
|
6123
|
+
# template_subject: "EmailTemplateSubject", # required
|
6124
|
+
# template_content: "TemplateContent", # required
|
6125
|
+
# success_redirection_url: "SuccessRedirectionURL", # required
|
6126
|
+
# failure_redirection_url: "FailureRedirectionURL", # required
|
6127
|
+
# }
|
6128
|
+
#
|
6129
|
+
# @!attribute [rw] template_name
|
6130
|
+
# The name of the custom verification email template that you want to
|
6131
|
+
# update.
|
6132
|
+
# @return [String]
|
6133
|
+
#
|
6134
|
+
# @!attribute [rw] from_email_address
|
6135
|
+
# The email address that the custom verification email is sent from.
|
6136
|
+
# @return [String]
|
6137
|
+
#
|
6138
|
+
# @!attribute [rw] template_subject
|
6139
|
+
# The subject line of the custom verification email.
|
6140
|
+
# @return [String]
|
6141
|
+
#
|
6142
|
+
# @!attribute [rw] template_content
|
6143
|
+
# The content of the custom verification email. The total size of the
|
6144
|
+
# email must be less than 10 MB. The message body may contain HTML,
|
6145
|
+
# with some limitations. For more information, see [Custom
|
6146
|
+
# Verification Email Frequently Asked Questions][1] in the *Amazon SES
|
6147
|
+
# Developer Guide*.
|
6148
|
+
#
|
6149
|
+
#
|
6150
|
+
#
|
6151
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-email-verify-address-custom.html#custom-verification-emails-faq
|
6152
|
+
# @return [String]
|
6153
|
+
#
|
6154
|
+
# @!attribute [rw] success_redirection_url
|
6155
|
+
# The URL that the recipient of the verification email is sent to if
|
6156
|
+
# his or her address is successfully verified.
|
6157
|
+
# @return [String]
|
6158
|
+
#
|
6159
|
+
# @!attribute [rw] failure_redirection_url
|
6160
|
+
# The URL that the recipient of the verification email is sent to if
|
6161
|
+
# his or her address is not successfully verified.
|
6162
|
+
# @return [String]
|
6163
|
+
#
|
6164
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/UpdateCustomVerificationEmailTemplateRequest AWS API Documentation
|
6165
|
+
#
|
6166
|
+
class UpdateCustomVerificationEmailTemplateRequest < Struct.new(
|
6167
|
+
:template_name,
|
6168
|
+
:from_email_address,
|
6169
|
+
:template_subject,
|
6170
|
+
:template_content,
|
6171
|
+
:success_redirection_url,
|
6172
|
+
:failure_redirection_url)
|
6173
|
+
SENSITIVE = []
|
6174
|
+
include Aws::Structure
|
6175
|
+
end
|
6176
|
+
|
6177
|
+
# If the action is successful, the service sends back an HTTP 200
|
6178
|
+
# response with an empty HTTP body.
|
6179
|
+
#
|
6180
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/UpdateCustomVerificationEmailTemplateResponse AWS API Documentation
|
6181
|
+
#
|
6182
|
+
class UpdateCustomVerificationEmailTemplateResponse < Aws::EmptyStructure; end
|
6183
|
+
|
6184
|
+
# Represents a request to update a sending authorization policy for an
|
6185
|
+
# identity. Sending authorization is an Amazon SES feature that enables
|
6186
|
+
# you to authorize other senders to use your identities. For
|
6187
|
+
# information, see the [Amazon SES Developer Guide][1].
|
6188
|
+
#
|
6189
|
+
#
|
6190
|
+
#
|
6191
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization-identity-owner-tasks-management.html
|
6192
|
+
#
|
6193
|
+
# @note When making an API call, you may pass UpdateEmailIdentityPolicyRequest
|
6194
|
+
# data as a hash:
|
6195
|
+
#
|
6196
|
+
# {
|
6197
|
+
# email_identity: "Identity", # required
|
6198
|
+
# policy_name: "PolicyName", # required
|
6199
|
+
# policy: "Policy", # required
|
6200
|
+
# }
|
6201
|
+
#
|
6202
|
+
# @!attribute [rw] email_identity
|
6203
|
+
# The email identity for which you want to update policy.
|
6204
|
+
# @return [String]
|
6205
|
+
#
|
6206
|
+
# @!attribute [rw] policy_name
|
6207
|
+
# The name of the policy.
|
6208
|
+
#
|
6209
|
+
# The policy name cannot exceed 64 characters and can only include
|
6210
|
+
# alphanumeric characters, dashes, and underscores.
|
6211
|
+
# @return [String]
|
6212
|
+
#
|
6213
|
+
# @!attribute [rw] policy
|
6214
|
+
# The text of the policy in JSON format. The policy cannot exceed 4
|
6215
|
+
# KB.
|
6216
|
+
#
|
6217
|
+
# For information about the syntax of sending authorization policies,
|
6218
|
+
# see the [Amazon SES Developer Guide][1].
|
6219
|
+
#
|
6220
|
+
#
|
6221
|
+
#
|
6222
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization-policies.html
|
6223
|
+
# @return [String]
|
6224
|
+
#
|
6225
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/UpdateEmailIdentityPolicyRequest AWS API Documentation
|
6226
|
+
#
|
6227
|
+
class UpdateEmailIdentityPolicyRequest < Struct.new(
|
6228
|
+
:email_identity,
|
6229
|
+
:policy_name,
|
6230
|
+
:policy)
|
6231
|
+
SENSITIVE = []
|
6232
|
+
include Aws::Structure
|
6233
|
+
end
|
6234
|
+
|
6235
|
+
# An HTTP 200 response if the request succeeds, or an error message if
|
6236
|
+
# the request fails.
|
6237
|
+
#
|
6238
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/UpdateEmailIdentityPolicyResponse AWS API Documentation
|
6239
|
+
#
|
6240
|
+
class UpdateEmailIdentityPolicyResponse < Aws::EmptyStructure; end
|
6241
|
+
|
6242
|
+
# Represents a request to update an email template. For more
|
6243
|
+
# information, see the [Amazon SES Developer Guide][1].
|
6244
|
+
#
|
6245
|
+
#
|
6246
|
+
#
|
6247
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-personalized-email-api.html
|
6248
|
+
#
|
6249
|
+
# @note When making an API call, you may pass UpdateEmailTemplateRequest
|
6250
|
+
# data as a hash:
|
6251
|
+
#
|
6252
|
+
# {
|
6253
|
+
# template_name: "EmailTemplateName", # required
|
6254
|
+
# template_content: { # required
|
6255
|
+
# subject: "EmailTemplateSubject",
|
6256
|
+
# text: "EmailTemplateText",
|
6257
|
+
# html: "EmailTemplateHtml",
|
6258
|
+
# },
|
6259
|
+
# }
|
6260
|
+
#
|
6261
|
+
# @!attribute [rw] template_name
|
6262
|
+
# The name of the template you want to update.
|
6263
|
+
# @return [String]
|
6264
|
+
#
|
6265
|
+
# @!attribute [rw] template_content
|
6266
|
+
# The content of the email template, composed of a subject line, an
|
6267
|
+
# HTML part, and a text-only part.
|
6268
|
+
# @return [Types::EmailTemplateContent]
|
6269
|
+
#
|
6270
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/UpdateEmailTemplateRequest AWS API Documentation
|
6271
|
+
#
|
6272
|
+
class UpdateEmailTemplateRequest < Struct.new(
|
6273
|
+
:template_name,
|
6274
|
+
:template_content)
|
6275
|
+
SENSITIVE = []
|
6276
|
+
include Aws::Structure
|
6277
|
+
end
|
6278
|
+
|
6279
|
+
# If the action is successful, the service sends back an HTTP 200
|
6280
|
+
# response with an empty HTTP body.
|
6281
|
+
#
|
6282
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/UpdateEmailTemplateResponse AWS API Documentation
|
6283
|
+
#
|
6284
|
+
class UpdateEmailTemplateResponse < Aws::EmptyStructure; end
|
6285
|
+
|
4445
6286
|
# An object that contains information about the amount of email that was
|
4446
6287
|
# delivered to recipients.
|
4447
6288
|
#
|