aws-sdk-sesv2 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +7 -0
- data/lib/aws-sdk-sesv2.rb +47 -0
- data/lib/aws-sdk-sesv2/client.rb +2178 -0
- data/lib/aws-sdk-sesv2/client_api.rb +1306 -0
- data/lib/aws-sdk-sesv2/customizations.rb +0 -0
- data/lib/aws-sdk-sesv2/errors.rb +14 -0
- data/lib/aws-sdk-sesv2/resource.rb +23 -0
- data/lib/aws-sdk-sesv2/types.rb +3682 -0
- metadata +88 -0
|
File without changes
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
# WARNING ABOUT GENERATED CODE
|
|
2
|
+
#
|
|
3
|
+
# This file is generated. See the contributing guide for more information:
|
|
4
|
+
# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
|
|
5
|
+
#
|
|
6
|
+
# WARNING ABOUT GENERATED CODE
|
|
7
|
+
|
|
8
|
+
module Aws::SESV2
|
|
9
|
+
module Errors
|
|
10
|
+
|
|
11
|
+
extend Aws::Errors::DynamicErrors
|
|
12
|
+
|
|
13
|
+
end
|
|
14
|
+
end
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# WARNING ABOUT GENERATED CODE
|
|
2
|
+
#
|
|
3
|
+
# This file is generated. See the contributing guide for more information:
|
|
4
|
+
# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
|
|
5
|
+
#
|
|
6
|
+
# WARNING ABOUT GENERATED CODE
|
|
7
|
+
|
|
8
|
+
module Aws::SESV2
|
|
9
|
+
class Resource
|
|
10
|
+
|
|
11
|
+
# @param options ({})
|
|
12
|
+
# @option options [Client] :client
|
|
13
|
+
def initialize(options = {})
|
|
14
|
+
@client = options[:client] || Client.new(options)
|
|
15
|
+
end
|
|
16
|
+
|
|
17
|
+
# @return [Client]
|
|
18
|
+
def client
|
|
19
|
+
@client
|
|
20
|
+
end
|
|
21
|
+
|
|
22
|
+
end
|
|
23
|
+
end
|
|
@@ -0,0 +1,3682 @@
|
|
|
1
|
+
# WARNING ABOUT GENERATED CODE
|
|
2
|
+
#
|
|
3
|
+
# This file is generated. See the contributing guide for more information:
|
|
4
|
+
# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
|
|
5
|
+
#
|
|
6
|
+
# WARNING ABOUT GENERATED CODE
|
|
7
|
+
|
|
8
|
+
module Aws::SESV2
|
|
9
|
+
module Types
|
|
10
|
+
|
|
11
|
+
# An object that contains information about a blacklisting event that
|
|
12
|
+
# impacts one of the dedicated IP addresses that is associated with your
|
|
13
|
+
# account.
|
|
14
|
+
#
|
|
15
|
+
# @!attribute [rw] rbl_name
|
|
16
|
+
# The name of the blacklist that the IP address appears on.
|
|
17
|
+
# @return [String]
|
|
18
|
+
#
|
|
19
|
+
# @!attribute [rw] listing_time
|
|
20
|
+
# The time when the blacklisting event occurred, shown in Unix time
|
|
21
|
+
# format.
|
|
22
|
+
# @return [Time]
|
|
23
|
+
#
|
|
24
|
+
# @!attribute [rw] description
|
|
25
|
+
# Additional information about the blacklisting event, as provided by
|
|
26
|
+
# the blacklist maintainer.
|
|
27
|
+
# @return [String]
|
|
28
|
+
#
|
|
29
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/BlacklistEntry AWS API Documentation
|
|
30
|
+
#
|
|
31
|
+
class BlacklistEntry < Struct.new(
|
|
32
|
+
:rbl_name,
|
|
33
|
+
:listing_time,
|
|
34
|
+
:description)
|
|
35
|
+
include Aws::Structure
|
|
36
|
+
end
|
|
37
|
+
|
|
38
|
+
# Represents the body of the email message.
|
|
39
|
+
#
|
|
40
|
+
# @note When making an API call, you may pass Body
|
|
41
|
+
# data as a hash:
|
|
42
|
+
#
|
|
43
|
+
# {
|
|
44
|
+
# text: {
|
|
45
|
+
# data: "MessageData", # required
|
|
46
|
+
# charset: "Charset",
|
|
47
|
+
# },
|
|
48
|
+
# html: {
|
|
49
|
+
# data: "MessageData", # required
|
|
50
|
+
# charset: "Charset",
|
|
51
|
+
# },
|
|
52
|
+
# }
|
|
53
|
+
#
|
|
54
|
+
# @!attribute [rw] text
|
|
55
|
+
# An object that represents the version of the message that is
|
|
56
|
+
# displayed in email clients that don't support HTML, or clients
|
|
57
|
+
# where the recipient has disabled HTML rendering.
|
|
58
|
+
# @return [Types::Content]
|
|
59
|
+
#
|
|
60
|
+
# @!attribute [rw] html
|
|
61
|
+
# An object that represents the version of the message that is
|
|
62
|
+
# displayed in email clients that support HTML. HTML messages can
|
|
63
|
+
# include formatted text, hyperlinks, images, and more.
|
|
64
|
+
# @return [Types::Content]
|
|
65
|
+
#
|
|
66
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/Body AWS API Documentation
|
|
67
|
+
#
|
|
68
|
+
class Body < Struct.new(
|
|
69
|
+
:text,
|
|
70
|
+
:html)
|
|
71
|
+
include Aws::Structure
|
|
72
|
+
end
|
|
73
|
+
|
|
74
|
+
# An object that defines an Amazon CloudWatch destination for email
|
|
75
|
+
# events. You can use Amazon CloudWatch to monitor and gain insights on
|
|
76
|
+
# your email sending metrics.
|
|
77
|
+
#
|
|
78
|
+
# @note When making an API call, you may pass CloudWatchDestination
|
|
79
|
+
# data as a hash:
|
|
80
|
+
#
|
|
81
|
+
# {
|
|
82
|
+
# dimension_configurations: [ # required
|
|
83
|
+
# {
|
|
84
|
+
# dimension_name: "DimensionName", # required
|
|
85
|
+
# dimension_value_source: "MESSAGE_TAG", # required, accepts MESSAGE_TAG, EMAIL_HEADER, LINK_TAG
|
|
86
|
+
# default_dimension_value: "DefaultDimensionValue", # required
|
|
87
|
+
# },
|
|
88
|
+
# ],
|
|
89
|
+
# }
|
|
90
|
+
#
|
|
91
|
+
# @!attribute [rw] dimension_configurations
|
|
92
|
+
# An array of objects that define the dimensions to use when you send
|
|
93
|
+
# email events to Amazon CloudWatch.
|
|
94
|
+
# @return [Array<Types::CloudWatchDimensionConfiguration>]
|
|
95
|
+
#
|
|
96
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/CloudWatchDestination AWS API Documentation
|
|
97
|
+
#
|
|
98
|
+
class CloudWatchDestination < Struct.new(
|
|
99
|
+
:dimension_configurations)
|
|
100
|
+
include Aws::Structure
|
|
101
|
+
end
|
|
102
|
+
|
|
103
|
+
# An object that defines the dimension configuration to use when you
|
|
104
|
+
# send email events to Amazon CloudWatch.
|
|
105
|
+
#
|
|
106
|
+
# @note When making an API call, you may pass CloudWatchDimensionConfiguration
|
|
107
|
+
# data as a hash:
|
|
108
|
+
#
|
|
109
|
+
# {
|
|
110
|
+
# dimension_name: "DimensionName", # required
|
|
111
|
+
# dimension_value_source: "MESSAGE_TAG", # required, accepts MESSAGE_TAG, EMAIL_HEADER, LINK_TAG
|
|
112
|
+
# default_dimension_value: "DefaultDimensionValue", # required
|
|
113
|
+
# }
|
|
114
|
+
#
|
|
115
|
+
# @!attribute [rw] dimension_name
|
|
116
|
+
# The name of an Amazon CloudWatch dimension associated with an email
|
|
117
|
+
# sending metric. The name has to meet the following criteria:
|
|
118
|
+
#
|
|
119
|
+
# * It can only contain ASCII letters (a–z, A–Z), numbers (0–9),
|
|
120
|
+
# underscores (\_), or dashes (-).
|
|
121
|
+
#
|
|
122
|
+
# * It can contain no more than 256 characters.
|
|
123
|
+
# @return [String]
|
|
124
|
+
#
|
|
125
|
+
# @!attribute [rw] dimension_value_source
|
|
126
|
+
# The location where the Amazon SES API v2 finds the value of a
|
|
127
|
+
# dimension to publish to Amazon CloudWatch. If you want to use the
|
|
128
|
+
# message tags that you specify using an `X-SES-MESSAGE-TAGS` header
|
|
129
|
+
# or a parameter to the `SendEmail` or `SendRawEmail` API, choose
|
|
130
|
+
# `messageTag`. If you want to use your own email headers, choose
|
|
131
|
+
# `emailHeader`. If you want to use link tags, choose `linkTags`.
|
|
132
|
+
# @return [String]
|
|
133
|
+
#
|
|
134
|
+
# @!attribute [rw] default_dimension_value
|
|
135
|
+
# The default value of the dimension that is published to Amazon
|
|
136
|
+
# CloudWatch if you don't provide the value of the dimension when you
|
|
137
|
+
# send an email. This value has to meet the following criteria:
|
|
138
|
+
#
|
|
139
|
+
# * It can only contain ASCII letters (a–z, A–Z), numbers (0–9),
|
|
140
|
+
# underscores (\_), or dashes (-).
|
|
141
|
+
#
|
|
142
|
+
# * It can contain no more than 256 characters.
|
|
143
|
+
# @return [String]
|
|
144
|
+
#
|
|
145
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/CloudWatchDimensionConfiguration AWS API Documentation
|
|
146
|
+
#
|
|
147
|
+
class CloudWatchDimensionConfiguration < Struct.new(
|
|
148
|
+
:dimension_name,
|
|
149
|
+
:dimension_value_source,
|
|
150
|
+
:default_dimension_value)
|
|
151
|
+
include Aws::Structure
|
|
152
|
+
end
|
|
153
|
+
|
|
154
|
+
# An object that represents the content of the email, and optionally a
|
|
155
|
+
# character set specification.
|
|
156
|
+
#
|
|
157
|
+
# @note When making an API call, you may pass Content
|
|
158
|
+
# data as a hash:
|
|
159
|
+
#
|
|
160
|
+
# {
|
|
161
|
+
# data: "MessageData", # required
|
|
162
|
+
# charset: "Charset",
|
|
163
|
+
# }
|
|
164
|
+
#
|
|
165
|
+
# @!attribute [rw] data
|
|
166
|
+
# The content of the message itself.
|
|
167
|
+
# @return [String]
|
|
168
|
+
#
|
|
169
|
+
# @!attribute [rw] charset
|
|
170
|
+
# The character set for the content. Because of the constraints of the
|
|
171
|
+
# SMTP protocol, the Amazon SES API v2 uses 7-bit ASCII by default. If
|
|
172
|
+
# the text includes characters outside of the ASCII range, you have to
|
|
173
|
+
# specify a character set. For example, you could specify `UTF-8`,
|
|
174
|
+
# `ISO-8859-1`, or `Shift_JIS`.
|
|
175
|
+
# @return [String]
|
|
176
|
+
#
|
|
177
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/Content AWS API Documentation
|
|
178
|
+
#
|
|
179
|
+
class Content < Struct.new(
|
|
180
|
+
:data,
|
|
181
|
+
:charset)
|
|
182
|
+
include Aws::Structure
|
|
183
|
+
end
|
|
184
|
+
|
|
185
|
+
# A request to add an event destination to a configuration set.
|
|
186
|
+
#
|
|
187
|
+
# @note When making an API call, you may pass CreateConfigurationSetEventDestinationRequest
|
|
188
|
+
# data as a hash:
|
|
189
|
+
#
|
|
190
|
+
# {
|
|
191
|
+
# configuration_set_name: "ConfigurationSetName", # required
|
|
192
|
+
# event_destination_name: "EventDestinationName", # required
|
|
193
|
+
# event_destination: { # required
|
|
194
|
+
# enabled: false,
|
|
195
|
+
# matching_event_types: ["SEND"], # accepts SEND, REJECT, BOUNCE, COMPLAINT, DELIVERY, OPEN, CLICK, RENDERING_FAILURE
|
|
196
|
+
# kinesis_firehose_destination: {
|
|
197
|
+
# iam_role_arn: "AmazonResourceName", # required
|
|
198
|
+
# delivery_stream_arn: "AmazonResourceName", # required
|
|
199
|
+
# },
|
|
200
|
+
# cloud_watch_destination: {
|
|
201
|
+
# dimension_configurations: [ # required
|
|
202
|
+
# {
|
|
203
|
+
# dimension_name: "DimensionName", # required
|
|
204
|
+
# dimension_value_source: "MESSAGE_TAG", # required, accepts MESSAGE_TAG, EMAIL_HEADER, LINK_TAG
|
|
205
|
+
# default_dimension_value: "DefaultDimensionValue", # required
|
|
206
|
+
# },
|
|
207
|
+
# ],
|
|
208
|
+
# },
|
|
209
|
+
# sns_destination: {
|
|
210
|
+
# topic_arn: "AmazonResourceName", # required
|
|
211
|
+
# },
|
|
212
|
+
# pinpoint_destination: {
|
|
213
|
+
# application_arn: "AmazonResourceName",
|
|
214
|
+
# },
|
|
215
|
+
# },
|
|
216
|
+
# }
|
|
217
|
+
#
|
|
218
|
+
# @!attribute [rw] configuration_set_name
|
|
219
|
+
# The name of the configuration set that you want to add an event
|
|
220
|
+
# destination to.
|
|
221
|
+
# @return [String]
|
|
222
|
+
#
|
|
223
|
+
# @!attribute [rw] event_destination_name
|
|
224
|
+
# A name that identifies the event destination within the
|
|
225
|
+
# configuration set.
|
|
226
|
+
# @return [String]
|
|
227
|
+
#
|
|
228
|
+
# @!attribute [rw] event_destination
|
|
229
|
+
# An object that defines the event destination.
|
|
230
|
+
# @return [Types::EventDestinationDefinition]
|
|
231
|
+
#
|
|
232
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/CreateConfigurationSetEventDestinationRequest AWS API Documentation
|
|
233
|
+
#
|
|
234
|
+
class CreateConfigurationSetEventDestinationRequest < Struct.new(
|
|
235
|
+
:configuration_set_name,
|
|
236
|
+
:event_destination_name,
|
|
237
|
+
:event_destination)
|
|
238
|
+
include Aws::Structure
|
|
239
|
+
end
|
|
240
|
+
|
|
241
|
+
# An HTTP 200 response if the request succeeds, or an error message if
|
|
242
|
+
# the request fails.
|
|
243
|
+
#
|
|
244
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/CreateConfigurationSetEventDestinationResponse AWS API Documentation
|
|
245
|
+
#
|
|
246
|
+
class CreateConfigurationSetEventDestinationResponse < Aws::EmptyStructure; end
|
|
247
|
+
|
|
248
|
+
# A request to create a configuration set.
|
|
249
|
+
#
|
|
250
|
+
# @note When making an API call, you may pass CreateConfigurationSetRequest
|
|
251
|
+
# data as a hash:
|
|
252
|
+
#
|
|
253
|
+
# {
|
|
254
|
+
# configuration_set_name: "ConfigurationSetName", # required
|
|
255
|
+
# tracking_options: {
|
|
256
|
+
# custom_redirect_domain: "CustomRedirectDomain", # required
|
|
257
|
+
# },
|
|
258
|
+
# delivery_options: {
|
|
259
|
+
# tls_policy: "REQUIRE", # accepts REQUIRE, OPTIONAL
|
|
260
|
+
# sending_pool_name: "PoolName",
|
|
261
|
+
# },
|
|
262
|
+
# reputation_options: {
|
|
263
|
+
# reputation_metrics_enabled: false,
|
|
264
|
+
# last_fresh_start: Time.now,
|
|
265
|
+
# },
|
|
266
|
+
# sending_options: {
|
|
267
|
+
# sending_enabled: false,
|
|
268
|
+
# },
|
|
269
|
+
# tags: [
|
|
270
|
+
# {
|
|
271
|
+
# key: "TagKey", # required
|
|
272
|
+
# value: "TagValue", # required
|
|
273
|
+
# },
|
|
274
|
+
# ],
|
|
275
|
+
# }
|
|
276
|
+
#
|
|
277
|
+
# @!attribute [rw] configuration_set_name
|
|
278
|
+
# The name of the configuration set.
|
|
279
|
+
# @return [String]
|
|
280
|
+
#
|
|
281
|
+
# @!attribute [rw] tracking_options
|
|
282
|
+
# An object that defines the open and click tracking options for
|
|
283
|
+
# emails that you send using the configuration set.
|
|
284
|
+
# @return [Types::TrackingOptions]
|
|
285
|
+
#
|
|
286
|
+
# @!attribute [rw] delivery_options
|
|
287
|
+
# An object that defines the dedicated IP pool that is used to send
|
|
288
|
+
# emails that you send using the configuration set.
|
|
289
|
+
# @return [Types::DeliveryOptions]
|
|
290
|
+
#
|
|
291
|
+
# @!attribute [rw] reputation_options
|
|
292
|
+
# An object that defines whether or not Amazon SES collects reputation
|
|
293
|
+
# metrics for the emails that you send that use the configuration set.
|
|
294
|
+
# @return [Types::ReputationOptions]
|
|
295
|
+
#
|
|
296
|
+
# @!attribute [rw] sending_options
|
|
297
|
+
# An object that defines whether or not Amazon SES can send email that
|
|
298
|
+
# you send using the configuration set.
|
|
299
|
+
# @return [Types::SendingOptions]
|
|
300
|
+
#
|
|
301
|
+
# @!attribute [rw] tags
|
|
302
|
+
# An array of objects that define the tags (keys and values) that you
|
|
303
|
+
# want to associate with the configuration set.
|
|
304
|
+
# @return [Array<Types::Tag>]
|
|
305
|
+
#
|
|
306
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/CreateConfigurationSetRequest AWS API Documentation
|
|
307
|
+
#
|
|
308
|
+
class CreateConfigurationSetRequest < Struct.new(
|
|
309
|
+
:configuration_set_name,
|
|
310
|
+
:tracking_options,
|
|
311
|
+
:delivery_options,
|
|
312
|
+
:reputation_options,
|
|
313
|
+
:sending_options,
|
|
314
|
+
:tags)
|
|
315
|
+
include Aws::Structure
|
|
316
|
+
end
|
|
317
|
+
|
|
318
|
+
# An HTTP 200 response if the request succeeds, or an error message if
|
|
319
|
+
# the request fails.
|
|
320
|
+
#
|
|
321
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/CreateConfigurationSetResponse AWS API Documentation
|
|
322
|
+
#
|
|
323
|
+
class CreateConfigurationSetResponse < Aws::EmptyStructure; end
|
|
324
|
+
|
|
325
|
+
# A request to create a new dedicated IP pool.
|
|
326
|
+
#
|
|
327
|
+
# @note When making an API call, you may pass CreateDedicatedIpPoolRequest
|
|
328
|
+
# data as a hash:
|
|
329
|
+
#
|
|
330
|
+
# {
|
|
331
|
+
# pool_name: "PoolName", # required
|
|
332
|
+
# tags: [
|
|
333
|
+
# {
|
|
334
|
+
# key: "TagKey", # required
|
|
335
|
+
# value: "TagValue", # required
|
|
336
|
+
# },
|
|
337
|
+
# ],
|
|
338
|
+
# }
|
|
339
|
+
#
|
|
340
|
+
# @!attribute [rw] pool_name
|
|
341
|
+
# The name of the dedicated IP pool.
|
|
342
|
+
# @return [String]
|
|
343
|
+
#
|
|
344
|
+
# @!attribute [rw] tags
|
|
345
|
+
# An object that defines the tags (keys and values) that you want to
|
|
346
|
+
# associate with the pool.
|
|
347
|
+
# @return [Array<Types::Tag>]
|
|
348
|
+
#
|
|
349
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/CreateDedicatedIpPoolRequest AWS API Documentation
|
|
350
|
+
#
|
|
351
|
+
class CreateDedicatedIpPoolRequest < Struct.new(
|
|
352
|
+
:pool_name,
|
|
353
|
+
:tags)
|
|
354
|
+
include Aws::Structure
|
|
355
|
+
end
|
|
356
|
+
|
|
357
|
+
# An HTTP 200 response if the request succeeds, or an error message if
|
|
358
|
+
# the request fails.
|
|
359
|
+
#
|
|
360
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/CreateDedicatedIpPoolResponse AWS API Documentation
|
|
361
|
+
#
|
|
362
|
+
class CreateDedicatedIpPoolResponse < Aws::EmptyStructure; end
|
|
363
|
+
|
|
364
|
+
# A request to perform a predictive inbox placement test. Predictive
|
|
365
|
+
# inbox placement tests can help you predict how your messages will be
|
|
366
|
+
# handled by various email providers around the world. When you perform
|
|
367
|
+
# a predictive inbox placement test, you provide a sample message that
|
|
368
|
+
# contains the content that you plan to send to your customers. We send
|
|
369
|
+
# that message to special email addresses spread across several major
|
|
370
|
+
# email providers around the world. The test takes about 24 hours to
|
|
371
|
+
# complete. When the test is complete, you can use the
|
|
372
|
+
# `GetDeliverabilityTestReport` operation to view the results of the
|
|
373
|
+
# test.
|
|
374
|
+
#
|
|
375
|
+
# @note When making an API call, you may pass CreateDeliverabilityTestReportRequest
|
|
376
|
+
# data as a hash:
|
|
377
|
+
#
|
|
378
|
+
# {
|
|
379
|
+
# report_name: "ReportName",
|
|
380
|
+
# from_email_address: "EmailAddress", # required
|
|
381
|
+
# content: { # required
|
|
382
|
+
# simple: {
|
|
383
|
+
# subject: { # required
|
|
384
|
+
# data: "MessageData", # required
|
|
385
|
+
# charset: "Charset",
|
|
386
|
+
# },
|
|
387
|
+
# body: { # required
|
|
388
|
+
# text: {
|
|
389
|
+
# data: "MessageData", # required
|
|
390
|
+
# charset: "Charset",
|
|
391
|
+
# },
|
|
392
|
+
# html: {
|
|
393
|
+
# data: "MessageData", # required
|
|
394
|
+
# charset: "Charset",
|
|
395
|
+
# },
|
|
396
|
+
# },
|
|
397
|
+
# },
|
|
398
|
+
# raw: {
|
|
399
|
+
# data: "data", # required
|
|
400
|
+
# },
|
|
401
|
+
# template: {
|
|
402
|
+
# template_arn: "TemplateArn",
|
|
403
|
+
# template_data: "TemplateData",
|
|
404
|
+
# },
|
|
405
|
+
# },
|
|
406
|
+
# tags: [
|
|
407
|
+
# {
|
|
408
|
+
# key: "TagKey", # required
|
|
409
|
+
# value: "TagValue", # required
|
|
410
|
+
# },
|
|
411
|
+
# ],
|
|
412
|
+
# }
|
|
413
|
+
#
|
|
414
|
+
# @!attribute [rw] report_name
|
|
415
|
+
# A unique name that helps you to identify the predictive inbox
|
|
416
|
+
# placement test when you retrieve the results.
|
|
417
|
+
# @return [String]
|
|
418
|
+
#
|
|
419
|
+
# @!attribute [rw] from_email_address
|
|
420
|
+
# The email address that the predictive inbox placement test email was
|
|
421
|
+
# sent from.
|
|
422
|
+
# @return [String]
|
|
423
|
+
#
|
|
424
|
+
# @!attribute [rw] content
|
|
425
|
+
# The HTML body of the message that you sent when you performed the
|
|
426
|
+
# predictive inbox placement test.
|
|
427
|
+
# @return [Types::EmailContent]
|
|
428
|
+
#
|
|
429
|
+
# @!attribute [rw] tags
|
|
430
|
+
# An array of objects that define the tags (keys and values) that you
|
|
431
|
+
# want to associate with the predictive inbox placement test.
|
|
432
|
+
# @return [Array<Types::Tag>]
|
|
433
|
+
#
|
|
434
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/CreateDeliverabilityTestReportRequest AWS API Documentation
|
|
435
|
+
#
|
|
436
|
+
class CreateDeliverabilityTestReportRequest < Struct.new(
|
|
437
|
+
:report_name,
|
|
438
|
+
:from_email_address,
|
|
439
|
+
:content,
|
|
440
|
+
:tags)
|
|
441
|
+
include Aws::Structure
|
|
442
|
+
end
|
|
443
|
+
|
|
444
|
+
# Information about the predictive inbox placement test that you
|
|
445
|
+
# created.
|
|
446
|
+
#
|
|
447
|
+
# @!attribute [rw] report_id
|
|
448
|
+
# A unique string that identifies the predictive inbox placement test.
|
|
449
|
+
# @return [String]
|
|
450
|
+
#
|
|
451
|
+
# @!attribute [rw] deliverability_test_status
|
|
452
|
+
# The status of the predictive inbox placement test. If the status is
|
|
453
|
+
# `IN_PROGRESS`, then the predictive inbox placement test is currently
|
|
454
|
+
# running. Predictive inbox placement tests are usually complete
|
|
455
|
+
# within 24 hours of creating the test. If the status is `COMPLETE`,
|
|
456
|
+
# then the test is finished, and you can use the
|
|
457
|
+
# `GetDeliverabilityTestReport` to view the results of the test.
|
|
458
|
+
# @return [String]
|
|
459
|
+
#
|
|
460
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/CreateDeliverabilityTestReportResponse AWS API Documentation
|
|
461
|
+
#
|
|
462
|
+
class CreateDeliverabilityTestReportResponse < Struct.new(
|
|
463
|
+
:report_id,
|
|
464
|
+
:deliverability_test_status)
|
|
465
|
+
include Aws::Structure
|
|
466
|
+
end
|
|
467
|
+
|
|
468
|
+
# A request to begin the verification process for an email identity (an
|
|
469
|
+
# email address or domain).
|
|
470
|
+
#
|
|
471
|
+
# @note When making an API call, you may pass CreateEmailIdentityRequest
|
|
472
|
+
# data as a hash:
|
|
473
|
+
#
|
|
474
|
+
# {
|
|
475
|
+
# email_identity: "Identity", # required
|
|
476
|
+
# tags: [
|
|
477
|
+
# {
|
|
478
|
+
# key: "TagKey", # required
|
|
479
|
+
# value: "TagValue", # required
|
|
480
|
+
# },
|
|
481
|
+
# ],
|
|
482
|
+
# }
|
|
483
|
+
#
|
|
484
|
+
# @!attribute [rw] email_identity
|
|
485
|
+
# The email address or domain that you want to verify.
|
|
486
|
+
# @return [String]
|
|
487
|
+
#
|
|
488
|
+
# @!attribute [rw] tags
|
|
489
|
+
# An array of objects that define the tags (keys and values) that you
|
|
490
|
+
# want to associate with the email identity.
|
|
491
|
+
# @return [Array<Types::Tag>]
|
|
492
|
+
#
|
|
493
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/CreateEmailIdentityRequest AWS API Documentation
|
|
494
|
+
#
|
|
495
|
+
class CreateEmailIdentityRequest < Struct.new(
|
|
496
|
+
:email_identity,
|
|
497
|
+
:tags)
|
|
498
|
+
include Aws::Structure
|
|
499
|
+
end
|
|
500
|
+
|
|
501
|
+
# If the email identity is a domain, this object contains tokens that
|
|
502
|
+
# you can use to create a set of CNAME records. To sucessfully verify
|
|
503
|
+
# your domain, you have to add these records to the DNS configuration
|
|
504
|
+
# for your domain.
|
|
505
|
+
#
|
|
506
|
+
# If the email identity is an email address, this object is empty.
|
|
507
|
+
#
|
|
508
|
+
# @!attribute [rw] identity_type
|
|
509
|
+
# The email identity type.
|
|
510
|
+
# @return [String]
|
|
511
|
+
#
|
|
512
|
+
# @!attribute [rw] verified_for_sending_status
|
|
513
|
+
# Specifies whether or not the identity is verified. You can only send
|
|
514
|
+
# email from verified email addresses or domains. For more information
|
|
515
|
+
# about verifying identities, see the [Amazon Pinpoint User Guide][1].
|
|
516
|
+
#
|
|
517
|
+
#
|
|
518
|
+
#
|
|
519
|
+
# [1]: https://docs.aws.amazon.com/pinpoint/latest/userguide/channels-email-manage-verify.html
|
|
520
|
+
# @return [Boolean]
|
|
521
|
+
#
|
|
522
|
+
# @!attribute [rw] dkim_attributes
|
|
523
|
+
# An object that contains information about the DKIM attributes for
|
|
524
|
+
# the identity. This object includes the tokens that you use to create
|
|
525
|
+
# the CNAME records that are required to complete the DKIM
|
|
526
|
+
# verification process.
|
|
527
|
+
# @return [Types::DkimAttributes]
|
|
528
|
+
#
|
|
529
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/CreateEmailIdentityResponse AWS API Documentation
|
|
530
|
+
#
|
|
531
|
+
class CreateEmailIdentityResponse < Struct.new(
|
|
532
|
+
:identity_type,
|
|
533
|
+
:verified_for_sending_status,
|
|
534
|
+
:dkim_attributes)
|
|
535
|
+
include Aws::Structure
|
|
536
|
+
end
|
|
537
|
+
|
|
538
|
+
# An object that contains information about the volume of email sent on
|
|
539
|
+
# each day of the analysis period.
|
|
540
|
+
#
|
|
541
|
+
# @!attribute [rw] start_date
|
|
542
|
+
# The date that the DailyVolume metrics apply to, in Unix time.
|
|
543
|
+
# @return [Time]
|
|
544
|
+
#
|
|
545
|
+
# @!attribute [rw] volume_statistics
|
|
546
|
+
# An object that contains inbox placement metrics for a specific day
|
|
547
|
+
# in the analysis period.
|
|
548
|
+
# @return [Types::VolumeStatistics]
|
|
549
|
+
#
|
|
550
|
+
# @!attribute [rw] domain_isp_placements
|
|
551
|
+
# An object that contains inbox placement metrics for a specified day
|
|
552
|
+
# in the analysis period, broken out by the recipient's email
|
|
553
|
+
# provider.
|
|
554
|
+
# @return [Array<Types::DomainIspPlacement>]
|
|
555
|
+
#
|
|
556
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/DailyVolume AWS API Documentation
|
|
557
|
+
#
|
|
558
|
+
class DailyVolume < Struct.new(
|
|
559
|
+
:start_date,
|
|
560
|
+
:volume_statistics,
|
|
561
|
+
:domain_isp_placements)
|
|
562
|
+
include Aws::Structure
|
|
563
|
+
end
|
|
564
|
+
|
|
565
|
+
# Contains information about a dedicated IP address that is associated
|
|
566
|
+
# with your Amazon SES API v2 account.
|
|
567
|
+
#
|
|
568
|
+
# To learn more about requesting dedicated IP addresses, see [Requesting
|
|
569
|
+
# and Relinquishing Dedicated IP Addresses][1] in the *Amazon SES
|
|
570
|
+
# Developer Guide*.
|
|
571
|
+
#
|
|
572
|
+
#
|
|
573
|
+
#
|
|
574
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/dedicated-ip-case.html
|
|
575
|
+
#
|
|
576
|
+
# @!attribute [rw] ip
|
|
577
|
+
# An IPv4 address.
|
|
578
|
+
# @return [String]
|
|
579
|
+
#
|
|
580
|
+
# @!attribute [rw] warmup_status
|
|
581
|
+
# The warm-up status of a dedicated IP address. The status can have
|
|
582
|
+
# one of the following values:
|
|
583
|
+
#
|
|
584
|
+
# * `IN_PROGRESS` – The IP address isn't ready to use because the
|
|
585
|
+
# dedicated IP warm-up process is ongoing.
|
|
586
|
+
#
|
|
587
|
+
# * `DONE` – The dedicated IP warm-up process is complete, and the IP
|
|
588
|
+
# address is ready to use.
|
|
589
|
+
# @return [String]
|
|
590
|
+
#
|
|
591
|
+
# @!attribute [rw] warmup_percentage
|
|
592
|
+
# Indicates how complete the dedicated IP warm-up process is. When
|
|
593
|
+
# this value equals 1, the address has completed the warm-up process
|
|
594
|
+
# and is ready for use.
|
|
595
|
+
# @return [Integer]
|
|
596
|
+
#
|
|
597
|
+
# @!attribute [rw] pool_name
|
|
598
|
+
# The name of the dedicated IP pool that the IP address is associated
|
|
599
|
+
# with.
|
|
600
|
+
# @return [String]
|
|
601
|
+
#
|
|
602
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/DedicatedIp AWS API Documentation
|
|
603
|
+
#
|
|
604
|
+
class DedicatedIp < Struct.new(
|
|
605
|
+
:ip,
|
|
606
|
+
:warmup_status,
|
|
607
|
+
:warmup_percentage,
|
|
608
|
+
:pool_name)
|
|
609
|
+
include Aws::Structure
|
|
610
|
+
end
|
|
611
|
+
|
|
612
|
+
# A request to delete an event destination from a configuration set.
|
|
613
|
+
#
|
|
614
|
+
# @note When making an API call, you may pass DeleteConfigurationSetEventDestinationRequest
|
|
615
|
+
# data as a hash:
|
|
616
|
+
#
|
|
617
|
+
# {
|
|
618
|
+
# configuration_set_name: "ConfigurationSetName", # required
|
|
619
|
+
# event_destination_name: "EventDestinationName", # required
|
|
620
|
+
# }
|
|
621
|
+
#
|
|
622
|
+
# @!attribute [rw] configuration_set_name
|
|
623
|
+
# The name of the configuration set that contains the event
|
|
624
|
+
# destination that you want to delete.
|
|
625
|
+
# @return [String]
|
|
626
|
+
#
|
|
627
|
+
# @!attribute [rw] event_destination_name
|
|
628
|
+
# The name of the event destination that you want to delete.
|
|
629
|
+
# @return [String]
|
|
630
|
+
#
|
|
631
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/DeleteConfigurationSetEventDestinationRequest AWS API Documentation
|
|
632
|
+
#
|
|
633
|
+
class DeleteConfigurationSetEventDestinationRequest < Struct.new(
|
|
634
|
+
:configuration_set_name,
|
|
635
|
+
:event_destination_name)
|
|
636
|
+
include Aws::Structure
|
|
637
|
+
end
|
|
638
|
+
|
|
639
|
+
# An HTTP 200 response if the request succeeds, or an error message if
|
|
640
|
+
# the request fails.
|
|
641
|
+
#
|
|
642
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/DeleteConfigurationSetEventDestinationResponse AWS API Documentation
|
|
643
|
+
#
|
|
644
|
+
class DeleteConfigurationSetEventDestinationResponse < Aws::EmptyStructure; end
|
|
645
|
+
|
|
646
|
+
# A request to delete a configuration set.
|
|
647
|
+
#
|
|
648
|
+
# @note When making an API call, you may pass DeleteConfigurationSetRequest
|
|
649
|
+
# data as a hash:
|
|
650
|
+
#
|
|
651
|
+
# {
|
|
652
|
+
# configuration_set_name: "ConfigurationSetName", # required
|
|
653
|
+
# }
|
|
654
|
+
#
|
|
655
|
+
# @!attribute [rw] configuration_set_name
|
|
656
|
+
# The name of the configuration set that you want to delete.
|
|
657
|
+
# @return [String]
|
|
658
|
+
#
|
|
659
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/DeleteConfigurationSetRequest AWS API Documentation
|
|
660
|
+
#
|
|
661
|
+
class DeleteConfigurationSetRequest < Struct.new(
|
|
662
|
+
:configuration_set_name)
|
|
663
|
+
include Aws::Structure
|
|
664
|
+
end
|
|
665
|
+
|
|
666
|
+
# An HTTP 200 response if the request succeeds, or an error message if
|
|
667
|
+
# the request fails.
|
|
668
|
+
#
|
|
669
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/DeleteConfigurationSetResponse AWS API Documentation
|
|
670
|
+
#
|
|
671
|
+
class DeleteConfigurationSetResponse < Aws::EmptyStructure; end
|
|
672
|
+
|
|
673
|
+
# A request to delete a dedicated IP pool.
|
|
674
|
+
#
|
|
675
|
+
# @note When making an API call, you may pass DeleteDedicatedIpPoolRequest
|
|
676
|
+
# data as a hash:
|
|
677
|
+
#
|
|
678
|
+
# {
|
|
679
|
+
# pool_name: "PoolName", # required
|
|
680
|
+
# }
|
|
681
|
+
#
|
|
682
|
+
# @!attribute [rw] pool_name
|
|
683
|
+
# The name of the dedicated IP pool that you want to delete.
|
|
684
|
+
# @return [String]
|
|
685
|
+
#
|
|
686
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/DeleteDedicatedIpPoolRequest AWS API Documentation
|
|
687
|
+
#
|
|
688
|
+
class DeleteDedicatedIpPoolRequest < Struct.new(
|
|
689
|
+
:pool_name)
|
|
690
|
+
include Aws::Structure
|
|
691
|
+
end
|
|
692
|
+
|
|
693
|
+
# An HTTP 200 response if the request succeeds, or an error message if
|
|
694
|
+
# the request fails.
|
|
695
|
+
#
|
|
696
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/DeleteDedicatedIpPoolResponse AWS API Documentation
|
|
697
|
+
#
|
|
698
|
+
class DeleteDedicatedIpPoolResponse < Aws::EmptyStructure; end
|
|
699
|
+
|
|
700
|
+
# A request to delete an existing email identity. When you delete an
|
|
701
|
+
# identity, you lose the ability to send email from that identity. You
|
|
702
|
+
# can restore your ability to send email by completing the verification
|
|
703
|
+
# process for the identity again.
|
|
704
|
+
#
|
|
705
|
+
# @note When making an API call, you may pass DeleteEmailIdentityRequest
|
|
706
|
+
# data as a hash:
|
|
707
|
+
#
|
|
708
|
+
# {
|
|
709
|
+
# email_identity: "Identity", # required
|
|
710
|
+
# }
|
|
711
|
+
#
|
|
712
|
+
# @!attribute [rw] email_identity
|
|
713
|
+
# The identity (that is, the email address or domain) that you want to
|
|
714
|
+
# delete.
|
|
715
|
+
# @return [String]
|
|
716
|
+
#
|
|
717
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/DeleteEmailIdentityRequest AWS API Documentation
|
|
718
|
+
#
|
|
719
|
+
class DeleteEmailIdentityRequest < Struct.new(
|
|
720
|
+
:email_identity)
|
|
721
|
+
include Aws::Structure
|
|
722
|
+
end
|
|
723
|
+
|
|
724
|
+
# An HTTP 200 response if the request succeeds, or an error message if
|
|
725
|
+
# the request fails.
|
|
726
|
+
#
|
|
727
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/DeleteEmailIdentityResponse AWS API Documentation
|
|
728
|
+
#
|
|
729
|
+
class DeleteEmailIdentityResponse < Aws::EmptyStructure; end
|
|
730
|
+
|
|
731
|
+
# An object that contains metadata related to a predictive inbox
|
|
732
|
+
# placement test.
|
|
733
|
+
#
|
|
734
|
+
# @!attribute [rw] report_id
|
|
735
|
+
# A unique string that identifies the predictive inbox placement test.
|
|
736
|
+
# @return [String]
|
|
737
|
+
#
|
|
738
|
+
# @!attribute [rw] report_name
|
|
739
|
+
# A name that helps you identify a predictive inbox placement test
|
|
740
|
+
# report.
|
|
741
|
+
# @return [String]
|
|
742
|
+
#
|
|
743
|
+
# @!attribute [rw] subject
|
|
744
|
+
# The subject line for an email that you submitted in a predictive
|
|
745
|
+
# inbox placement test.
|
|
746
|
+
# @return [String]
|
|
747
|
+
#
|
|
748
|
+
# @!attribute [rw] from_email_address
|
|
749
|
+
# The sender address that you specified for the predictive inbox
|
|
750
|
+
# placement test.
|
|
751
|
+
# @return [String]
|
|
752
|
+
#
|
|
753
|
+
# @!attribute [rw] create_date
|
|
754
|
+
# The date and time when the predictive inbox placement test was
|
|
755
|
+
# created, in Unix time format.
|
|
756
|
+
# @return [Time]
|
|
757
|
+
#
|
|
758
|
+
# @!attribute [rw] deliverability_test_status
|
|
759
|
+
# The status of the predictive inbox placement test. If the status is
|
|
760
|
+
# `IN_PROGRESS`, then the predictive inbox placement test is currently
|
|
761
|
+
# running. Predictive inbox placement tests are usually complete
|
|
762
|
+
# within 24 hours of creating the test. If the status is `COMPLETE`,
|
|
763
|
+
# then the test is finished, and you can use the
|
|
764
|
+
# `GetDeliverabilityTestReport` to view the results of the test.
|
|
765
|
+
# @return [String]
|
|
766
|
+
#
|
|
767
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/DeliverabilityTestReport AWS API Documentation
|
|
768
|
+
#
|
|
769
|
+
class DeliverabilityTestReport < Struct.new(
|
|
770
|
+
:report_id,
|
|
771
|
+
:report_name,
|
|
772
|
+
:subject,
|
|
773
|
+
:from_email_address,
|
|
774
|
+
:create_date,
|
|
775
|
+
:deliverability_test_status)
|
|
776
|
+
include Aws::Structure
|
|
777
|
+
end
|
|
778
|
+
|
|
779
|
+
# Used to associate a configuration set with a dedicated IP pool.
|
|
780
|
+
#
|
|
781
|
+
# @note When making an API call, you may pass DeliveryOptions
|
|
782
|
+
# data as a hash:
|
|
783
|
+
#
|
|
784
|
+
# {
|
|
785
|
+
# tls_policy: "REQUIRE", # accepts REQUIRE, OPTIONAL
|
|
786
|
+
# sending_pool_name: "PoolName",
|
|
787
|
+
# }
|
|
788
|
+
#
|
|
789
|
+
# @!attribute [rw] tls_policy
|
|
790
|
+
# Specifies whether messages that use the configuration set are
|
|
791
|
+
# required to use Transport Layer Security (TLS). If the value is
|
|
792
|
+
# `Require`, messages are only delivered if a TLS connection can be
|
|
793
|
+
# established. If the value is `Optional`, messages can be delivered
|
|
794
|
+
# in plain text if a TLS connection can't be established.
|
|
795
|
+
# @return [String]
|
|
796
|
+
#
|
|
797
|
+
# @!attribute [rw] sending_pool_name
|
|
798
|
+
# The name of the dedicated IP pool that you want to associate with
|
|
799
|
+
# the configuration set.
|
|
800
|
+
# @return [String]
|
|
801
|
+
#
|
|
802
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/DeliveryOptions AWS API Documentation
|
|
803
|
+
#
|
|
804
|
+
class DeliveryOptions < Struct.new(
|
|
805
|
+
:tls_policy,
|
|
806
|
+
:sending_pool_name)
|
|
807
|
+
include Aws::Structure
|
|
808
|
+
end
|
|
809
|
+
|
|
810
|
+
# An object that describes the recipients for an email.
|
|
811
|
+
#
|
|
812
|
+
# @note When making an API call, you may pass Destination
|
|
813
|
+
# data as a hash:
|
|
814
|
+
#
|
|
815
|
+
# {
|
|
816
|
+
# to_addresses: ["EmailAddress"],
|
|
817
|
+
# cc_addresses: ["EmailAddress"],
|
|
818
|
+
# bcc_addresses: ["EmailAddress"],
|
|
819
|
+
# }
|
|
820
|
+
#
|
|
821
|
+
# @!attribute [rw] to_addresses
|
|
822
|
+
# An array that contains the email addresses of the "To" recipients
|
|
823
|
+
# for the email.
|
|
824
|
+
# @return [Array<String>]
|
|
825
|
+
#
|
|
826
|
+
# @!attribute [rw] cc_addresses
|
|
827
|
+
# An array that contains the email addresses of the "CC" (carbon
|
|
828
|
+
# copy) recipients for the email.
|
|
829
|
+
# @return [Array<String>]
|
|
830
|
+
#
|
|
831
|
+
# @!attribute [rw] bcc_addresses
|
|
832
|
+
# An array that contains the email addresses of the "BCC" (blind
|
|
833
|
+
# carbon copy) recipients for the email.
|
|
834
|
+
# @return [Array<String>]
|
|
835
|
+
#
|
|
836
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/Destination AWS API Documentation
|
|
837
|
+
#
|
|
838
|
+
class Destination < Struct.new(
|
|
839
|
+
:to_addresses,
|
|
840
|
+
:cc_addresses,
|
|
841
|
+
:bcc_addresses)
|
|
842
|
+
include Aws::Structure
|
|
843
|
+
end
|
|
844
|
+
|
|
845
|
+
# An object that contains information about the DKIM configuration for
|
|
846
|
+
# an email identity.
|
|
847
|
+
#
|
|
848
|
+
# @!attribute [rw] signing_enabled
|
|
849
|
+
# If the value is `true`, then the messages that you send from the
|
|
850
|
+
# identity are signed using DKIM. If the value is `false`, then the
|
|
851
|
+
# messages that you send from the identity aren't DKIM-signed.
|
|
852
|
+
# @return [Boolean]
|
|
853
|
+
#
|
|
854
|
+
# @!attribute [rw] status
|
|
855
|
+
# Describes whether or not Amazon SES has successfully located the
|
|
856
|
+
# DKIM records in the DNS records for the domain. The status can be
|
|
857
|
+
# one of the following:
|
|
858
|
+
#
|
|
859
|
+
# * `PENDING` – Amazon SES hasn't yet detected the DKIM records in
|
|
860
|
+
# the DNS configuration for the domain, but will continue to attempt
|
|
861
|
+
# to locate them.
|
|
862
|
+
#
|
|
863
|
+
# * `SUCCESS` – Amazon SES located the DKIM records in the DNS
|
|
864
|
+
# configuration for the domain and determined that they're correct.
|
|
865
|
+
# You can now send DKIM-signed email from the identity.
|
|
866
|
+
#
|
|
867
|
+
# * `FAILED` – Amazon SES wasn't able to locate the DKIM records in
|
|
868
|
+
# the DNS settings for the domain, and won't continue to search for
|
|
869
|
+
# them.
|
|
870
|
+
#
|
|
871
|
+
# * `TEMPORARY_FAILURE` – A temporary issue occurred, which prevented
|
|
872
|
+
# Amazon SES from determining the DKIM status for the domain.
|
|
873
|
+
#
|
|
874
|
+
# * `NOT_STARTED` – Amazon SES hasn't yet started searching for the
|
|
875
|
+
# DKIM records in the DKIM records for the domain.
|
|
876
|
+
# @return [String]
|
|
877
|
+
#
|
|
878
|
+
# @!attribute [rw] tokens
|
|
879
|
+
# A set of unique strings that you use to create a set of CNAME
|
|
880
|
+
# records that you add to the DNS configuration for your domain. When
|
|
881
|
+
# Amazon SES detects these records in the DNS configuration for your
|
|
882
|
+
# domain, the DKIM authentication process is complete. Amazon SES
|
|
883
|
+
# usually detects these records within about 72 hours of adding them
|
|
884
|
+
# to the DNS configuration for your domain.
|
|
885
|
+
# @return [Array<String>]
|
|
886
|
+
#
|
|
887
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/DkimAttributes AWS API Documentation
|
|
888
|
+
#
|
|
889
|
+
class DkimAttributes < Struct.new(
|
|
890
|
+
:signing_enabled,
|
|
891
|
+
:status,
|
|
892
|
+
:tokens)
|
|
893
|
+
include Aws::Structure
|
|
894
|
+
end
|
|
895
|
+
|
|
896
|
+
# An object that contains the deliverability data for a specific
|
|
897
|
+
# campaign. This data is available for a campaign only if the campaign
|
|
898
|
+
# sent email by using a domain that the Deliverability dashboard is
|
|
899
|
+
# enabled for (`PutDeliverabilityDashboardOption` operation).
|
|
900
|
+
#
|
|
901
|
+
# @!attribute [rw] campaign_id
|
|
902
|
+
# The unique identifier for the campaign. The Deliverability dashboard
|
|
903
|
+
# automatically generates and assigns this identifier to a campaign.
|
|
904
|
+
# @return [String]
|
|
905
|
+
#
|
|
906
|
+
# @!attribute [rw] image_url
|
|
907
|
+
# The URL of an image that contains a snapshot of the email message
|
|
908
|
+
# that was sent.
|
|
909
|
+
# @return [String]
|
|
910
|
+
#
|
|
911
|
+
# @!attribute [rw] subject
|
|
912
|
+
# The subject line, or title, of the email message.
|
|
913
|
+
# @return [String]
|
|
914
|
+
#
|
|
915
|
+
# @!attribute [rw] from_address
|
|
916
|
+
# The verified email address that the email message was sent from.
|
|
917
|
+
# @return [String]
|
|
918
|
+
#
|
|
919
|
+
# @!attribute [rw] sending_ips
|
|
920
|
+
# The IP addresses that were used to send the email message.
|
|
921
|
+
# @return [Array<String>]
|
|
922
|
+
#
|
|
923
|
+
# @!attribute [rw] first_seen_date_time
|
|
924
|
+
# The first time, in Unix time format, when the email message was
|
|
925
|
+
# delivered to any recipient's inbox. This value can help you
|
|
926
|
+
# determine how long it took for a campaign to deliver an email
|
|
927
|
+
# message.
|
|
928
|
+
# @return [Time]
|
|
929
|
+
#
|
|
930
|
+
# @!attribute [rw] last_seen_date_time
|
|
931
|
+
# The last time, in Unix time format, when the email message was
|
|
932
|
+
# delivered to any recipient's inbox. This value can help you
|
|
933
|
+
# determine how long it took for a campaign to deliver an email
|
|
934
|
+
# message.
|
|
935
|
+
# @return [Time]
|
|
936
|
+
#
|
|
937
|
+
# @!attribute [rw] inbox_count
|
|
938
|
+
# The number of email messages that were delivered to recipients’
|
|
939
|
+
# inboxes.
|
|
940
|
+
# @return [Integer]
|
|
941
|
+
#
|
|
942
|
+
# @!attribute [rw] spam_count
|
|
943
|
+
# The number of email messages that were delivered to recipients'
|
|
944
|
+
# spam or junk mail folders.
|
|
945
|
+
# @return [Integer]
|
|
946
|
+
#
|
|
947
|
+
# @!attribute [rw] read_rate
|
|
948
|
+
# The percentage of email messages that were opened by recipients. Due
|
|
949
|
+
# to technical limitations, this value only includes recipients who
|
|
950
|
+
# opened the message by using an email client that supports images.
|
|
951
|
+
# @return [Float]
|
|
952
|
+
#
|
|
953
|
+
# @!attribute [rw] delete_rate
|
|
954
|
+
# The percentage of email messages that were deleted by recipients,
|
|
955
|
+
# without being opened first. Due to technical limitations, this value
|
|
956
|
+
# only includes recipients who opened the message by using an email
|
|
957
|
+
# client that supports images.
|
|
958
|
+
# @return [Float]
|
|
959
|
+
#
|
|
960
|
+
# @!attribute [rw] read_delete_rate
|
|
961
|
+
# The percentage of email messages that were opened and then deleted
|
|
962
|
+
# by recipients. Due to technical limitations, this value only
|
|
963
|
+
# includes recipients who opened the message by using an email client
|
|
964
|
+
# that supports images.
|
|
965
|
+
# @return [Float]
|
|
966
|
+
#
|
|
967
|
+
# @!attribute [rw] projected_volume
|
|
968
|
+
# The projected number of recipients that the email message was sent
|
|
969
|
+
# to.
|
|
970
|
+
# @return [Integer]
|
|
971
|
+
#
|
|
972
|
+
# @!attribute [rw] esps
|
|
973
|
+
# The major email providers who handled the email message.
|
|
974
|
+
# @return [Array<String>]
|
|
975
|
+
#
|
|
976
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/DomainDeliverabilityCampaign AWS API Documentation
|
|
977
|
+
#
|
|
978
|
+
class DomainDeliverabilityCampaign < Struct.new(
|
|
979
|
+
:campaign_id,
|
|
980
|
+
:image_url,
|
|
981
|
+
:subject,
|
|
982
|
+
:from_address,
|
|
983
|
+
:sending_ips,
|
|
984
|
+
:first_seen_date_time,
|
|
985
|
+
:last_seen_date_time,
|
|
986
|
+
:inbox_count,
|
|
987
|
+
:spam_count,
|
|
988
|
+
:read_rate,
|
|
989
|
+
:delete_rate,
|
|
990
|
+
:read_delete_rate,
|
|
991
|
+
:projected_volume,
|
|
992
|
+
:esps)
|
|
993
|
+
include Aws::Structure
|
|
994
|
+
end
|
|
995
|
+
|
|
996
|
+
# An object that contains information about the Deliverability dashboard
|
|
997
|
+
# subscription for a verified domain that you use to send email and
|
|
998
|
+
# currently has an active Deliverability dashboard subscription. If a
|
|
999
|
+
# Deliverability dashboard subscription is active for a domain, you gain
|
|
1000
|
+
# access to reputation, inbox placement, and other metrics for the
|
|
1001
|
+
# domain.
|
|
1002
|
+
#
|
|
1003
|
+
# @note When making an API call, you may pass DomainDeliverabilityTrackingOption
|
|
1004
|
+
# data as a hash:
|
|
1005
|
+
#
|
|
1006
|
+
# {
|
|
1007
|
+
# domain: "Domain",
|
|
1008
|
+
# subscription_start_date: Time.now,
|
|
1009
|
+
# inbox_placement_tracking_option: {
|
|
1010
|
+
# global: false,
|
|
1011
|
+
# tracked_isps: ["IspName"],
|
|
1012
|
+
# },
|
|
1013
|
+
# }
|
|
1014
|
+
#
|
|
1015
|
+
# @!attribute [rw] domain
|
|
1016
|
+
# A verified domain that’s associated with your AWS account and
|
|
1017
|
+
# currently has an active Deliverability dashboard subscription.
|
|
1018
|
+
# @return [String]
|
|
1019
|
+
#
|
|
1020
|
+
# @!attribute [rw] subscription_start_date
|
|
1021
|
+
# The date, in Unix time format, when you enabled the Deliverability
|
|
1022
|
+
# dashboard for the domain.
|
|
1023
|
+
# @return [Time]
|
|
1024
|
+
#
|
|
1025
|
+
# @!attribute [rw] inbox_placement_tracking_option
|
|
1026
|
+
# An object that contains information about the inbox placement data
|
|
1027
|
+
# settings for the domain.
|
|
1028
|
+
# @return [Types::InboxPlacementTrackingOption]
|
|
1029
|
+
#
|
|
1030
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/DomainDeliverabilityTrackingOption AWS API Documentation
|
|
1031
|
+
#
|
|
1032
|
+
class DomainDeliverabilityTrackingOption < Struct.new(
|
|
1033
|
+
:domain,
|
|
1034
|
+
:subscription_start_date,
|
|
1035
|
+
:inbox_placement_tracking_option)
|
|
1036
|
+
include Aws::Structure
|
|
1037
|
+
end
|
|
1038
|
+
|
|
1039
|
+
# An object that contains inbox placement data for email sent from one
|
|
1040
|
+
# of your email domains to a specific email provider.
|
|
1041
|
+
#
|
|
1042
|
+
# @!attribute [rw] isp_name
|
|
1043
|
+
# The name of the email provider that the inbox placement data applies
|
|
1044
|
+
# to.
|
|
1045
|
+
# @return [String]
|
|
1046
|
+
#
|
|
1047
|
+
# @!attribute [rw] inbox_raw_count
|
|
1048
|
+
# The total number of messages that were sent from the selected domain
|
|
1049
|
+
# to the specified email provider that arrived in recipients'
|
|
1050
|
+
# inboxes.
|
|
1051
|
+
# @return [Integer]
|
|
1052
|
+
#
|
|
1053
|
+
# @!attribute [rw] spam_raw_count
|
|
1054
|
+
# The total number of messages that were sent from the selected domain
|
|
1055
|
+
# to the specified email provider that arrived in recipients' spam or
|
|
1056
|
+
# junk mail folders.
|
|
1057
|
+
# @return [Integer]
|
|
1058
|
+
#
|
|
1059
|
+
# @!attribute [rw] inbox_percentage
|
|
1060
|
+
# The percentage of messages that were sent from the selected domain
|
|
1061
|
+
# to the specified email provider that arrived in recipients'
|
|
1062
|
+
# inboxes.
|
|
1063
|
+
# @return [Float]
|
|
1064
|
+
#
|
|
1065
|
+
# @!attribute [rw] spam_percentage
|
|
1066
|
+
# The percentage of messages that were sent from the selected domain
|
|
1067
|
+
# to the specified email provider that arrived in recipients' spam or
|
|
1068
|
+
# junk mail folders.
|
|
1069
|
+
# @return [Float]
|
|
1070
|
+
#
|
|
1071
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/DomainIspPlacement AWS API Documentation
|
|
1072
|
+
#
|
|
1073
|
+
class DomainIspPlacement < Struct.new(
|
|
1074
|
+
:isp_name,
|
|
1075
|
+
:inbox_raw_count,
|
|
1076
|
+
:spam_raw_count,
|
|
1077
|
+
:inbox_percentage,
|
|
1078
|
+
:spam_percentage)
|
|
1079
|
+
include Aws::Structure
|
|
1080
|
+
end
|
|
1081
|
+
|
|
1082
|
+
# An object that defines the entire content of the email, including the
|
|
1083
|
+
# message headers and the body content. You can create a simple email
|
|
1084
|
+
# message, in which you specify the subject and the text and HTML
|
|
1085
|
+
# versions of the message body. You can also create raw messages, in
|
|
1086
|
+
# which you specify a complete MIME-formatted message. Raw messages can
|
|
1087
|
+
# include attachments and custom headers.
|
|
1088
|
+
#
|
|
1089
|
+
# @note When making an API call, you may pass EmailContent
|
|
1090
|
+
# data as a hash:
|
|
1091
|
+
#
|
|
1092
|
+
# {
|
|
1093
|
+
# simple: {
|
|
1094
|
+
# subject: { # required
|
|
1095
|
+
# data: "MessageData", # required
|
|
1096
|
+
# charset: "Charset",
|
|
1097
|
+
# },
|
|
1098
|
+
# body: { # required
|
|
1099
|
+
# text: {
|
|
1100
|
+
# data: "MessageData", # required
|
|
1101
|
+
# charset: "Charset",
|
|
1102
|
+
# },
|
|
1103
|
+
# html: {
|
|
1104
|
+
# data: "MessageData", # required
|
|
1105
|
+
# charset: "Charset",
|
|
1106
|
+
# },
|
|
1107
|
+
# },
|
|
1108
|
+
# },
|
|
1109
|
+
# raw: {
|
|
1110
|
+
# data: "data", # required
|
|
1111
|
+
# },
|
|
1112
|
+
# template: {
|
|
1113
|
+
# template_arn: "TemplateArn",
|
|
1114
|
+
# template_data: "TemplateData",
|
|
1115
|
+
# },
|
|
1116
|
+
# }
|
|
1117
|
+
#
|
|
1118
|
+
# @!attribute [rw] simple
|
|
1119
|
+
# The simple email message. The message consists of a subject and a
|
|
1120
|
+
# message body.
|
|
1121
|
+
# @return [Types::Message]
|
|
1122
|
+
#
|
|
1123
|
+
# @!attribute [rw] raw
|
|
1124
|
+
# The raw email message. The message has to meet the following
|
|
1125
|
+
# criteria:
|
|
1126
|
+
#
|
|
1127
|
+
# * The message has to contain a header and a body, separated by one
|
|
1128
|
+
# blank line.
|
|
1129
|
+
#
|
|
1130
|
+
# * All of the required header fields must be present in the message.
|
|
1131
|
+
#
|
|
1132
|
+
# * Each part of a multipart MIME message must be formatted properly.
|
|
1133
|
+
#
|
|
1134
|
+
# * If you include attachments, they must be in a file format that the
|
|
1135
|
+
# Amazon SES API v2 supports.
|
|
1136
|
+
#
|
|
1137
|
+
# * The entire message must be Base64 encoded.
|
|
1138
|
+
#
|
|
1139
|
+
# * If any of the MIME parts in your message contain content that is
|
|
1140
|
+
# outside of the 7-bit ASCII character range, you should encode that
|
|
1141
|
+
# content to ensure that recipients' email clients render the
|
|
1142
|
+
# message properly.
|
|
1143
|
+
#
|
|
1144
|
+
# * The length of any single line of text in the message can't exceed
|
|
1145
|
+
# 1,000 characters. This restriction is defined in [RFC 5321][1].
|
|
1146
|
+
#
|
|
1147
|
+
#
|
|
1148
|
+
#
|
|
1149
|
+
# [1]: https://tools.ietf.org/html/rfc5321
|
|
1150
|
+
# @return [Types::RawMessage]
|
|
1151
|
+
#
|
|
1152
|
+
# @!attribute [rw] template
|
|
1153
|
+
# The template to use for the email message.
|
|
1154
|
+
# @return [Types::Template]
|
|
1155
|
+
#
|
|
1156
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/EmailContent AWS API Documentation
|
|
1157
|
+
#
|
|
1158
|
+
class EmailContent < Struct.new(
|
|
1159
|
+
:simple,
|
|
1160
|
+
:raw,
|
|
1161
|
+
:template)
|
|
1162
|
+
include Aws::Structure
|
|
1163
|
+
end
|
|
1164
|
+
|
|
1165
|
+
# In the Amazon SES API v2, *events* include message sends, deliveries,
|
|
1166
|
+
# opens, clicks, bounces, and complaints. *Event destinations* are
|
|
1167
|
+
# places that you can send information about these events to. For
|
|
1168
|
+
# example, you can send event data to Amazon SNS to receive
|
|
1169
|
+
# notifications when you receive bounces or complaints, or you can use
|
|
1170
|
+
# Amazon Kinesis Data Firehose to stream data to Amazon S3 for long-term
|
|
1171
|
+
# storage.
|
|
1172
|
+
#
|
|
1173
|
+
# @!attribute [rw] name
|
|
1174
|
+
# A name that identifies the event destination.
|
|
1175
|
+
# @return [String]
|
|
1176
|
+
#
|
|
1177
|
+
# @!attribute [rw] enabled
|
|
1178
|
+
# If `true`, the event destination is enabled. When the event
|
|
1179
|
+
# destination is enabled, the specified event types are sent to the
|
|
1180
|
+
# destinations in this `EventDestinationDefinition`.
|
|
1181
|
+
#
|
|
1182
|
+
# If `false`, the event destination is disabled. When the event
|
|
1183
|
+
# destination is disabled, events aren't sent to the specified
|
|
1184
|
+
# destinations.
|
|
1185
|
+
# @return [Boolean]
|
|
1186
|
+
#
|
|
1187
|
+
# @!attribute [rw] matching_event_types
|
|
1188
|
+
# The types of events that Amazon SES sends to the specified event
|
|
1189
|
+
# destinations.
|
|
1190
|
+
# @return [Array<String>]
|
|
1191
|
+
#
|
|
1192
|
+
# @!attribute [rw] kinesis_firehose_destination
|
|
1193
|
+
# An object that defines an Amazon Kinesis Data Firehose destination
|
|
1194
|
+
# for email events. You can use Amazon Kinesis Data Firehose to stream
|
|
1195
|
+
# data to other services, such as Amazon S3 and Amazon Redshift.
|
|
1196
|
+
# @return [Types::KinesisFirehoseDestination]
|
|
1197
|
+
#
|
|
1198
|
+
# @!attribute [rw] cloud_watch_destination
|
|
1199
|
+
# An object that defines an Amazon CloudWatch destination for email
|
|
1200
|
+
# events. You can use Amazon CloudWatch to monitor and gain insights
|
|
1201
|
+
# on your email sending metrics.
|
|
1202
|
+
# @return [Types::CloudWatchDestination]
|
|
1203
|
+
#
|
|
1204
|
+
# @!attribute [rw] sns_destination
|
|
1205
|
+
# An object that defines an Amazon SNS destination for email events.
|
|
1206
|
+
# You can use Amazon SNS to send notification when certain email
|
|
1207
|
+
# events occur.
|
|
1208
|
+
# @return [Types::SnsDestination]
|
|
1209
|
+
#
|
|
1210
|
+
# @!attribute [rw] pinpoint_destination
|
|
1211
|
+
# An object that defines an Amazon Pinpoint project destination for
|
|
1212
|
+
# email events. You can send email event data to a Amazon Pinpoint
|
|
1213
|
+
# project to view metrics using the Transactional Messaging dashboards
|
|
1214
|
+
# that are built in to Amazon Pinpoint. For more information, see
|
|
1215
|
+
# [Transactional Messaging Charts][1] in the *Amazon Pinpoint User
|
|
1216
|
+
# Guide*.
|
|
1217
|
+
#
|
|
1218
|
+
#
|
|
1219
|
+
#
|
|
1220
|
+
# [1]: https://docs.aws.amazon.com/pinpoint/latest/userguide/analytics-transactional-messages.html
|
|
1221
|
+
# @return [Types::PinpointDestination]
|
|
1222
|
+
#
|
|
1223
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/EventDestination AWS API Documentation
|
|
1224
|
+
#
|
|
1225
|
+
class EventDestination < Struct.new(
|
|
1226
|
+
:name,
|
|
1227
|
+
:enabled,
|
|
1228
|
+
:matching_event_types,
|
|
1229
|
+
:kinesis_firehose_destination,
|
|
1230
|
+
:cloud_watch_destination,
|
|
1231
|
+
:sns_destination,
|
|
1232
|
+
:pinpoint_destination)
|
|
1233
|
+
include Aws::Structure
|
|
1234
|
+
end
|
|
1235
|
+
|
|
1236
|
+
# An object that defines the event destination. Specifically, it defines
|
|
1237
|
+
# which services receive events from emails sent using the configuration
|
|
1238
|
+
# set that the event destination is associated with. Also defines the
|
|
1239
|
+
# types of events that are sent to the event destination.
|
|
1240
|
+
#
|
|
1241
|
+
# @note When making an API call, you may pass EventDestinationDefinition
|
|
1242
|
+
# data as a hash:
|
|
1243
|
+
#
|
|
1244
|
+
# {
|
|
1245
|
+
# enabled: false,
|
|
1246
|
+
# matching_event_types: ["SEND"], # accepts SEND, REJECT, BOUNCE, COMPLAINT, DELIVERY, OPEN, CLICK, RENDERING_FAILURE
|
|
1247
|
+
# kinesis_firehose_destination: {
|
|
1248
|
+
# iam_role_arn: "AmazonResourceName", # required
|
|
1249
|
+
# delivery_stream_arn: "AmazonResourceName", # required
|
|
1250
|
+
# },
|
|
1251
|
+
# cloud_watch_destination: {
|
|
1252
|
+
# dimension_configurations: [ # required
|
|
1253
|
+
# {
|
|
1254
|
+
# dimension_name: "DimensionName", # required
|
|
1255
|
+
# dimension_value_source: "MESSAGE_TAG", # required, accepts MESSAGE_TAG, EMAIL_HEADER, LINK_TAG
|
|
1256
|
+
# default_dimension_value: "DefaultDimensionValue", # required
|
|
1257
|
+
# },
|
|
1258
|
+
# ],
|
|
1259
|
+
# },
|
|
1260
|
+
# sns_destination: {
|
|
1261
|
+
# topic_arn: "AmazonResourceName", # required
|
|
1262
|
+
# },
|
|
1263
|
+
# pinpoint_destination: {
|
|
1264
|
+
# application_arn: "AmazonResourceName",
|
|
1265
|
+
# },
|
|
1266
|
+
# }
|
|
1267
|
+
#
|
|
1268
|
+
# @!attribute [rw] enabled
|
|
1269
|
+
# If `true`, the event destination is enabled. When the event
|
|
1270
|
+
# destination is enabled, the specified event types are sent to the
|
|
1271
|
+
# destinations in this `EventDestinationDefinition`.
|
|
1272
|
+
#
|
|
1273
|
+
# If `false`, the event destination is disabled. When the event
|
|
1274
|
+
# destination is disabled, events aren't sent to the specified
|
|
1275
|
+
# destinations.
|
|
1276
|
+
# @return [Boolean]
|
|
1277
|
+
#
|
|
1278
|
+
# @!attribute [rw] matching_event_types
|
|
1279
|
+
# An array that specifies which events the Amazon SES API v2 should
|
|
1280
|
+
# send to the destinations in this `EventDestinationDefinition`.
|
|
1281
|
+
# @return [Array<String>]
|
|
1282
|
+
#
|
|
1283
|
+
# @!attribute [rw] kinesis_firehose_destination
|
|
1284
|
+
# An object that defines an Amazon Kinesis Data Firehose destination
|
|
1285
|
+
# for email events. You can use Amazon Kinesis Data Firehose to stream
|
|
1286
|
+
# data to other services, such as Amazon S3 and Amazon Redshift.
|
|
1287
|
+
# @return [Types::KinesisFirehoseDestination]
|
|
1288
|
+
#
|
|
1289
|
+
# @!attribute [rw] cloud_watch_destination
|
|
1290
|
+
# An object that defines an Amazon CloudWatch destination for email
|
|
1291
|
+
# events. You can use Amazon CloudWatch to monitor and gain insights
|
|
1292
|
+
# on your email sending metrics.
|
|
1293
|
+
# @return [Types::CloudWatchDestination]
|
|
1294
|
+
#
|
|
1295
|
+
# @!attribute [rw] sns_destination
|
|
1296
|
+
# An object that defines an Amazon SNS destination for email events.
|
|
1297
|
+
# You can use Amazon SNS to send notification when certain email
|
|
1298
|
+
# events occur.
|
|
1299
|
+
# @return [Types::SnsDestination]
|
|
1300
|
+
#
|
|
1301
|
+
# @!attribute [rw] pinpoint_destination
|
|
1302
|
+
# An object that defines an Amazon Pinpoint project destination for
|
|
1303
|
+
# email events. You can send email event data to a Amazon Pinpoint
|
|
1304
|
+
# project to view metrics using the Transactional Messaging dashboards
|
|
1305
|
+
# that are built in to Amazon Pinpoint. For more information, see
|
|
1306
|
+
# [Transactional Messaging Charts][1] in the *Amazon Pinpoint User
|
|
1307
|
+
# Guide*.
|
|
1308
|
+
#
|
|
1309
|
+
#
|
|
1310
|
+
#
|
|
1311
|
+
# [1]: https://docs.aws.amazon.com/pinpoint/latest/userguide/analytics-transactional-messages.html
|
|
1312
|
+
# @return [Types::PinpointDestination]
|
|
1313
|
+
#
|
|
1314
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/EventDestinationDefinition AWS API Documentation
|
|
1315
|
+
#
|
|
1316
|
+
class EventDestinationDefinition < Struct.new(
|
|
1317
|
+
:enabled,
|
|
1318
|
+
:matching_event_types,
|
|
1319
|
+
:kinesis_firehose_destination,
|
|
1320
|
+
:cloud_watch_destination,
|
|
1321
|
+
:sns_destination,
|
|
1322
|
+
:pinpoint_destination)
|
|
1323
|
+
include Aws::Structure
|
|
1324
|
+
end
|
|
1325
|
+
|
|
1326
|
+
# A request to obtain information about the email-sending capabilities
|
|
1327
|
+
# of your Amazon SES account.
|
|
1328
|
+
#
|
|
1329
|
+
# @api private
|
|
1330
|
+
#
|
|
1331
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/GetAccountRequest AWS API Documentation
|
|
1332
|
+
#
|
|
1333
|
+
class GetAccountRequest < Aws::EmptyStructure; end
|
|
1334
|
+
|
|
1335
|
+
# A list of details about the email-sending capabilities of your Amazon
|
|
1336
|
+
# SES account in the current AWS Region.
|
|
1337
|
+
#
|
|
1338
|
+
# @!attribute [rw] send_quota
|
|
1339
|
+
# An object that contains information about the per-day and per-second
|
|
1340
|
+
# sending limits for your Amazon SES account in the current AWS
|
|
1341
|
+
# Region.
|
|
1342
|
+
# @return [Types::SendQuota]
|
|
1343
|
+
#
|
|
1344
|
+
# @!attribute [rw] sending_enabled
|
|
1345
|
+
# Indicates whether or not email sending is enabled for your Amazon
|
|
1346
|
+
# SES account in the current AWS Region.
|
|
1347
|
+
# @return [Boolean]
|
|
1348
|
+
#
|
|
1349
|
+
# @!attribute [rw] dedicated_ip_auto_warmup_enabled
|
|
1350
|
+
# Indicates whether or not the automatic warm-up feature is enabled
|
|
1351
|
+
# for dedicated IP addresses that are associated with your account.
|
|
1352
|
+
# @return [Boolean]
|
|
1353
|
+
#
|
|
1354
|
+
# @!attribute [rw] enforcement_status
|
|
1355
|
+
# The reputation status of your Amazon SES account. The status can be
|
|
1356
|
+
# one of the following:
|
|
1357
|
+
#
|
|
1358
|
+
# * `HEALTHY` – There are no reputation-related issues that currently
|
|
1359
|
+
# impact your account.
|
|
1360
|
+
#
|
|
1361
|
+
# * `PROBATION` – We've identified potential issues with your Amazon
|
|
1362
|
+
# SES account. We're placing your account under review while you
|
|
1363
|
+
# work on correcting these issues.
|
|
1364
|
+
#
|
|
1365
|
+
# * `SHUTDOWN` – Your account's ability to send email is currently
|
|
1366
|
+
# paused because of an issue with the email sent from your account.
|
|
1367
|
+
# When you correct the issue, you can contact us and request that
|
|
1368
|
+
# your account's ability to send email is resumed.
|
|
1369
|
+
# @return [String]
|
|
1370
|
+
#
|
|
1371
|
+
# @!attribute [rw] production_access_enabled
|
|
1372
|
+
# Indicates whether or not your account has production access in the
|
|
1373
|
+
# current AWS Region.
|
|
1374
|
+
#
|
|
1375
|
+
# If the value is `false`, then your account is in the *sandbox*. When
|
|
1376
|
+
# your account is in the sandbox, you can only send email to verified
|
|
1377
|
+
# identities. Additionally, the maximum number of emails you can send
|
|
1378
|
+
# in a 24-hour period (your sending quota) is 200, and the maximum
|
|
1379
|
+
# number of emails you can send per second (your maximum sending rate)
|
|
1380
|
+
# is 1.
|
|
1381
|
+
#
|
|
1382
|
+
# If the value is `true`, then your account has production access.
|
|
1383
|
+
# When your account has production access, you can send email to any
|
|
1384
|
+
# address. The sending quota and maximum sending rate for your account
|
|
1385
|
+
# vary based on your specific use case.
|
|
1386
|
+
# @return [Boolean]
|
|
1387
|
+
#
|
|
1388
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/GetAccountResponse AWS API Documentation
|
|
1389
|
+
#
|
|
1390
|
+
class GetAccountResponse < Struct.new(
|
|
1391
|
+
:send_quota,
|
|
1392
|
+
:sending_enabled,
|
|
1393
|
+
:dedicated_ip_auto_warmup_enabled,
|
|
1394
|
+
:enforcement_status,
|
|
1395
|
+
:production_access_enabled)
|
|
1396
|
+
include Aws::Structure
|
|
1397
|
+
end
|
|
1398
|
+
|
|
1399
|
+
# A request to retrieve a list of the blacklists that your dedicated IP
|
|
1400
|
+
# addresses appear on.
|
|
1401
|
+
#
|
|
1402
|
+
# @note When making an API call, you may pass GetBlacklistReportsRequest
|
|
1403
|
+
# data as a hash:
|
|
1404
|
+
#
|
|
1405
|
+
# {
|
|
1406
|
+
# blacklist_item_names: ["BlacklistItemName"], # required
|
|
1407
|
+
# }
|
|
1408
|
+
#
|
|
1409
|
+
# @!attribute [rw] blacklist_item_names
|
|
1410
|
+
# A list of IP addresses that you want to retrieve blacklist
|
|
1411
|
+
# information about. You can only specify the dedicated IP addresses
|
|
1412
|
+
# that you use to send email using Amazon SES or Amazon Pinpoint.
|
|
1413
|
+
# @return [Array<String>]
|
|
1414
|
+
#
|
|
1415
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/GetBlacklistReportsRequest AWS API Documentation
|
|
1416
|
+
#
|
|
1417
|
+
class GetBlacklistReportsRequest < Struct.new(
|
|
1418
|
+
:blacklist_item_names)
|
|
1419
|
+
include Aws::Structure
|
|
1420
|
+
end
|
|
1421
|
+
|
|
1422
|
+
# An object that contains information about blacklist events.
|
|
1423
|
+
#
|
|
1424
|
+
# @!attribute [rw] blacklist_report
|
|
1425
|
+
# An object that contains information about a blacklist that one of
|
|
1426
|
+
# your dedicated IP addresses appears on.
|
|
1427
|
+
# @return [Hash<String,Array<Types::BlacklistEntry>>]
|
|
1428
|
+
#
|
|
1429
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/GetBlacklistReportsResponse AWS API Documentation
|
|
1430
|
+
#
|
|
1431
|
+
class GetBlacklistReportsResponse < Struct.new(
|
|
1432
|
+
:blacklist_report)
|
|
1433
|
+
include Aws::Structure
|
|
1434
|
+
end
|
|
1435
|
+
|
|
1436
|
+
# A request to obtain information about the event destinations for a
|
|
1437
|
+
# configuration set.
|
|
1438
|
+
#
|
|
1439
|
+
# @note When making an API call, you may pass GetConfigurationSetEventDestinationsRequest
|
|
1440
|
+
# data as a hash:
|
|
1441
|
+
#
|
|
1442
|
+
# {
|
|
1443
|
+
# configuration_set_name: "ConfigurationSetName", # required
|
|
1444
|
+
# }
|
|
1445
|
+
#
|
|
1446
|
+
# @!attribute [rw] configuration_set_name
|
|
1447
|
+
# The name of the configuration set that contains the event
|
|
1448
|
+
# destination.
|
|
1449
|
+
# @return [String]
|
|
1450
|
+
#
|
|
1451
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/GetConfigurationSetEventDestinationsRequest AWS API Documentation
|
|
1452
|
+
#
|
|
1453
|
+
class GetConfigurationSetEventDestinationsRequest < Struct.new(
|
|
1454
|
+
:configuration_set_name)
|
|
1455
|
+
include Aws::Structure
|
|
1456
|
+
end
|
|
1457
|
+
|
|
1458
|
+
# Information about an event destination for a configuration set.
|
|
1459
|
+
#
|
|
1460
|
+
# @!attribute [rw] event_destinations
|
|
1461
|
+
# An array that includes all of the events destinations that have been
|
|
1462
|
+
# configured for the configuration set.
|
|
1463
|
+
# @return [Array<Types::EventDestination>]
|
|
1464
|
+
#
|
|
1465
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/GetConfigurationSetEventDestinationsResponse AWS API Documentation
|
|
1466
|
+
#
|
|
1467
|
+
class GetConfigurationSetEventDestinationsResponse < Struct.new(
|
|
1468
|
+
:event_destinations)
|
|
1469
|
+
include Aws::Structure
|
|
1470
|
+
end
|
|
1471
|
+
|
|
1472
|
+
# A request to obtain information about a configuration set.
|
|
1473
|
+
#
|
|
1474
|
+
# @note When making an API call, you may pass GetConfigurationSetRequest
|
|
1475
|
+
# data as a hash:
|
|
1476
|
+
#
|
|
1477
|
+
# {
|
|
1478
|
+
# configuration_set_name: "ConfigurationSetName", # required
|
|
1479
|
+
# }
|
|
1480
|
+
#
|
|
1481
|
+
# @!attribute [rw] configuration_set_name
|
|
1482
|
+
# The name of the configuration set that you want to obtain more
|
|
1483
|
+
# information about.
|
|
1484
|
+
# @return [String]
|
|
1485
|
+
#
|
|
1486
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/GetConfigurationSetRequest AWS API Documentation
|
|
1487
|
+
#
|
|
1488
|
+
class GetConfigurationSetRequest < Struct.new(
|
|
1489
|
+
:configuration_set_name)
|
|
1490
|
+
include Aws::Structure
|
|
1491
|
+
end
|
|
1492
|
+
|
|
1493
|
+
# Information about a configuration set.
|
|
1494
|
+
#
|
|
1495
|
+
# @!attribute [rw] configuration_set_name
|
|
1496
|
+
# The name of the configuration set.
|
|
1497
|
+
# @return [String]
|
|
1498
|
+
#
|
|
1499
|
+
# @!attribute [rw] tracking_options
|
|
1500
|
+
# An object that defines the open and click tracking options for
|
|
1501
|
+
# emails that you send using the configuration set.
|
|
1502
|
+
# @return [Types::TrackingOptions]
|
|
1503
|
+
#
|
|
1504
|
+
# @!attribute [rw] delivery_options
|
|
1505
|
+
# An object that defines the dedicated IP pool that is used to send
|
|
1506
|
+
# emails that you send using the configuration set.
|
|
1507
|
+
# @return [Types::DeliveryOptions]
|
|
1508
|
+
#
|
|
1509
|
+
# @!attribute [rw] reputation_options
|
|
1510
|
+
# An object that defines whether or not Amazon SES collects reputation
|
|
1511
|
+
# metrics for the emails that you send that use the configuration set.
|
|
1512
|
+
# @return [Types::ReputationOptions]
|
|
1513
|
+
#
|
|
1514
|
+
# @!attribute [rw] sending_options
|
|
1515
|
+
# An object that defines whether or not Amazon SES can send email that
|
|
1516
|
+
# you send using the configuration set.
|
|
1517
|
+
# @return [Types::SendingOptions]
|
|
1518
|
+
#
|
|
1519
|
+
# @!attribute [rw] tags
|
|
1520
|
+
# An array of objects that define the tags (keys and values) that are
|
|
1521
|
+
# associated with the configuration set.
|
|
1522
|
+
# @return [Array<Types::Tag>]
|
|
1523
|
+
#
|
|
1524
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/GetConfigurationSetResponse AWS API Documentation
|
|
1525
|
+
#
|
|
1526
|
+
class GetConfigurationSetResponse < Struct.new(
|
|
1527
|
+
:configuration_set_name,
|
|
1528
|
+
:tracking_options,
|
|
1529
|
+
:delivery_options,
|
|
1530
|
+
:reputation_options,
|
|
1531
|
+
:sending_options,
|
|
1532
|
+
:tags)
|
|
1533
|
+
include Aws::Structure
|
|
1534
|
+
end
|
|
1535
|
+
|
|
1536
|
+
# A request to obtain more information about a dedicated IP address.
|
|
1537
|
+
#
|
|
1538
|
+
# @note When making an API call, you may pass GetDedicatedIpRequest
|
|
1539
|
+
# data as a hash:
|
|
1540
|
+
#
|
|
1541
|
+
# {
|
|
1542
|
+
# ip: "Ip", # required
|
|
1543
|
+
# }
|
|
1544
|
+
#
|
|
1545
|
+
# @!attribute [rw] ip
|
|
1546
|
+
# The IP address that you want to obtain more information about. The
|
|
1547
|
+
# value you specify has to be a dedicated IP address that's
|
|
1548
|
+
# assocaited with your AWS account.
|
|
1549
|
+
# @return [String]
|
|
1550
|
+
#
|
|
1551
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/GetDedicatedIpRequest AWS API Documentation
|
|
1552
|
+
#
|
|
1553
|
+
class GetDedicatedIpRequest < Struct.new(
|
|
1554
|
+
:ip)
|
|
1555
|
+
include Aws::Structure
|
|
1556
|
+
end
|
|
1557
|
+
|
|
1558
|
+
# Information about a dedicated IP address.
|
|
1559
|
+
#
|
|
1560
|
+
# @!attribute [rw] dedicated_ip
|
|
1561
|
+
# An object that contains information about a dedicated IP address.
|
|
1562
|
+
# @return [Types::DedicatedIp]
|
|
1563
|
+
#
|
|
1564
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/GetDedicatedIpResponse AWS API Documentation
|
|
1565
|
+
#
|
|
1566
|
+
class GetDedicatedIpResponse < Struct.new(
|
|
1567
|
+
:dedicated_ip)
|
|
1568
|
+
include Aws::Structure
|
|
1569
|
+
end
|
|
1570
|
+
|
|
1571
|
+
# A request to obtain more information about dedicated IP pools.
|
|
1572
|
+
#
|
|
1573
|
+
# @note When making an API call, you may pass GetDedicatedIpsRequest
|
|
1574
|
+
# data as a hash:
|
|
1575
|
+
#
|
|
1576
|
+
# {
|
|
1577
|
+
# pool_name: "PoolName",
|
|
1578
|
+
# next_token: "NextToken",
|
|
1579
|
+
# page_size: 1,
|
|
1580
|
+
# }
|
|
1581
|
+
#
|
|
1582
|
+
# @!attribute [rw] pool_name
|
|
1583
|
+
# The name of the IP pool that the dedicated IP address is associated
|
|
1584
|
+
# with.
|
|
1585
|
+
# @return [String]
|
|
1586
|
+
#
|
|
1587
|
+
# @!attribute [rw] next_token
|
|
1588
|
+
# A token returned from a previous call to `GetDedicatedIps` to
|
|
1589
|
+
# indicate the position of the dedicated IP pool in the list of IP
|
|
1590
|
+
# pools.
|
|
1591
|
+
# @return [String]
|
|
1592
|
+
#
|
|
1593
|
+
# @!attribute [rw] page_size
|
|
1594
|
+
# The number of results to show in a single call to
|
|
1595
|
+
# `GetDedicatedIpsRequest`. If the number of results is larger than
|
|
1596
|
+
# the number you specified in this parameter, then the response
|
|
1597
|
+
# includes a `NextToken` element, which you can use to obtain
|
|
1598
|
+
# additional results.
|
|
1599
|
+
# @return [Integer]
|
|
1600
|
+
#
|
|
1601
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/GetDedicatedIpsRequest AWS API Documentation
|
|
1602
|
+
#
|
|
1603
|
+
class GetDedicatedIpsRequest < Struct.new(
|
|
1604
|
+
:pool_name,
|
|
1605
|
+
:next_token,
|
|
1606
|
+
:page_size)
|
|
1607
|
+
include Aws::Structure
|
|
1608
|
+
end
|
|
1609
|
+
|
|
1610
|
+
# Information about the dedicated IP addresses that are associated with
|
|
1611
|
+
# your AWS account.
|
|
1612
|
+
#
|
|
1613
|
+
# @!attribute [rw] dedicated_ips
|
|
1614
|
+
# A list of dedicated IP addresses that are associated with your AWS
|
|
1615
|
+
# account.
|
|
1616
|
+
# @return [Array<Types::DedicatedIp>]
|
|
1617
|
+
#
|
|
1618
|
+
# @!attribute [rw] next_token
|
|
1619
|
+
# A token that indicates that there are additional dedicated IP
|
|
1620
|
+
# addresses to list. To view additional addresses, issue another
|
|
1621
|
+
# request to `GetDedicatedIps`, passing this token in the `NextToken`
|
|
1622
|
+
# parameter.
|
|
1623
|
+
# @return [String]
|
|
1624
|
+
#
|
|
1625
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/GetDedicatedIpsResponse AWS API Documentation
|
|
1626
|
+
#
|
|
1627
|
+
class GetDedicatedIpsResponse < Struct.new(
|
|
1628
|
+
:dedicated_ips,
|
|
1629
|
+
:next_token)
|
|
1630
|
+
include Aws::Structure
|
|
1631
|
+
end
|
|
1632
|
+
|
|
1633
|
+
# Retrieve information about the status of the Deliverability dashboard
|
|
1634
|
+
# for your AWS account. When the Deliverability dashboard is enabled,
|
|
1635
|
+
# you gain access to reputation, deliverability, and other metrics for
|
|
1636
|
+
# your domains. You also gain the ability to perform predictive inbox
|
|
1637
|
+
# placement tests.
|
|
1638
|
+
#
|
|
1639
|
+
# When you use the Deliverability dashboard, you pay a monthly
|
|
1640
|
+
# subscription charge, in addition to any other fees that you accrue by
|
|
1641
|
+
# using Amazon SES and other AWS services. For more information about
|
|
1642
|
+
# the features and cost of a Deliverability dashboard subscription, see
|
|
1643
|
+
# [Amazon Pinpoint Pricing][1].
|
|
1644
|
+
#
|
|
1645
|
+
#
|
|
1646
|
+
#
|
|
1647
|
+
# [1]: http://aws.amazon.com/pinpoint/pricing/
|
|
1648
|
+
#
|
|
1649
|
+
# @api private
|
|
1650
|
+
#
|
|
1651
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/GetDeliverabilityDashboardOptionsRequest AWS API Documentation
|
|
1652
|
+
#
|
|
1653
|
+
class GetDeliverabilityDashboardOptionsRequest < Aws::EmptyStructure; end
|
|
1654
|
+
|
|
1655
|
+
# An object that shows the status of the Deliverability dashboard.
|
|
1656
|
+
#
|
|
1657
|
+
# @!attribute [rw] dashboard_enabled
|
|
1658
|
+
# Specifies whether the Deliverability dashboard is enabled. If this
|
|
1659
|
+
# value is `true`, the dashboard is enabled.
|
|
1660
|
+
# @return [Boolean]
|
|
1661
|
+
#
|
|
1662
|
+
# @!attribute [rw] subscription_expiry_date
|
|
1663
|
+
# The date, in Unix time format, when your current subscription to the
|
|
1664
|
+
# Deliverability dashboard is scheduled to expire, if your
|
|
1665
|
+
# subscription is scheduled to expire at the end of the current
|
|
1666
|
+
# calendar month. This value is null if you have an active
|
|
1667
|
+
# subscription that isn’t due to expire at the end of the month.
|
|
1668
|
+
# @return [Time]
|
|
1669
|
+
#
|
|
1670
|
+
# @!attribute [rw] account_status
|
|
1671
|
+
# The current status of your Deliverability dashboard subscription. If
|
|
1672
|
+
# this value is `PENDING_EXPIRATION`, your subscription is scheduled
|
|
1673
|
+
# to expire at the end of the current calendar month.
|
|
1674
|
+
# @return [String]
|
|
1675
|
+
#
|
|
1676
|
+
# @!attribute [rw] active_subscribed_domains
|
|
1677
|
+
# An array of objects, one for each verified domain that you use to
|
|
1678
|
+
# send email and currently has an active Deliverability dashboard
|
|
1679
|
+
# subscription that isn’t scheduled to expire at the end of the
|
|
1680
|
+
# current calendar month.
|
|
1681
|
+
# @return [Array<Types::DomainDeliverabilityTrackingOption>]
|
|
1682
|
+
#
|
|
1683
|
+
# @!attribute [rw] pending_expiration_subscribed_domains
|
|
1684
|
+
# An array of objects, one for each verified domain that you use to
|
|
1685
|
+
# send email and currently has an active Deliverability dashboard
|
|
1686
|
+
# subscription that's scheduled to expire at the end of the current
|
|
1687
|
+
# calendar month.
|
|
1688
|
+
# @return [Array<Types::DomainDeliverabilityTrackingOption>]
|
|
1689
|
+
#
|
|
1690
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/GetDeliverabilityDashboardOptionsResponse AWS API Documentation
|
|
1691
|
+
#
|
|
1692
|
+
class GetDeliverabilityDashboardOptionsResponse < Struct.new(
|
|
1693
|
+
:dashboard_enabled,
|
|
1694
|
+
:subscription_expiry_date,
|
|
1695
|
+
:account_status,
|
|
1696
|
+
:active_subscribed_domains,
|
|
1697
|
+
:pending_expiration_subscribed_domains)
|
|
1698
|
+
include Aws::Structure
|
|
1699
|
+
end
|
|
1700
|
+
|
|
1701
|
+
# A request to retrieve the results of a predictive inbox placement
|
|
1702
|
+
# test.
|
|
1703
|
+
#
|
|
1704
|
+
# @note When making an API call, you may pass GetDeliverabilityTestReportRequest
|
|
1705
|
+
# data as a hash:
|
|
1706
|
+
#
|
|
1707
|
+
# {
|
|
1708
|
+
# report_id: "ReportId", # required
|
|
1709
|
+
# }
|
|
1710
|
+
#
|
|
1711
|
+
# @!attribute [rw] report_id
|
|
1712
|
+
# A unique string that identifies the predictive inbox placement test.
|
|
1713
|
+
# @return [String]
|
|
1714
|
+
#
|
|
1715
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/GetDeliverabilityTestReportRequest AWS API Documentation
|
|
1716
|
+
#
|
|
1717
|
+
class GetDeliverabilityTestReportRequest < Struct.new(
|
|
1718
|
+
:report_id)
|
|
1719
|
+
include Aws::Structure
|
|
1720
|
+
end
|
|
1721
|
+
|
|
1722
|
+
# The results of the predictive inbox placement test.
|
|
1723
|
+
#
|
|
1724
|
+
# @!attribute [rw] deliverability_test_report
|
|
1725
|
+
# An object that contains the results of the predictive inbox
|
|
1726
|
+
# placement test.
|
|
1727
|
+
# @return [Types::DeliverabilityTestReport]
|
|
1728
|
+
#
|
|
1729
|
+
# @!attribute [rw] overall_placement
|
|
1730
|
+
# An object that specifies how many test messages that were sent
|
|
1731
|
+
# during the predictive inbox placement test were delivered to
|
|
1732
|
+
# recipients' inboxes, how many were sent to recipients' spam
|
|
1733
|
+
# folders, and how many weren't delivered.
|
|
1734
|
+
# @return [Types::PlacementStatistics]
|
|
1735
|
+
#
|
|
1736
|
+
# @!attribute [rw] isp_placements
|
|
1737
|
+
# An object that describes how the test email was handled by several
|
|
1738
|
+
# email providers, including Gmail, Hotmail, Yahoo, AOL, and others.
|
|
1739
|
+
# @return [Array<Types::IspPlacement>]
|
|
1740
|
+
#
|
|
1741
|
+
# @!attribute [rw] message
|
|
1742
|
+
# An object that contains the message that you sent when you performed
|
|
1743
|
+
# this predictive inbox placement test.
|
|
1744
|
+
# @return [String]
|
|
1745
|
+
#
|
|
1746
|
+
# @!attribute [rw] tags
|
|
1747
|
+
# An array of objects that define the tags (keys and values) that are
|
|
1748
|
+
# associated with the predictive inbox placement test.
|
|
1749
|
+
# @return [Array<Types::Tag>]
|
|
1750
|
+
#
|
|
1751
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/GetDeliverabilityTestReportResponse AWS API Documentation
|
|
1752
|
+
#
|
|
1753
|
+
class GetDeliverabilityTestReportResponse < Struct.new(
|
|
1754
|
+
:deliverability_test_report,
|
|
1755
|
+
:overall_placement,
|
|
1756
|
+
:isp_placements,
|
|
1757
|
+
:message,
|
|
1758
|
+
:tags)
|
|
1759
|
+
include Aws::Structure
|
|
1760
|
+
end
|
|
1761
|
+
|
|
1762
|
+
# Retrieve all the deliverability data for a specific campaign. This
|
|
1763
|
+
# data is available for a campaign only if the campaign sent email by
|
|
1764
|
+
# using a domain that the Deliverability dashboard is enabled for
|
|
1765
|
+
# (`PutDeliverabilityDashboardOption` operation).
|
|
1766
|
+
#
|
|
1767
|
+
# @note When making an API call, you may pass GetDomainDeliverabilityCampaignRequest
|
|
1768
|
+
# data as a hash:
|
|
1769
|
+
#
|
|
1770
|
+
# {
|
|
1771
|
+
# campaign_id: "CampaignId", # required
|
|
1772
|
+
# }
|
|
1773
|
+
#
|
|
1774
|
+
# @!attribute [rw] campaign_id
|
|
1775
|
+
# The unique identifier for the campaign. The Deliverability dashboard
|
|
1776
|
+
# automatically generates and assigns this identifier to a campaign.
|
|
1777
|
+
# @return [String]
|
|
1778
|
+
#
|
|
1779
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/GetDomainDeliverabilityCampaignRequest AWS API Documentation
|
|
1780
|
+
#
|
|
1781
|
+
class GetDomainDeliverabilityCampaignRequest < Struct.new(
|
|
1782
|
+
:campaign_id)
|
|
1783
|
+
include Aws::Structure
|
|
1784
|
+
end
|
|
1785
|
+
|
|
1786
|
+
# An object that contains all the deliverability data for a specific
|
|
1787
|
+
# campaign. This data is available for a campaign only if the campaign
|
|
1788
|
+
# sent email by using a domain that the Deliverability dashboard is
|
|
1789
|
+
# enabled for.
|
|
1790
|
+
#
|
|
1791
|
+
# @!attribute [rw] domain_deliverability_campaign
|
|
1792
|
+
# An object that contains the deliverability data for the campaign.
|
|
1793
|
+
# @return [Types::DomainDeliverabilityCampaign]
|
|
1794
|
+
#
|
|
1795
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/GetDomainDeliverabilityCampaignResponse AWS API Documentation
|
|
1796
|
+
#
|
|
1797
|
+
class GetDomainDeliverabilityCampaignResponse < Struct.new(
|
|
1798
|
+
:domain_deliverability_campaign)
|
|
1799
|
+
include Aws::Structure
|
|
1800
|
+
end
|
|
1801
|
+
|
|
1802
|
+
# A request to obtain deliverability metrics for a domain.
|
|
1803
|
+
#
|
|
1804
|
+
# @note When making an API call, you may pass GetDomainStatisticsReportRequest
|
|
1805
|
+
# data as a hash:
|
|
1806
|
+
#
|
|
1807
|
+
# {
|
|
1808
|
+
# domain: "Identity", # required
|
|
1809
|
+
# start_date: Time.now, # required
|
|
1810
|
+
# end_date: Time.now, # required
|
|
1811
|
+
# }
|
|
1812
|
+
#
|
|
1813
|
+
# @!attribute [rw] domain
|
|
1814
|
+
# The domain that you want to obtain deliverability metrics for.
|
|
1815
|
+
# @return [String]
|
|
1816
|
+
#
|
|
1817
|
+
# @!attribute [rw] start_date
|
|
1818
|
+
# The first day (in Unix time) that you want to obtain domain
|
|
1819
|
+
# deliverability metrics for.
|
|
1820
|
+
# @return [Time]
|
|
1821
|
+
#
|
|
1822
|
+
# @!attribute [rw] end_date
|
|
1823
|
+
# The last day (in Unix time) that you want to obtain domain
|
|
1824
|
+
# deliverability metrics for. The `EndDate` that you specify has to be
|
|
1825
|
+
# less than or equal to 30 days after the `StartDate`.
|
|
1826
|
+
# @return [Time]
|
|
1827
|
+
#
|
|
1828
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/GetDomainStatisticsReportRequest AWS API Documentation
|
|
1829
|
+
#
|
|
1830
|
+
class GetDomainStatisticsReportRequest < Struct.new(
|
|
1831
|
+
:domain,
|
|
1832
|
+
:start_date,
|
|
1833
|
+
:end_date)
|
|
1834
|
+
include Aws::Structure
|
|
1835
|
+
end
|
|
1836
|
+
|
|
1837
|
+
# An object that includes statistics that are related to the domain that
|
|
1838
|
+
# you specified.
|
|
1839
|
+
#
|
|
1840
|
+
# @!attribute [rw] overall_volume
|
|
1841
|
+
# An object that contains deliverability metrics for the domain that
|
|
1842
|
+
# you specified. The data in this object is a summary of all of the
|
|
1843
|
+
# data that was collected from the `StartDate` to the `EndDate`.
|
|
1844
|
+
# @return [Types::OverallVolume]
|
|
1845
|
+
#
|
|
1846
|
+
# @!attribute [rw] daily_volumes
|
|
1847
|
+
# An object that contains deliverability metrics for the domain that
|
|
1848
|
+
# you specified. This object contains data for each day, starting on
|
|
1849
|
+
# the `StartDate` and ending on the `EndDate`.
|
|
1850
|
+
# @return [Array<Types::DailyVolume>]
|
|
1851
|
+
#
|
|
1852
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/GetDomainStatisticsReportResponse AWS API Documentation
|
|
1853
|
+
#
|
|
1854
|
+
class GetDomainStatisticsReportResponse < Struct.new(
|
|
1855
|
+
:overall_volume,
|
|
1856
|
+
:daily_volumes)
|
|
1857
|
+
include Aws::Structure
|
|
1858
|
+
end
|
|
1859
|
+
|
|
1860
|
+
# A request to return details about an email identity.
|
|
1861
|
+
#
|
|
1862
|
+
# @note When making an API call, you may pass GetEmailIdentityRequest
|
|
1863
|
+
# data as a hash:
|
|
1864
|
+
#
|
|
1865
|
+
# {
|
|
1866
|
+
# email_identity: "Identity", # required
|
|
1867
|
+
# }
|
|
1868
|
+
#
|
|
1869
|
+
# @!attribute [rw] email_identity
|
|
1870
|
+
# The email identity that you want to retrieve details for.
|
|
1871
|
+
# @return [String]
|
|
1872
|
+
#
|
|
1873
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/GetEmailIdentityRequest AWS API Documentation
|
|
1874
|
+
#
|
|
1875
|
+
class GetEmailIdentityRequest < Struct.new(
|
|
1876
|
+
:email_identity)
|
|
1877
|
+
include Aws::Structure
|
|
1878
|
+
end
|
|
1879
|
+
|
|
1880
|
+
# Details about an email identity.
|
|
1881
|
+
#
|
|
1882
|
+
# @!attribute [rw] identity_type
|
|
1883
|
+
# The email identity type.
|
|
1884
|
+
# @return [String]
|
|
1885
|
+
#
|
|
1886
|
+
# @!attribute [rw] feedback_forwarding_status
|
|
1887
|
+
# The feedback forwarding configuration for the identity.
|
|
1888
|
+
#
|
|
1889
|
+
# If the value is `true`, you receive email notifications when bounce
|
|
1890
|
+
# or complaint events occur. These notifications are sent to the
|
|
1891
|
+
# address that you specified in the `Return-Path` header of the
|
|
1892
|
+
# original email.
|
|
1893
|
+
#
|
|
1894
|
+
# You're required to have a method of tracking bounces and
|
|
1895
|
+
# complaints. If you haven't set up another mechanism for receiving
|
|
1896
|
+
# bounce or complaint notifications (for example, by setting up an
|
|
1897
|
+
# event destination), you receive an email notification when these
|
|
1898
|
+
# events occur (even if this setting is disabled).
|
|
1899
|
+
# @return [Boolean]
|
|
1900
|
+
#
|
|
1901
|
+
# @!attribute [rw] verified_for_sending_status
|
|
1902
|
+
# Specifies whether or not the identity is verified. You can only send
|
|
1903
|
+
# email from verified email addresses or domains. For more information
|
|
1904
|
+
# about verifying identities, see the [Amazon Pinpoint User Guide][1].
|
|
1905
|
+
#
|
|
1906
|
+
#
|
|
1907
|
+
#
|
|
1908
|
+
# [1]: https://docs.aws.amazon.com/pinpoint/latest/userguide/channels-email-manage-verify.html
|
|
1909
|
+
# @return [Boolean]
|
|
1910
|
+
#
|
|
1911
|
+
# @!attribute [rw] dkim_attributes
|
|
1912
|
+
# An object that contains information about the DKIM attributes for
|
|
1913
|
+
# the identity. This object includes the tokens that you use to create
|
|
1914
|
+
# the CNAME records that are required to complete the DKIM
|
|
1915
|
+
# verification process.
|
|
1916
|
+
# @return [Types::DkimAttributes]
|
|
1917
|
+
#
|
|
1918
|
+
# @!attribute [rw] mail_from_attributes
|
|
1919
|
+
# An object that contains information about the Mail-From attributes
|
|
1920
|
+
# for the email identity.
|
|
1921
|
+
# @return [Types::MailFromAttributes]
|
|
1922
|
+
#
|
|
1923
|
+
# @!attribute [rw] tags
|
|
1924
|
+
# An array of objects that define the tags (keys and values) that are
|
|
1925
|
+
# associated with the email identity.
|
|
1926
|
+
# @return [Array<Types::Tag>]
|
|
1927
|
+
#
|
|
1928
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/GetEmailIdentityResponse AWS API Documentation
|
|
1929
|
+
#
|
|
1930
|
+
class GetEmailIdentityResponse < Struct.new(
|
|
1931
|
+
:identity_type,
|
|
1932
|
+
:feedback_forwarding_status,
|
|
1933
|
+
:verified_for_sending_status,
|
|
1934
|
+
:dkim_attributes,
|
|
1935
|
+
:mail_from_attributes,
|
|
1936
|
+
:tags)
|
|
1937
|
+
include Aws::Structure
|
|
1938
|
+
end
|
|
1939
|
+
|
|
1940
|
+
# Information about an email identity.
|
|
1941
|
+
#
|
|
1942
|
+
# @!attribute [rw] identity_type
|
|
1943
|
+
# The email identity type. The identity type can be one of the
|
|
1944
|
+
# following:
|
|
1945
|
+
#
|
|
1946
|
+
# * `EMAIL_ADDRESS` – The identity is an email address.
|
|
1947
|
+
#
|
|
1948
|
+
# * `DOMAIN` – The identity is a domain.
|
|
1949
|
+
#
|
|
1950
|
+
# * `MANAGED_DOMAIN` – The identity is a domain that is managed by
|
|
1951
|
+
# AWS.
|
|
1952
|
+
# @return [String]
|
|
1953
|
+
#
|
|
1954
|
+
# @!attribute [rw] identity_name
|
|
1955
|
+
# The address or domain of the identity.
|
|
1956
|
+
# @return [String]
|
|
1957
|
+
#
|
|
1958
|
+
# @!attribute [rw] sending_enabled
|
|
1959
|
+
# Indicates whether or not you can send email from the identity.
|
|
1960
|
+
#
|
|
1961
|
+
# An *identity* is an email address or domain that you send email
|
|
1962
|
+
# from. Before you can send email from an identity, you have to
|
|
1963
|
+
# demostrate that you own the identity, and that you authorize Amazon
|
|
1964
|
+
# SES to send email from that identity.
|
|
1965
|
+
# @return [Boolean]
|
|
1966
|
+
#
|
|
1967
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/IdentityInfo AWS API Documentation
|
|
1968
|
+
#
|
|
1969
|
+
class IdentityInfo < Struct.new(
|
|
1970
|
+
:identity_type,
|
|
1971
|
+
:identity_name,
|
|
1972
|
+
:sending_enabled)
|
|
1973
|
+
include Aws::Structure
|
|
1974
|
+
end
|
|
1975
|
+
|
|
1976
|
+
# An object that contains information about the inbox placement data
|
|
1977
|
+
# settings for a verified domain that’s associated with your AWS
|
|
1978
|
+
# account. This data is available only if you enabled the Deliverability
|
|
1979
|
+
# dashboard for the domain.
|
|
1980
|
+
#
|
|
1981
|
+
# @note When making an API call, you may pass InboxPlacementTrackingOption
|
|
1982
|
+
# data as a hash:
|
|
1983
|
+
#
|
|
1984
|
+
# {
|
|
1985
|
+
# global: false,
|
|
1986
|
+
# tracked_isps: ["IspName"],
|
|
1987
|
+
# }
|
|
1988
|
+
#
|
|
1989
|
+
# @!attribute [rw] global
|
|
1990
|
+
# Specifies whether inbox placement data is being tracked for the
|
|
1991
|
+
# domain.
|
|
1992
|
+
# @return [Boolean]
|
|
1993
|
+
#
|
|
1994
|
+
# @!attribute [rw] tracked_isps
|
|
1995
|
+
# An array of strings, one for each major email provider that the
|
|
1996
|
+
# inbox placement data applies to.
|
|
1997
|
+
# @return [Array<String>]
|
|
1998
|
+
#
|
|
1999
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/InboxPlacementTrackingOption AWS API Documentation
|
|
2000
|
+
#
|
|
2001
|
+
class InboxPlacementTrackingOption < Struct.new(
|
|
2002
|
+
:global,
|
|
2003
|
+
:tracked_isps)
|
|
2004
|
+
include Aws::Structure
|
|
2005
|
+
end
|
|
2006
|
+
|
|
2007
|
+
# An object that describes how email sent during the predictive inbox
|
|
2008
|
+
# placement test was handled by a certain email provider.
|
|
2009
|
+
#
|
|
2010
|
+
# @!attribute [rw] isp_name
|
|
2011
|
+
# The name of the email provider that the inbox placement data applies
|
|
2012
|
+
# to.
|
|
2013
|
+
# @return [String]
|
|
2014
|
+
#
|
|
2015
|
+
# @!attribute [rw] placement_statistics
|
|
2016
|
+
# An object that contains inbox placement metrics for a specific email
|
|
2017
|
+
# provider.
|
|
2018
|
+
# @return [Types::PlacementStatistics]
|
|
2019
|
+
#
|
|
2020
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/IspPlacement AWS API Documentation
|
|
2021
|
+
#
|
|
2022
|
+
class IspPlacement < Struct.new(
|
|
2023
|
+
:isp_name,
|
|
2024
|
+
:placement_statistics)
|
|
2025
|
+
include Aws::Structure
|
|
2026
|
+
end
|
|
2027
|
+
|
|
2028
|
+
# An object that defines an Amazon Kinesis Data Firehose destination for
|
|
2029
|
+
# email events. You can use Amazon Kinesis Data Firehose to stream data
|
|
2030
|
+
# to other services, such as Amazon S3 and Amazon Redshift.
|
|
2031
|
+
#
|
|
2032
|
+
# @note When making an API call, you may pass KinesisFirehoseDestination
|
|
2033
|
+
# data as a hash:
|
|
2034
|
+
#
|
|
2035
|
+
# {
|
|
2036
|
+
# iam_role_arn: "AmazonResourceName", # required
|
|
2037
|
+
# delivery_stream_arn: "AmazonResourceName", # required
|
|
2038
|
+
# }
|
|
2039
|
+
#
|
|
2040
|
+
# @!attribute [rw] iam_role_arn
|
|
2041
|
+
# The Amazon Resource Name (ARN) of the IAM role that the Amazon SES
|
|
2042
|
+
# API v2 uses to send email events to the Amazon Kinesis Data Firehose
|
|
2043
|
+
# stream.
|
|
2044
|
+
# @return [String]
|
|
2045
|
+
#
|
|
2046
|
+
# @!attribute [rw] delivery_stream_arn
|
|
2047
|
+
# The Amazon Resource Name (ARN) of the Amazon Kinesis Data Firehose
|
|
2048
|
+
# stream that the Amazon SES API v2 sends email events to.
|
|
2049
|
+
# @return [String]
|
|
2050
|
+
#
|
|
2051
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/KinesisFirehoseDestination AWS API Documentation
|
|
2052
|
+
#
|
|
2053
|
+
class KinesisFirehoseDestination < Struct.new(
|
|
2054
|
+
:iam_role_arn,
|
|
2055
|
+
:delivery_stream_arn)
|
|
2056
|
+
include Aws::Structure
|
|
2057
|
+
end
|
|
2058
|
+
|
|
2059
|
+
# A request to obtain a list of configuration sets for your Amazon SES
|
|
2060
|
+
# account in the current AWS Region.
|
|
2061
|
+
#
|
|
2062
|
+
# @note When making an API call, you may pass ListConfigurationSetsRequest
|
|
2063
|
+
# data as a hash:
|
|
2064
|
+
#
|
|
2065
|
+
# {
|
|
2066
|
+
# next_token: "NextToken",
|
|
2067
|
+
# page_size: 1,
|
|
2068
|
+
# }
|
|
2069
|
+
#
|
|
2070
|
+
# @!attribute [rw] next_token
|
|
2071
|
+
# A token returned from a previous call to `ListConfigurationSets` to
|
|
2072
|
+
# indicate the position in the list of configuration sets.
|
|
2073
|
+
# @return [String]
|
|
2074
|
+
#
|
|
2075
|
+
# @!attribute [rw] page_size
|
|
2076
|
+
# The number of results to show in a single call to
|
|
2077
|
+
# `ListConfigurationSets`. If the number of results is larger than the
|
|
2078
|
+
# number you specified in this parameter, then the response includes a
|
|
2079
|
+
# `NextToken` element, which you can use to obtain additional results.
|
|
2080
|
+
# @return [Integer]
|
|
2081
|
+
#
|
|
2082
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/ListConfigurationSetsRequest AWS API Documentation
|
|
2083
|
+
#
|
|
2084
|
+
class ListConfigurationSetsRequest < Struct.new(
|
|
2085
|
+
:next_token,
|
|
2086
|
+
:page_size)
|
|
2087
|
+
include Aws::Structure
|
|
2088
|
+
end
|
|
2089
|
+
|
|
2090
|
+
# A list of configuration sets in your Amazon SES account in the current
|
|
2091
|
+
# AWS Region.
|
|
2092
|
+
#
|
|
2093
|
+
# @!attribute [rw] configuration_sets
|
|
2094
|
+
# An array that contains all of the configuration sets in your Amazon
|
|
2095
|
+
# SES account in the current AWS Region.
|
|
2096
|
+
# @return [Array<String>]
|
|
2097
|
+
#
|
|
2098
|
+
# @!attribute [rw] next_token
|
|
2099
|
+
# A token that indicates that there are additional configuration sets
|
|
2100
|
+
# to list. To view additional configuration sets, issue another
|
|
2101
|
+
# request to `ListConfigurationSets`, and pass this token in the
|
|
2102
|
+
# `NextToken` parameter.
|
|
2103
|
+
# @return [String]
|
|
2104
|
+
#
|
|
2105
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/ListConfigurationSetsResponse AWS API Documentation
|
|
2106
|
+
#
|
|
2107
|
+
class ListConfigurationSetsResponse < Struct.new(
|
|
2108
|
+
:configuration_sets,
|
|
2109
|
+
:next_token)
|
|
2110
|
+
include Aws::Structure
|
|
2111
|
+
end
|
|
2112
|
+
|
|
2113
|
+
# A request to obtain a list of dedicated IP pools.
|
|
2114
|
+
#
|
|
2115
|
+
# @note When making an API call, you may pass ListDedicatedIpPoolsRequest
|
|
2116
|
+
# data as a hash:
|
|
2117
|
+
#
|
|
2118
|
+
# {
|
|
2119
|
+
# next_token: "NextToken",
|
|
2120
|
+
# page_size: 1,
|
|
2121
|
+
# }
|
|
2122
|
+
#
|
|
2123
|
+
# @!attribute [rw] next_token
|
|
2124
|
+
# A token returned from a previous call to `ListDedicatedIpPools` to
|
|
2125
|
+
# indicate the position in the list of dedicated IP pools.
|
|
2126
|
+
# @return [String]
|
|
2127
|
+
#
|
|
2128
|
+
# @!attribute [rw] page_size
|
|
2129
|
+
# The number of results to show in a single call to
|
|
2130
|
+
# `ListDedicatedIpPools`. If the number of results is larger than the
|
|
2131
|
+
# number you specified in this parameter, then the response includes a
|
|
2132
|
+
# `NextToken` element, which you can use to obtain additional results.
|
|
2133
|
+
# @return [Integer]
|
|
2134
|
+
#
|
|
2135
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/ListDedicatedIpPoolsRequest AWS API Documentation
|
|
2136
|
+
#
|
|
2137
|
+
class ListDedicatedIpPoolsRequest < Struct.new(
|
|
2138
|
+
:next_token,
|
|
2139
|
+
:page_size)
|
|
2140
|
+
include Aws::Structure
|
|
2141
|
+
end
|
|
2142
|
+
|
|
2143
|
+
# A list of dedicated IP pools.
|
|
2144
|
+
#
|
|
2145
|
+
# @!attribute [rw] dedicated_ip_pools
|
|
2146
|
+
# A list of all of the dedicated IP pools that are associated with
|
|
2147
|
+
# your AWS account in the current Region.
|
|
2148
|
+
# @return [Array<String>]
|
|
2149
|
+
#
|
|
2150
|
+
# @!attribute [rw] next_token
|
|
2151
|
+
# A token that indicates that there are additional IP pools to list.
|
|
2152
|
+
# To view additional IP pools, issue another request to
|
|
2153
|
+
# `ListDedicatedIpPools`, passing this token in the `NextToken`
|
|
2154
|
+
# parameter.
|
|
2155
|
+
# @return [String]
|
|
2156
|
+
#
|
|
2157
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/ListDedicatedIpPoolsResponse AWS API Documentation
|
|
2158
|
+
#
|
|
2159
|
+
class ListDedicatedIpPoolsResponse < Struct.new(
|
|
2160
|
+
:dedicated_ip_pools,
|
|
2161
|
+
:next_token)
|
|
2162
|
+
include Aws::Structure
|
|
2163
|
+
end
|
|
2164
|
+
|
|
2165
|
+
# A request to list all of the predictive inbox placement tests that
|
|
2166
|
+
# you've performed.
|
|
2167
|
+
#
|
|
2168
|
+
# @note When making an API call, you may pass ListDeliverabilityTestReportsRequest
|
|
2169
|
+
# data as a hash:
|
|
2170
|
+
#
|
|
2171
|
+
# {
|
|
2172
|
+
# next_token: "NextToken",
|
|
2173
|
+
# page_size: 1,
|
|
2174
|
+
# }
|
|
2175
|
+
#
|
|
2176
|
+
# @!attribute [rw] next_token
|
|
2177
|
+
# A token returned from a previous call to
|
|
2178
|
+
# `ListDeliverabilityTestReports` to indicate the position in the list
|
|
2179
|
+
# of predictive inbox placement tests.
|
|
2180
|
+
# @return [String]
|
|
2181
|
+
#
|
|
2182
|
+
# @!attribute [rw] page_size
|
|
2183
|
+
# The number of results to show in a single call to
|
|
2184
|
+
# `ListDeliverabilityTestReports`. If the number of results is larger
|
|
2185
|
+
# than the number you specified in this parameter, then the response
|
|
2186
|
+
# includes a `NextToken` element, which you can use to obtain
|
|
2187
|
+
# additional results.
|
|
2188
|
+
#
|
|
2189
|
+
# The value you specify has to be at least 0, and can be no more than
|
|
2190
|
+
# 1000.
|
|
2191
|
+
# @return [Integer]
|
|
2192
|
+
#
|
|
2193
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/ListDeliverabilityTestReportsRequest AWS API Documentation
|
|
2194
|
+
#
|
|
2195
|
+
class ListDeliverabilityTestReportsRequest < Struct.new(
|
|
2196
|
+
:next_token,
|
|
2197
|
+
:page_size)
|
|
2198
|
+
include Aws::Structure
|
|
2199
|
+
end
|
|
2200
|
+
|
|
2201
|
+
# A list of the predictive inbox placement test reports that are
|
|
2202
|
+
# available for your account, regardless of whether or not those tests
|
|
2203
|
+
# are complete.
|
|
2204
|
+
#
|
|
2205
|
+
# @!attribute [rw] deliverability_test_reports
|
|
2206
|
+
# An object that contains a lists of predictive inbox placement tests
|
|
2207
|
+
# that you've performed.
|
|
2208
|
+
# @return [Array<Types::DeliverabilityTestReport>]
|
|
2209
|
+
#
|
|
2210
|
+
# @!attribute [rw] next_token
|
|
2211
|
+
# A token that indicates that there are additional predictive inbox
|
|
2212
|
+
# placement tests to list. To view additional predictive inbox
|
|
2213
|
+
# placement tests, issue another request to
|
|
2214
|
+
# `ListDeliverabilityTestReports`, and pass this token in the
|
|
2215
|
+
# `NextToken` parameter.
|
|
2216
|
+
# @return [String]
|
|
2217
|
+
#
|
|
2218
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/ListDeliverabilityTestReportsResponse AWS API Documentation
|
|
2219
|
+
#
|
|
2220
|
+
class ListDeliverabilityTestReportsResponse < Struct.new(
|
|
2221
|
+
:deliverability_test_reports,
|
|
2222
|
+
:next_token)
|
|
2223
|
+
include Aws::Structure
|
|
2224
|
+
end
|
|
2225
|
+
|
|
2226
|
+
# Retrieve deliverability data for all the campaigns that used a
|
|
2227
|
+
# specific domain to send email during a specified time range. This data
|
|
2228
|
+
# is available for a domain only if you enabled the Deliverability
|
|
2229
|
+
# dashboard.
|
|
2230
|
+
#
|
|
2231
|
+
# @note When making an API call, you may pass ListDomainDeliverabilityCampaignsRequest
|
|
2232
|
+
# data as a hash:
|
|
2233
|
+
#
|
|
2234
|
+
# {
|
|
2235
|
+
# start_date: Time.now, # required
|
|
2236
|
+
# end_date: Time.now, # required
|
|
2237
|
+
# subscribed_domain: "Domain", # required
|
|
2238
|
+
# next_token: "NextToken",
|
|
2239
|
+
# page_size: 1,
|
|
2240
|
+
# }
|
|
2241
|
+
#
|
|
2242
|
+
# @!attribute [rw] start_date
|
|
2243
|
+
# The first day, in Unix time format, that you want to obtain
|
|
2244
|
+
# deliverability data for.
|
|
2245
|
+
# @return [Time]
|
|
2246
|
+
#
|
|
2247
|
+
# @!attribute [rw] end_date
|
|
2248
|
+
# The last day, in Unix time format, that you want to obtain
|
|
2249
|
+
# deliverability data for. This value has to be less than or equal to
|
|
2250
|
+
# 30 days after the value of the `StartDate` parameter.
|
|
2251
|
+
# @return [Time]
|
|
2252
|
+
#
|
|
2253
|
+
# @!attribute [rw] subscribed_domain
|
|
2254
|
+
# The domain to obtain deliverability data for.
|
|
2255
|
+
# @return [String]
|
|
2256
|
+
#
|
|
2257
|
+
# @!attribute [rw] next_token
|
|
2258
|
+
# A token that’s returned from a previous call to the
|
|
2259
|
+
# `ListDomainDeliverabilityCampaigns` operation. This token indicates
|
|
2260
|
+
# the position of a campaign in the list of campaigns.
|
|
2261
|
+
# @return [String]
|
|
2262
|
+
#
|
|
2263
|
+
# @!attribute [rw] page_size
|
|
2264
|
+
# The maximum number of results to include in response to a single
|
|
2265
|
+
# call to the `ListDomainDeliverabilityCampaigns` operation. If the
|
|
2266
|
+
# number of results is larger than the number that you specify in this
|
|
2267
|
+
# parameter, the response includes a `NextToken` element, which you
|
|
2268
|
+
# can use to obtain additional results.
|
|
2269
|
+
# @return [Integer]
|
|
2270
|
+
#
|
|
2271
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/ListDomainDeliverabilityCampaignsRequest AWS API Documentation
|
|
2272
|
+
#
|
|
2273
|
+
class ListDomainDeliverabilityCampaignsRequest < Struct.new(
|
|
2274
|
+
:start_date,
|
|
2275
|
+
:end_date,
|
|
2276
|
+
:subscribed_domain,
|
|
2277
|
+
:next_token,
|
|
2278
|
+
:page_size)
|
|
2279
|
+
include Aws::Structure
|
|
2280
|
+
end
|
|
2281
|
+
|
|
2282
|
+
# An array of objects that provide deliverability data for all the
|
|
2283
|
+
# campaigns that used a specific domain to send email during a specified
|
|
2284
|
+
# time range. This data is available for a domain only if you enabled
|
|
2285
|
+
# the Deliverability dashboard for the domain.
|
|
2286
|
+
#
|
|
2287
|
+
# @!attribute [rw] domain_deliverability_campaigns
|
|
2288
|
+
# An array of responses, one for each campaign that used the domain to
|
|
2289
|
+
# send email during the specified time range.
|
|
2290
|
+
# @return [Array<Types::DomainDeliverabilityCampaign>]
|
|
2291
|
+
#
|
|
2292
|
+
# @!attribute [rw] next_token
|
|
2293
|
+
# A token that’s returned from a previous call to the
|
|
2294
|
+
# `ListDomainDeliverabilityCampaigns` operation. This token indicates
|
|
2295
|
+
# the position of the campaign in the list of campaigns.
|
|
2296
|
+
# @return [String]
|
|
2297
|
+
#
|
|
2298
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/ListDomainDeliverabilityCampaignsResponse AWS API Documentation
|
|
2299
|
+
#
|
|
2300
|
+
class ListDomainDeliverabilityCampaignsResponse < Struct.new(
|
|
2301
|
+
:domain_deliverability_campaigns,
|
|
2302
|
+
:next_token)
|
|
2303
|
+
include Aws::Structure
|
|
2304
|
+
end
|
|
2305
|
+
|
|
2306
|
+
# A request to list all of the email identities associated with your AWS
|
|
2307
|
+
# account. This list includes identities that you've already verified,
|
|
2308
|
+
# identities that are unverified, and identities that were verified in
|
|
2309
|
+
# the past, but are no longer verified.
|
|
2310
|
+
#
|
|
2311
|
+
# @note When making an API call, you may pass ListEmailIdentitiesRequest
|
|
2312
|
+
# data as a hash:
|
|
2313
|
+
#
|
|
2314
|
+
# {
|
|
2315
|
+
# next_token: "NextToken",
|
|
2316
|
+
# page_size: 1,
|
|
2317
|
+
# }
|
|
2318
|
+
#
|
|
2319
|
+
# @!attribute [rw] next_token
|
|
2320
|
+
# A token returned from a previous call to `ListEmailIdentities` to
|
|
2321
|
+
# indicate the position in the list of identities.
|
|
2322
|
+
# @return [String]
|
|
2323
|
+
#
|
|
2324
|
+
# @!attribute [rw] page_size
|
|
2325
|
+
# The number of results to show in a single call to
|
|
2326
|
+
# `ListEmailIdentities`. If the number of results is larger than the
|
|
2327
|
+
# number you specified in this parameter, then the response includes a
|
|
2328
|
+
# `NextToken` element, which you can use to obtain additional results.
|
|
2329
|
+
#
|
|
2330
|
+
# The value you specify has to be at least 0, and can be no more than
|
|
2331
|
+
# 1000.
|
|
2332
|
+
# @return [Integer]
|
|
2333
|
+
#
|
|
2334
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/ListEmailIdentitiesRequest AWS API Documentation
|
|
2335
|
+
#
|
|
2336
|
+
class ListEmailIdentitiesRequest < Struct.new(
|
|
2337
|
+
:next_token,
|
|
2338
|
+
:page_size)
|
|
2339
|
+
include Aws::Structure
|
|
2340
|
+
end
|
|
2341
|
+
|
|
2342
|
+
# A list of all of the identities that you've attempted to verify,
|
|
2343
|
+
# regardless of whether or not those identities were successfully
|
|
2344
|
+
# verified.
|
|
2345
|
+
#
|
|
2346
|
+
# @!attribute [rw] email_identities
|
|
2347
|
+
# An array that includes all of the email identities associated with
|
|
2348
|
+
# your AWS account.
|
|
2349
|
+
# @return [Array<Types::IdentityInfo>]
|
|
2350
|
+
#
|
|
2351
|
+
# @!attribute [rw] next_token
|
|
2352
|
+
# A token that indicates that there are additional configuration sets
|
|
2353
|
+
# to list. To view additional configuration sets, issue another
|
|
2354
|
+
# request to `ListEmailIdentities`, and pass this token in the
|
|
2355
|
+
# `NextToken` parameter.
|
|
2356
|
+
# @return [String]
|
|
2357
|
+
#
|
|
2358
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/ListEmailIdentitiesResponse AWS API Documentation
|
|
2359
|
+
#
|
|
2360
|
+
class ListEmailIdentitiesResponse < Struct.new(
|
|
2361
|
+
:email_identities,
|
|
2362
|
+
:next_token)
|
|
2363
|
+
include Aws::Structure
|
|
2364
|
+
end
|
|
2365
|
+
|
|
2366
|
+
# @note When making an API call, you may pass ListTagsForResourceRequest
|
|
2367
|
+
# data as a hash:
|
|
2368
|
+
#
|
|
2369
|
+
# {
|
|
2370
|
+
# resource_arn: "AmazonResourceName", # required
|
|
2371
|
+
# }
|
|
2372
|
+
#
|
|
2373
|
+
# @!attribute [rw] resource_arn
|
|
2374
|
+
# The Amazon Resource Name (ARN) of the resource that you want to
|
|
2375
|
+
# retrieve tag information for.
|
|
2376
|
+
# @return [String]
|
|
2377
|
+
#
|
|
2378
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/ListTagsForResourceRequest AWS API Documentation
|
|
2379
|
+
#
|
|
2380
|
+
class ListTagsForResourceRequest < Struct.new(
|
|
2381
|
+
:resource_arn)
|
|
2382
|
+
include Aws::Structure
|
|
2383
|
+
end
|
|
2384
|
+
|
|
2385
|
+
# @!attribute [rw] tags
|
|
2386
|
+
# An array that lists all the tags that are associated with the
|
|
2387
|
+
# resource. Each tag consists of a required tag key (`Key`) and an
|
|
2388
|
+
# associated tag value (`Value`)
|
|
2389
|
+
# @return [Array<Types::Tag>]
|
|
2390
|
+
#
|
|
2391
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/ListTagsForResourceResponse AWS API Documentation
|
|
2392
|
+
#
|
|
2393
|
+
class ListTagsForResourceResponse < Struct.new(
|
|
2394
|
+
:tags)
|
|
2395
|
+
include Aws::Structure
|
|
2396
|
+
end
|
|
2397
|
+
|
|
2398
|
+
# A list of attributes that are associated with a MAIL FROM domain.
|
|
2399
|
+
#
|
|
2400
|
+
# @!attribute [rw] mail_from_domain
|
|
2401
|
+
# The name of a domain that an email identity uses as a custom MAIL
|
|
2402
|
+
# FROM domain.
|
|
2403
|
+
# @return [String]
|
|
2404
|
+
#
|
|
2405
|
+
# @!attribute [rw] mail_from_domain_status
|
|
2406
|
+
# The status of the MAIL FROM domain. This status can have the
|
|
2407
|
+
# following values:
|
|
2408
|
+
#
|
|
2409
|
+
# * `PENDING` – Amazon SES hasn't started searching for the MX record
|
|
2410
|
+
# yet.
|
|
2411
|
+
#
|
|
2412
|
+
# * `SUCCESS` – Amazon SES detected the required MX record for the
|
|
2413
|
+
# MAIL FROM domain.
|
|
2414
|
+
#
|
|
2415
|
+
# * `FAILED` – Amazon SES can't find the required MX record, or the
|
|
2416
|
+
# record no longer exists.
|
|
2417
|
+
#
|
|
2418
|
+
# * `TEMPORARY_FAILURE` – A temporary issue occurred, which prevented
|
|
2419
|
+
# Amazon SES from determining the status of the MAIL FROM domain.
|
|
2420
|
+
# @return [String]
|
|
2421
|
+
#
|
|
2422
|
+
# @!attribute [rw] behavior_on_mx_failure
|
|
2423
|
+
# The action that you want to take if the required MX record can't be
|
|
2424
|
+
# found when you send an email. When you set this value to
|
|
2425
|
+
# `UseDefaultValue`, the mail is sent using *amazonses.com* as the
|
|
2426
|
+
# MAIL FROM domain. When you set this value to `RejectMessage`, the
|
|
2427
|
+
# Amazon SES API v2 returns a `MailFromDomainNotVerified` error, and
|
|
2428
|
+
# doesn't attempt to deliver the email.
|
|
2429
|
+
#
|
|
2430
|
+
# These behaviors are taken when the custom MAIL FROM domain
|
|
2431
|
+
# configuration is in the `Pending`, `Failed`, and `TemporaryFailure`
|
|
2432
|
+
# states.
|
|
2433
|
+
# @return [String]
|
|
2434
|
+
#
|
|
2435
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/MailFromAttributes AWS API Documentation
|
|
2436
|
+
#
|
|
2437
|
+
class MailFromAttributes < Struct.new(
|
|
2438
|
+
:mail_from_domain,
|
|
2439
|
+
:mail_from_domain_status,
|
|
2440
|
+
:behavior_on_mx_failure)
|
|
2441
|
+
include Aws::Structure
|
|
2442
|
+
end
|
|
2443
|
+
|
|
2444
|
+
# Represents the email message that you're sending. The `Message`
|
|
2445
|
+
# object consists of a subject line and a message body.
|
|
2446
|
+
#
|
|
2447
|
+
# @note When making an API call, you may pass Message
|
|
2448
|
+
# data as a hash:
|
|
2449
|
+
#
|
|
2450
|
+
# {
|
|
2451
|
+
# subject: { # required
|
|
2452
|
+
# data: "MessageData", # required
|
|
2453
|
+
# charset: "Charset",
|
|
2454
|
+
# },
|
|
2455
|
+
# body: { # required
|
|
2456
|
+
# text: {
|
|
2457
|
+
# data: "MessageData", # required
|
|
2458
|
+
# charset: "Charset",
|
|
2459
|
+
# },
|
|
2460
|
+
# html: {
|
|
2461
|
+
# data: "MessageData", # required
|
|
2462
|
+
# charset: "Charset",
|
|
2463
|
+
# },
|
|
2464
|
+
# },
|
|
2465
|
+
# }
|
|
2466
|
+
#
|
|
2467
|
+
# @!attribute [rw] subject
|
|
2468
|
+
# The subject line of the email. The subject line can only contain
|
|
2469
|
+
# 7-bit ASCII characters. However, you can specify non-ASCII
|
|
2470
|
+
# characters in the subject line by using encoded-word syntax, as
|
|
2471
|
+
# described in [RFC 2047][1].
|
|
2472
|
+
#
|
|
2473
|
+
#
|
|
2474
|
+
#
|
|
2475
|
+
# [1]: https://tools.ietf.org/html/rfc2047
|
|
2476
|
+
# @return [Types::Content]
|
|
2477
|
+
#
|
|
2478
|
+
# @!attribute [rw] body
|
|
2479
|
+
# The body of the message. You can specify an HTML version of the
|
|
2480
|
+
# message, a text-only version of the message, or both.
|
|
2481
|
+
# @return [Types::Body]
|
|
2482
|
+
#
|
|
2483
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/Message AWS API Documentation
|
|
2484
|
+
#
|
|
2485
|
+
class Message < Struct.new(
|
|
2486
|
+
:subject,
|
|
2487
|
+
:body)
|
|
2488
|
+
include Aws::Structure
|
|
2489
|
+
end
|
|
2490
|
+
|
|
2491
|
+
# Contains the name and value of a tag that you apply to an email. You
|
|
2492
|
+
# can use message tags when you publish email sending events.
|
|
2493
|
+
#
|
|
2494
|
+
# @note When making an API call, you may pass MessageTag
|
|
2495
|
+
# data as a hash:
|
|
2496
|
+
#
|
|
2497
|
+
# {
|
|
2498
|
+
# name: "MessageTagName", # required
|
|
2499
|
+
# value: "MessageTagValue", # required
|
|
2500
|
+
# }
|
|
2501
|
+
#
|
|
2502
|
+
# @!attribute [rw] name
|
|
2503
|
+
# The name of the message tag. The message tag name has to meet the
|
|
2504
|
+
# following criteria:
|
|
2505
|
+
#
|
|
2506
|
+
# * It can only contain ASCII letters (a–z, A–Z), numbers (0–9),
|
|
2507
|
+
# underscores (\_), or dashes (-).
|
|
2508
|
+
#
|
|
2509
|
+
# * It can contain no more than 256 characters.
|
|
2510
|
+
# @return [String]
|
|
2511
|
+
#
|
|
2512
|
+
# @!attribute [rw] value
|
|
2513
|
+
# The value of the message tag. The message tag value has to meet the
|
|
2514
|
+
# following criteria:
|
|
2515
|
+
#
|
|
2516
|
+
# * It can only contain ASCII letters (a–z, A–Z), numbers (0–9),
|
|
2517
|
+
# underscores (\_), or dashes (-).
|
|
2518
|
+
#
|
|
2519
|
+
# * It can contain no more than 256 characters.
|
|
2520
|
+
# @return [String]
|
|
2521
|
+
#
|
|
2522
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/MessageTag AWS API Documentation
|
|
2523
|
+
#
|
|
2524
|
+
class MessageTag < Struct.new(
|
|
2525
|
+
:name,
|
|
2526
|
+
:value)
|
|
2527
|
+
include Aws::Structure
|
|
2528
|
+
end
|
|
2529
|
+
|
|
2530
|
+
# An object that contains information about email that was sent from the
|
|
2531
|
+
# selected domain.
|
|
2532
|
+
#
|
|
2533
|
+
# @!attribute [rw] volume_statistics
|
|
2534
|
+
# An object that contains information about the numbers of messages
|
|
2535
|
+
# that arrived in recipients' inboxes and junk mail folders.
|
|
2536
|
+
# @return [Types::VolumeStatistics]
|
|
2537
|
+
#
|
|
2538
|
+
# @!attribute [rw] read_rate_percent
|
|
2539
|
+
# The percentage of emails that were sent from the domain that were
|
|
2540
|
+
# read by their recipients.
|
|
2541
|
+
# @return [Float]
|
|
2542
|
+
#
|
|
2543
|
+
# @!attribute [rw] domain_isp_placements
|
|
2544
|
+
# An object that contains inbox and junk mail placement metrics for
|
|
2545
|
+
# individual email providers.
|
|
2546
|
+
# @return [Array<Types::DomainIspPlacement>]
|
|
2547
|
+
#
|
|
2548
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/OverallVolume AWS API Documentation
|
|
2549
|
+
#
|
|
2550
|
+
class OverallVolume < Struct.new(
|
|
2551
|
+
:volume_statistics,
|
|
2552
|
+
:read_rate_percent,
|
|
2553
|
+
:domain_isp_placements)
|
|
2554
|
+
include Aws::Structure
|
|
2555
|
+
end
|
|
2556
|
+
|
|
2557
|
+
# An object that defines an Amazon Pinpoint project destination for
|
|
2558
|
+
# email events. You can send email event data to a Amazon Pinpoint
|
|
2559
|
+
# project to view metrics using the Transactional Messaging dashboards
|
|
2560
|
+
# that are built in to Amazon Pinpoint. For more information, see
|
|
2561
|
+
# [Transactional Messaging Charts][1] in the *Amazon Pinpoint User
|
|
2562
|
+
# Guide*.
|
|
2563
|
+
#
|
|
2564
|
+
#
|
|
2565
|
+
#
|
|
2566
|
+
# [1]: https://docs.aws.amazon.com/pinpoint/latest/userguide/analytics-transactional-messages.html
|
|
2567
|
+
#
|
|
2568
|
+
# @note When making an API call, you may pass PinpointDestination
|
|
2569
|
+
# data as a hash:
|
|
2570
|
+
#
|
|
2571
|
+
# {
|
|
2572
|
+
# application_arn: "AmazonResourceName",
|
|
2573
|
+
# }
|
|
2574
|
+
#
|
|
2575
|
+
# @!attribute [rw] application_arn
|
|
2576
|
+
# The Amazon Resource Name (ARN) of the Amazon Pinpoint project that
|
|
2577
|
+
# you want to send email events to.
|
|
2578
|
+
# @return [String]
|
|
2579
|
+
#
|
|
2580
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/PinpointDestination AWS API Documentation
|
|
2581
|
+
#
|
|
2582
|
+
class PinpointDestination < Struct.new(
|
|
2583
|
+
:application_arn)
|
|
2584
|
+
include Aws::Structure
|
|
2585
|
+
end
|
|
2586
|
+
|
|
2587
|
+
# An object that contains inbox placement data for an email provider.
|
|
2588
|
+
#
|
|
2589
|
+
# @!attribute [rw] inbox_percentage
|
|
2590
|
+
# The percentage of emails that arrived in recipients' inboxes during
|
|
2591
|
+
# the predictive inbox placement test.
|
|
2592
|
+
# @return [Float]
|
|
2593
|
+
#
|
|
2594
|
+
# @!attribute [rw] spam_percentage
|
|
2595
|
+
# The percentage of emails that arrived in recipients' spam or junk
|
|
2596
|
+
# mail folders during the predictive inbox placement test.
|
|
2597
|
+
# @return [Float]
|
|
2598
|
+
#
|
|
2599
|
+
# @!attribute [rw] missing_percentage
|
|
2600
|
+
# The percentage of emails that didn't arrive in recipients' inboxes
|
|
2601
|
+
# at all during the predictive inbox placement test.
|
|
2602
|
+
# @return [Float]
|
|
2603
|
+
#
|
|
2604
|
+
# @!attribute [rw] spf_percentage
|
|
2605
|
+
# The percentage of emails that were authenticated by using Sender
|
|
2606
|
+
# Policy Framework (SPF) during the predictive inbox placement test.
|
|
2607
|
+
# @return [Float]
|
|
2608
|
+
#
|
|
2609
|
+
# @!attribute [rw] dkim_percentage
|
|
2610
|
+
# The percentage of emails that were authenticated by using DomainKeys
|
|
2611
|
+
# Identified Mail (DKIM) during the predictive inbox placement test.
|
|
2612
|
+
# @return [Float]
|
|
2613
|
+
#
|
|
2614
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/PlacementStatistics AWS API Documentation
|
|
2615
|
+
#
|
|
2616
|
+
class PlacementStatistics < Struct.new(
|
|
2617
|
+
:inbox_percentage,
|
|
2618
|
+
:spam_percentage,
|
|
2619
|
+
:missing_percentage,
|
|
2620
|
+
:spf_percentage,
|
|
2621
|
+
:dkim_percentage)
|
|
2622
|
+
include Aws::Structure
|
|
2623
|
+
end
|
|
2624
|
+
|
|
2625
|
+
# A request to enable or disable the automatic IP address warm-up
|
|
2626
|
+
# feature.
|
|
2627
|
+
#
|
|
2628
|
+
# @note When making an API call, you may pass PutAccountDedicatedIpWarmupAttributesRequest
|
|
2629
|
+
# data as a hash:
|
|
2630
|
+
#
|
|
2631
|
+
# {
|
|
2632
|
+
# auto_warmup_enabled: false,
|
|
2633
|
+
# }
|
|
2634
|
+
#
|
|
2635
|
+
# @!attribute [rw] auto_warmup_enabled
|
|
2636
|
+
# Enables or disables the automatic warm-up feature for dedicated IP
|
|
2637
|
+
# addresses that are associated with your Amazon SES account in the
|
|
2638
|
+
# current AWS Region. Set to `true` to enable the automatic warm-up
|
|
2639
|
+
# feature, or set to `false` to disable it.
|
|
2640
|
+
# @return [Boolean]
|
|
2641
|
+
#
|
|
2642
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/PutAccountDedicatedIpWarmupAttributesRequest AWS API Documentation
|
|
2643
|
+
#
|
|
2644
|
+
class PutAccountDedicatedIpWarmupAttributesRequest < Struct.new(
|
|
2645
|
+
:auto_warmup_enabled)
|
|
2646
|
+
include Aws::Structure
|
|
2647
|
+
end
|
|
2648
|
+
|
|
2649
|
+
# An HTTP 200 response if the request succeeds, or an error message if
|
|
2650
|
+
# the request fails.
|
|
2651
|
+
#
|
|
2652
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/PutAccountDedicatedIpWarmupAttributesResponse AWS API Documentation
|
|
2653
|
+
#
|
|
2654
|
+
class PutAccountDedicatedIpWarmupAttributesResponse < Aws::EmptyStructure; end
|
|
2655
|
+
|
|
2656
|
+
# A request to change the ability of your account to send email.
|
|
2657
|
+
#
|
|
2658
|
+
# @note When making an API call, you may pass PutAccountSendingAttributesRequest
|
|
2659
|
+
# data as a hash:
|
|
2660
|
+
#
|
|
2661
|
+
# {
|
|
2662
|
+
# sending_enabled: false,
|
|
2663
|
+
# }
|
|
2664
|
+
#
|
|
2665
|
+
# @!attribute [rw] sending_enabled
|
|
2666
|
+
# Enables or disables your account's ability to send email. Set to
|
|
2667
|
+
# `true` to enable email sending, or set to `false` to disable email
|
|
2668
|
+
# sending.
|
|
2669
|
+
#
|
|
2670
|
+
# <note markdown="1"> If AWS paused your account's ability to send email, you can't use
|
|
2671
|
+
# this operation to resume your account's ability to send email.
|
|
2672
|
+
#
|
|
2673
|
+
# </note>
|
|
2674
|
+
# @return [Boolean]
|
|
2675
|
+
#
|
|
2676
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/PutAccountSendingAttributesRequest AWS API Documentation
|
|
2677
|
+
#
|
|
2678
|
+
class PutAccountSendingAttributesRequest < Struct.new(
|
|
2679
|
+
:sending_enabled)
|
|
2680
|
+
include Aws::Structure
|
|
2681
|
+
end
|
|
2682
|
+
|
|
2683
|
+
# An HTTP 200 response if the request succeeds, or an error message if
|
|
2684
|
+
# the request fails.
|
|
2685
|
+
#
|
|
2686
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/PutAccountSendingAttributesResponse AWS API Documentation
|
|
2687
|
+
#
|
|
2688
|
+
class PutAccountSendingAttributesResponse < Aws::EmptyStructure; end
|
|
2689
|
+
|
|
2690
|
+
# A request to associate a configuration set with a dedicated IP pool.
|
|
2691
|
+
#
|
|
2692
|
+
# @note When making an API call, you may pass PutConfigurationSetDeliveryOptionsRequest
|
|
2693
|
+
# data as a hash:
|
|
2694
|
+
#
|
|
2695
|
+
# {
|
|
2696
|
+
# configuration_set_name: "ConfigurationSetName", # required
|
|
2697
|
+
# tls_policy: "REQUIRE", # accepts REQUIRE, OPTIONAL
|
|
2698
|
+
# sending_pool_name: "SendingPoolName",
|
|
2699
|
+
# }
|
|
2700
|
+
#
|
|
2701
|
+
# @!attribute [rw] configuration_set_name
|
|
2702
|
+
# The name of the configuration set that you want to associate with a
|
|
2703
|
+
# dedicated IP pool.
|
|
2704
|
+
# @return [String]
|
|
2705
|
+
#
|
|
2706
|
+
# @!attribute [rw] tls_policy
|
|
2707
|
+
# Specifies whether messages that use the configuration set are
|
|
2708
|
+
# required to use Transport Layer Security (TLS). If the value is
|
|
2709
|
+
# `Require`, messages are only delivered if a TLS connection can be
|
|
2710
|
+
# established. If the value is `Optional`, messages can be delivered
|
|
2711
|
+
# in plain text if a TLS connection can't be established.
|
|
2712
|
+
# @return [String]
|
|
2713
|
+
#
|
|
2714
|
+
# @!attribute [rw] sending_pool_name
|
|
2715
|
+
# The name of the dedicated IP pool that you want to associate with
|
|
2716
|
+
# the configuration set.
|
|
2717
|
+
# @return [String]
|
|
2718
|
+
#
|
|
2719
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/PutConfigurationSetDeliveryOptionsRequest AWS API Documentation
|
|
2720
|
+
#
|
|
2721
|
+
class PutConfigurationSetDeliveryOptionsRequest < Struct.new(
|
|
2722
|
+
:configuration_set_name,
|
|
2723
|
+
:tls_policy,
|
|
2724
|
+
:sending_pool_name)
|
|
2725
|
+
include Aws::Structure
|
|
2726
|
+
end
|
|
2727
|
+
|
|
2728
|
+
# An HTTP 200 response if the request succeeds, or an error message if
|
|
2729
|
+
# the request fails.
|
|
2730
|
+
#
|
|
2731
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/PutConfigurationSetDeliveryOptionsResponse AWS API Documentation
|
|
2732
|
+
#
|
|
2733
|
+
class PutConfigurationSetDeliveryOptionsResponse < Aws::EmptyStructure; end
|
|
2734
|
+
|
|
2735
|
+
# A request to enable or disable tracking of reputation metrics for a
|
|
2736
|
+
# configuration set.
|
|
2737
|
+
#
|
|
2738
|
+
# @note When making an API call, you may pass PutConfigurationSetReputationOptionsRequest
|
|
2739
|
+
# data as a hash:
|
|
2740
|
+
#
|
|
2741
|
+
# {
|
|
2742
|
+
# configuration_set_name: "ConfigurationSetName", # required
|
|
2743
|
+
# reputation_metrics_enabled: false,
|
|
2744
|
+
# }
|
|
2745
|
+
#
|
|
2746
|
+
# @!attribute [rw] configuration_set_name
|
|
2747
|
+
# The name of the configuration set that you want to enable or disable
|
|
2748
|
+
# reputation metric tracking for.
|
|
2749
|
+
# @return [String]
|
|
2750
|
+
#
|
|
2751
|
+
# @!attribute [rw] reputation_metrics_enabled
|
|
2752
|
+
# If `true`, tracking of reputation metrics is enabled for the
|
|
2753
|
+
# configuration set. If `false`, tracking of reputation metrics is
|
|
2754
|
+
# disabled for the configuration set.
|
|
2755
|
+
# @return [Boolean]
|
|
2756
|
+
#
|
|
2757
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/PutConfigurationSetReputationOptionsRequest AWS API Documentation
|
|
2758
|
+
#
|
|
2759
|
+
class PutConfigurationSetReputationOptionsRequest < Struct.new(
|
|
2760
|
+
:configuration_set_name,
|
|
2761
|
+
:reputation_metrics_enabled)
|
|
2762
|
+
include Aws::Structure
|
|
2763
|
+
end
|
|
2764
|
+
|
|
2765
|
+
# An HTTP 200 response if the request succeeds, or an error message if
|
|
2766
|
+
# the request fails.
|
|
2767
|
+
#
|
|
2768
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/PutConfigurationSetReputationOptionsResponse AWS API Documentation
|
|
2769
|
+
#
|
|
2770
|
+
class PutConfigurationSetReputationOptionsResponse < Aws::EmptyStructure; end
|
|
2771
|
+
|
|
2772
|
+
# A request to enable or disable the ability of Amazon SES to send
|
|
2773
|
+
# emails that use a specific configuration set.
|
|
2774
|
+
#
|
|
2775
|
+
# @note When making an API call, you may pass PutConfigurationSetSendingOptionsRequest
|
|
2776
|
+
# data as a hash:
|
|
2777
|
+
#
|
|
2778
|
+
# {
|
|
2779
|
+
# configuration_set_name: "ConfigurationSetName", # required
|
|
2780
|
+
# sending_enabled: false,
|
|
2781
|
+
# }
|
|
2782
|
+
#
|
|
2783
|
+
# @!attribute [rw] configuration_set_name
|
|
2784
|
+
# The name of the configuration set that you want to enable or disable
|
|
2785
|
+
# email sending for.
|
|
2786
|
+
# @return [String]
|
|
2787
|
+
#
|
|
2788
|
+
# @!attribute [rw] sending_enabled
|
|
2789
|
+
# If `true`, email sending is enabled for the configuration set. If
|
|
2790
|
+
# `false`, email sending is disabled for the configuration set.
|
|
2791
|
+
# @return [Boolean]
|
|
2792
|
+
#
|
|
2793
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/PutConfigurationSetSendingOptionsRequest AWS API Documentation
|
|
2794
|
+
#
|
|
2795
|
+
class PutConfigurationSetSendingOptionsRequest < Struct.new(
|
|
2796
|
+
:configuration_set_name,
|
|
2797
|
+
:sending_enabled)
|
|
2798
|
+
include Aws::Structure
|
|
2799
|
+
end
|
|
2800
|
+
|
|
2801
|
+
# An HTTP 200 response if the request succeeds, or an error message if
|
|
2802
|
+
# the request fails.
|
|
2803
|
+
#
|
|
2804
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/PutConfigurationSetSendingOptionsResponse AWS API Documentation
|
|
2805
|
+
#
|
|
2806
|
+
class PutConfigurationSetSendingOptionsResponse < Aws::EmptyStructure; end
|
|
2807
|
+
|
|
2808
|
+
# A request to add a custom domain for tracking open and click events to
|
|
2809
|
+
# a configuration set.
|
|
2810
|
+
#
|
|
2811
|
+
# @note When making an API call, you may pass PutConfigurationSetTrackingOptionsRequest
|
|
2812
|
+
# data as a hash:
|
|
2813
|
+
#
|
|
2814
|
+
# {
|
|
2815
|
+
# configuration_set_name: "ConfigurationSetName", # required
|
|
2816
|
+
# custom_redirect_domain: "CustomRedirectDomain",
|
|
2817
|
+
# }
|
|
2818
|
+
#
|
|
2819
|
+
# @!attribute [rw] configuration_set_name
|
|
2820
|
+
# The name of the configuration set that you want to add a custom
|
|
2821
|
+
# tracking domain to.
|
|
2822
|
+
# @return [String]
|
|
2823
|
+
#
|
|
2824
|
+
# @!attribute [rw] custom_redirect_domain
|
|
2825
|
+
# The domain that you want to use to track open and click events.
|
|
2826
|
+
# @return [String]
|
|
2827
|
+
#
|
|
2828
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/PutConfigurationSetTrackingOptionsRequest AWS API Documentation
|
|
2829
|
+
#
|
|
2830
|
+
class PutConfigurationSetTrackingOptionsRequest < Struct.new(
|
|
2831
|
+
:configuration_set_name,
|
|
2832
|
+
:custom_redirect_domain)
|
|
2833
|
+
include Aws::Structure
|
|
2834
|
+
end
|
|
2835
|
+
|
|
2836
|
+
# An HTTP 200 response if the request succeeds, or an error message if
|
|
2837
|
+
# the request fails.
|
|
2838
|
+
#
|
|
2839
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/PutConfigurationSetTrackingOptionsResponse AWS API Documentation
|
|
2840
|
+
#
|
|
2841
|
+
class PutConfigurationSetTrackingOptionsResponse < Aws::EmptyStructure; end
|
|
2842
|
+
|
|
2843
|
+
# A request to move a dedicated IP address to a dedicated IP pool.
|
|
2844
|
+
#
|
|
2845
|
+
# @note When making an API call, you may pass PutDedicatedIpInPoolRequest
|
|
2846
|
+
# data as a hash:
|
|
2847
|
+
#
|
|
2848
|
+
# {
|
|
2849
|
+
# ip: "Ip", # required
|
|
2850
|
+
# destination_pool_name: "PoolName", # required
|
|
2851
|
+
# }
|
|
2852
|
+
#
|
|
2853
|
+
# @!attribute [rw] ip
|
|
2854
|
+
# The IP address that you want to move to the dedicated IP pool. The
|
|
2855
|
+
# value you specify has to be a dedicated IP address that's
|
|
2856
|
+
# associated with your AWS account.
|
|
2857
|
+
# @return [String]
|
|
2858
|
+
#
|
|
2859
|
+
# @!attribute [rw] destination_pool_name
|
|
2860
|
+
# The name of the IP pool that you want to add the dedicated IP
|
|
2861
|
+
# address to. You have to specify an IP pool that already exists.
|
|
2862
|
+
# @return [String]
|
|
2863
|
+
#
|
|
2864
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/PutDedicatedIpInPoolRequest AWS API Documentation
|
|
2865
|
+
#
|
|
2866
|
+
class PutDedicatedIpInPoolRequest < Struct.new(
|
|
2867
|
+
:ip,
|
|
2868
|
+
:destination_pool_name)
|
|
2869
|
+
include Aws::Structure
|
|
2870
|
+
end
|
|
2871
|
+
|
|
2872
|
+
# An HTTP 200 response if the request succeeds, or an error message if
|
|
2873
|
+
# the request fails.
|
|
2874
|
+
#
|
|
2875
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/PutDedicatedIpInPoolResponse AWS API Documentation
|
|
2876
|
+
#
|
|
2877
|
+
class PutDedicatedIpInPoolResponse < Aws::EmptyStructure; end
|
|
2878
|
+
|
|
2879
|
+
# A request to change the warm-up attributes for a dedicated IP address.
|
|
2880
|
+
# This operation is useful when you want to resume the warm-up process
|
|
2881
|
+
# for an existing IP address.
|
|
2882
|
+
#
|
|
2883
|
+
# @note When making an API call, you may pass PutDedicatedIpWarmupAttributesRequest
|
|
2884
|
+
# data as a hash:
|
|
2885
|
+
#
|
|
2886
|
+
# {
|
|
2887
|
+
# ip: "Ip", # required
|
|
2888
|
+
# warmup_percentage: 1, # required
|
|
2889
|
+
# }
|
|
2890
|
+
#
|
|
2891
|
+
# @!attribute [rw] ip
|
|
2892
|
+
# The dedicated IP address that you want to update the warm-up
|
|
2893
|
+
# attributes for.
|
|
2894
|
+
# @return [String]
|
|
2895
|
+
#
|
|
2896
|
+
# @!attribute [rw] warmup_percentage
|
|
2897
|
+
# The warm-up percentage that you want to associate with the dedicated
|
|
2898
|
+
# IP address.
|
|
2899
|
+
# @return [Integer]
|
|
2900
|
+
#
|
|
2901
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/PutDedicatedIpWarmupAttributesRequest AWS API Documentation
|
|
2902
|
+
#
|
|
2903
|
+
class PutDedicatedIpWarmupAttributesRequest < Struct.new(
|
|
2904
|
+
:ip,
|
|
2905
|
+
:warmup_percentage)
|
|
2906
|
+
include Aws::Structure
|
|
2907
|
+
end
|
|
2908
|
+
|
|
2909
|
+
# An HTTP 200 response if the request succeeds, or an error message if
|
|
2910
|
+
# the request fails.
|
|
2911
|
+
#
|
|
2912
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/PutDedicatedIpWarmupAttributesResponse AWS API Documentation
|
|
2913
|
+
#
|
|
2914
|
+
class PutDedicatedIpWarmupAttributesResponse < Aws::EmptyStructure; end
|
|
2915
|
+
|
|
2916
|
+
# Enable or disable the Deliverability dashboard. When you enable the
|
|
2917
|
+
# Deliverability dashboard, you gain access to reputation,
|
|
2918
|
+
# deliverability, and other metrics for the domains that you use to send
|
|
2919
|
+
# email using Amazon SES API v2. You also gain the ability to perform
|
|
2920
|
+
# predictive inbox placement tests.
|
|
2921
|
+
#
|
|
2922
|
+
# When you use the Deliverability dashboard, you pay a monthly
|
|
2923
|
+
# subscription charge, in addition to any other fees that you accrue by
|
|
2924
|
+
# using Amazon SES and other AWS services. For more information about
|
|
2925
|
+
# the features and cost of a Deliverability dashboard subscription, see
|
|
2926
|
+
# [Amazon Pinpoint Pricing][1].
|
|
2927
|
+
#
|
|
2928
|
+
#
|
|
2929
|
+
#
|
|
2930
|
+
# [1]: http://aws.amazon.com/pinpoint/pricing/
|
|
2931
|
+
#
|
|
2932
|
+
# @note When making an API call, you may pass PutDeliverabilityDashboardOptionRequest
|
|
2933
|
+
# data as a hash:
|
|
2934
|
+
#
|
|
2935
|
+
# {
|
|
2936
|
+
# dashboard_enabled: false, # required
|
|
2937
|
+
# subscribed_domains: [
|
|
2938
|
+
# {
|
|
2939
|
+
# domain: "Domain",
|
|
2940
|
+
# subscription_start_date: Time.now,
|
|
2941
|
+
# inbox_placement_tracking_option: {
|
|
2942
|
+
# global: false,
|
|
2943
|
+
# tracked_isps: ["IspName"],
|
|
2944
|
+
# },
|
|
2945
|
+
# },
|
|
2946
|
+
# ],
|
|
2947
|
+
# }
|
|
2948
|
+
#
|
|
2949
|
+
# @!attribute [rw] dashboard_enabled
|
|
2950
|
+
# Specifies whether to enable the Deliverability dashboard. To enable
|
|
2951
|
+
# the dashboard, set this value to `true`.
|
|
2952
|
+
# @return [Boolean]
|
|
2953
|
+
#
|
|
2954
|
+
# @!attribute [rw] subscribed_domains
|
|
2955
|
+
# An array of objects, one for each verified domain that you use to
|
|
2956
|
+
# send email and enabled the Deliverability dashboard for.
|
|
2957
|
+
# @return [Array<Types::DomainDeliverabilityTrackingOption>]
|
|
2958
|
+
#
|
|
2959
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/PutDeliverabilityDashboardOptionRequest AWS API Documentation
|
|
2960
|
+
#
|
|
2961
|
+
class PutDeliverabilityDashboardOptionRequest < Struct.new(
|
|
2962
|
+
:dashboard_enabled,
|
|
2963
|
+
:subscribed_domains)
|
|
2964
|
+
include Aws::Structure
|
|
2965
|
+
end
|
|
2966
|
+
|
|
2967
|
+
# A response that indicates whether the Deliverability dashboard is
|
|
2968
|
+
# enabled.
|
|
2969
|
+
#
|
|
2970
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/PutDeliverabilityDashboardOptionResponse AWS API Documentation
|
|
2971
|
+
#
|
|
2972
|
+
class PutDeliverabilityDashboardOptionResponse < Aws::EmptyStructure; end
|
|
2973
|
+
|
|
2974
|
+
# A request to enable or disable DKIM signing of email that you send
|
|
2975
|
+
# from an email identity.
|
|
2976
|
+
#
|
|
2977
|
+
# @note When making an API call, you may pass PutEmailIdentityDkimAttributesRequest
|
|
2978
|
+
# data as a hash:
|
|
2979
|
+
#
|
|
2980
|
+
# {
|
|
2981
|
+
# email_identity: "Identity", # required
|
|
2982
|
+
# signing_enabled: false,
|
|
2983
|
+
# }
|
|
2984
|
+
#
|
|
2985
|
+
# @!attribute [rw] email_identity
|
|
2986
|
+
# The email identity that you want to change the DKIM settings for.
|
|
2987
|
+
# @return [String]
|
|
2988
|
+
#
|
|
2989
|
+
# @!attribute [rw] signing_enabled
|
|
2990
|
+
# Sets the DKIM signing configuration for the identity.
|
|
2991
|
+
#
|
|
2992
|
+
# When you set this value `true`, then the messages that are sent from
|
|
2993
|
+
# the identity are signed using DKIM. If you set this value to
|
|
2994
|
+
# `false`, your messages are sent without DKIM signing.
|
|
2995
|
+
# @return [Boolean]
|
|
2996
|
+
#
|
|
2997
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/PutEmailIdentityDkimAttributesRequest AWS API Documentation
|
|
2998
|
+
#
|
|
2999
|
+
class PutEmailIdentityDkimAttributesRequest < Struct.new(
|
|
3000
|
+
:email_identity,
|
|
3001
|
+
:signing_enabled)
|
|
3002
|
+
include Aws::Structure
|
|
3003
|
+
end
|
|
3004
|
+
|
|
3005
|
+
# An HTTP 200 response if the request succeeds, or an error message if
|
|
3006
|
+
# the request fails.
|
|
3007
|
+
#
|
|
3008
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/PutEmailIdentityDkimAttributesResponse AWS API Documentation
|
|
3009
|
+
#
|
|
3010
|
+
class PutEmailIdentityDkimAttributesResponse < Aws::EmptyStructure; end
|
|
3011
|
+
|
|
3012
|
+
# A request to set the attributes that control how bounce and complaint
|
|
3013
|
+
# events are processed.
|
|
3014
|
+
#
|
|
3015
|
+
# @note When making an API call, you may pass PutEmailIdentityFeedbackAttributesRequest
|
|
3016
|
+
# data as a hash:
|
|
3017
|
+
#
|
|
3018
|
+
# {
|
|
3019
|
+
# email_identity: "Identity", # required
|
|
3020
|
+
# email_forwarding_enabled: false,
|
|
3021
|
+
# }
|
|
3022
|
+
#
|
|
3023
|
+
# @!attribute [rw] email_identity
|
|
3024
|
+
# The email identity that you want to configure bounce and complaint
|
|
3025
|
+
# feedback forwarding for.
|
|
3026
|
+
# @return [String]
|
|
3027
|
+
#
|
|
3028
|
+
# @!attribute [rw] email_forwarding_enabled
|
|
3029
|
+
# Sets the feedback forwarding configuration for the identity.
|
|
3030
|
+
#
|
|
3031
|
+
# If the value is `true`, you receive email notifications when bounce
|
|
3032
|
+
# or complaint events occur. These notifications are sent to the
|
|
3033
|
+
# address that you specified in the `Return-Path` header of the
|
|
3034
|
+
# original email.
|
|
3035
|
+
#
|
|
3036
|
+
# You're required to have a method of tracking bounces and
|
|
3037
|
+
# complaints. If you haven't set up another mechanism for receiving
|
|
3038
|
+
# bounce or complaint notifications (for example, by setting up an
|
|
3039
|
+
# event destination), you receive an email notification when these
|
|
3040
|
+
# events occur (even if this setting is disabled).
|
|
3041
|
+
# @return [Boolean]
|
|
3042
|
+
#
|
|
3043
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/PutEmailIdentityFeedbackAttributesRequest AWS API Documentation
|
|
3044
|
+
#
|
|
3045
|
+
class PutEmailIdentityFeedbackAttributesRequest < Struct.new(
|
|
3046
|
+
:email_identity,
|
|
3047
|
+
:email_forwarding_enabled)
|
|
3048
|
+
include Aws::Structure
|
|
3049
|
+
end
|
|
3050
|
+
|
|
3051
|
+
# An HTTP 200 response if the request succeeds, or an error message if
|
|
3052
|
+
# the request fails.
|
|
3053
|
+
#
|
|
3054
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/PutEmailIdentityFeedbackAttributesResponse AWS API Documentation
|
|
3055
|
+
#
|
|
3056
|
+
class PutEmailIdentityFeedbackAttributesResponse < Aws::EmptyStructure; end
|
|
3057
|
+
|
|
3058
|
+
# A request to configure the custom MAIL FROM domain for a verified
|
|
3059
|
+
# identity.
|
|
3060
|
+
#
|
|
3061
|
+
# @note When making an API call, you may pass PutEmailIdentityMailFromAttributesRequest
|
|
3062
|
+
# data as a hash:
|
|
3063
|
+
#
|
|
3064
|
+
# {
|
|
3065
|
+
# email_identity: "Identity", # required
|
|
3066
|
+
# mail_from_domain: "MailFromDomainName",
|
|
3067
|
+
# behavior_on_mx_failure: "USE_DEFAULT_VALUE", # accepts USE_DEFAULT_VALUE, REJECT_MESSAGE
|
|
3068
|
+
# }
|
|
3069
|
+
#
|
|
3070
|
+
# @!attribute [rw] email_identity
|
|
3071
|
+
# The verified email identity that you want to set up the custom MAIL
|
|
3072
|
+
# FROM domain for.
|
|
3073
|
+
# @return [String]
|
|
3074
|
+
#
|
|
3075
|
+
# @!attribute [rw] mail_from_domain
|
|
3076
|
+
# The custom MAIL FROM domain that you want the verified identity to
|
|
3077
|
+
# use. The MAIL FROM domain must meet the following criteria:
|
|
3078
|
+
#
|
|
3079
|
+
# * It has to be a subdomain of the verified identity.
|
|
3080
|
+
#
|
|
3081
|
+
# * It can't be used to receive email.
|
|
3082
|
+
#
|
|
3083
|
+
# * It can't be used in a "From" address if the MAIL FROM domain is
|
|
3084
|
+
# a destination for feedback forwarding emails.
|
|
3085
|
+
# @return [String]
|
|
3086
|
+
#
|
|
3087
|
+
# @!attribute [rw] behavior_on_mx_failure
|
|
3088
|
+
# The action that you want to take if the required MX record isn't
|
|
3089
|
+
# found when you send an email. When you set this value to
|
|
3090
|
+
# `UseDefaultValue`, the mail is sent using *amazonses.com* as the
|
|
3091
|
+
# MAIL FROM domain. When you set this value to `RejectMessage`, the
|
|
3092
|
+
# Amazon SES API v2 returns a `MailFromDomainNotVerified` error, and
|
|
3093
|
+
# doesn't attempt to deliver the email.
|
|
3094
|
+
#
|
|
3095
|
+
# These behaviors are taken when the custom MAIL FROM domain
|
|
3096
|
+
# configuration is in the `Pending`, `Failed`, and `TemporaryFailure`
|
|
3097
|
+
# states.
|
|
3098
|
+
# @return [String]
|
|
3099
|
+
#
|
|
3100
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/PutEmailIdentityMailFromAttributesRequest AWS API Documentation
|
|
3101
|
+
#
|
|
3102
|
+
class PutEmailIdentityMailFromAttributesRequest < Struct.new(
|
|
3103
|
+
:email_identity,
|
|
3104
|
+
:mail_from_domain,
|
|
3105
|
+
:behavior_on_mx_failure)
|
|
3106
|
+
include Aws::Structure
|
|
3107
|
+
end
|
|
3108
|
+
|
|
3109
|
+
# An HTTP 200 response if the request succeeds, or an error message if
|
|
3110
|
+
# the request fails.
|
|
3111
|
+
#
|
|
3112
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/PutEmailIdentityMailFromAttributesResponse AWS API Documentation
|
|
3113
|
+
#
|
|
3114
|
+
class PutEmailIdentityMailFromAttributesResponse < Aws::EmptyStructure; end
|
|
3115
|
+
|
|
3116
|
+
# The raw email message.
|
|
3117
|
+
#
|
|
3118
|
+
# @note When making an API call, you may pass RawMessage
|
|
3119
|
+
# data as a hash:
|
|
3120
|
+
#
|
|
3121
|
+
# {
|
|
3122
|
+
# data: "data", # required
|
|
3123
|
+
# }
|
|
3124
|
+
#
|
|
3125
|
+
# @!attribute [rw] data
|
|
3126
|
+
# The raw email message. The message has to meet the following
|
|
3127
|
+
# criteria:
|
|
3128
|
+
#
|
|
3129
|
+
# * The message has to contain a header and a body, separated by one
|
|
3130
|
+
# blank line.
|
|
3131
|
+
#
|
|
3132
|
+
# * All of the required header fields must be present in the message.
|
|
3133
|
+
#
|
|
3134
|
+
# * Each part of a multipart MIME message must be formatted properly.
|
|
3135
|
+
#
|
|
3136
|
+
# * Attachments must be in a file format that the Amazon SES API v2
|
|
3137
|
+
# supports.
|
|
3138
|
+
#
|
|
3139
|
+
# * The entire message must be Base64 encoded.
|
|
3140
|
+
#
|
|
3141
|
+
# * If any of the MIME parts in your message contain content that is
|
|
3142
|
+
# outside of the 7-bit ASCII character range, you should encode that
|
|
3143
|
+
# content to ensure that recipients' email clients render the
|
|
3144
|
+
# message properly.
|
|
3145
|
+
#
|
|
3146
|
+
# * The length of any single line of text in the message can't exceed
|
|
3147
|
+
# 1,000 characters. This restriction is defined in [RFC 5321][1].
|
|
3148
|
+
#
|
|
3149
|
+
#
|
|
3150
|
+
#
|
|
3151
|
+
# [1]: https://tools.ietf.org/html/rfc5321
|
|
3152
|
+
# @return [String]
|
|
3153
|
+
#
|
|
3154
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/RawMessage AWS API Documentation
|
|
3155
|
+
#
|
|
3156
|
+
class RawMessage < Struct.new(
|
|
3157
|
+
:data)
|
|
3158
|
+
include Aws::Structure
|
|
3159
|
+
end
|
|
3160
|
+
|
|
3161
|
+
# Enable or disable collection of reputation metrics for emails that you
|
|
3162
|
+
# send using this configuration set in the current AWS Region.
|
|
3163
|
+
#
|
|
3164
|
+
# @note When making an API call, you may pass ReputationOptions
|
|
3165
|
+
# data as a hash:
|
|
3166
|
+
#
|
|
3167
|
+
# {
|
|
3168
|
+
# reputation_metrics_enabled: false,
|
|
3169
|
+
# last_fresh_start: Time.now,
|
|
3170
|
+
# }
|
|
3171
|
+
#
|
|
3172
|
+
# @!attribute [rw] reputation_metrics_enabled
|
|
3173
|
+
# If `true`, tracking of reputation metrics is enabled for the
|
|
3174
|
+
# configuration set. If `false`, tracking of reputation metrics is
|
|
3175
|
+
# disabled for the configuration set.
|
|
3176
|
+
# @return [Boolean]
|
|
3177
|
+
#
|
|
3178
|
+
# @!attribute [rw] last_fresh_start
|
|
3179
|
+
# The date and time (in Unix time) when the reputation metrics were
|
|
3180
|
+
# last given a fresh start. When your account is given a fresh start,
|
|
3181
|
+
# your reputation metrics are calculated starting from the date of the
|
|
3182
|
+
# fresh start.
|
|
3183
|
+
# @return [Time]
|
|
3184
|
+
#
|
|
3185
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/ReputationOptions AWS API Documentation
|
|
3186
|
+
#
|
|
3187
|
+
class ReputationOptions < Struct.new(
|
|
3188
|
+
:reputation_metrics_enabled,
|
|
3189
|
+
:last_fresh_start)
|
|
3190
|
+
include Aws::Structure
|
|
3191
|
+
end
|
|
3192
|
+
|
|
3193
|
+
# A request to send an email message.
|
|
3194
|
+
#
|
|
3195
|
+
# @note When making an API call, you may pass SendEmailRequest
|
|
3196
|
+
# data as a hash:
|
|
3197
|
+
#
|
|
3198
|
+
# {
|
|
3199
|
+
# from_email_address: "EmailAddress",
|
|
3200
|
+
# destination: { # required
|
|
3201
|
+
# to_addresses: ["EmailAddress"],
|
|
3202
|
+
# cc_addresses: ["EmailAddress"],
|
|
3203
|
+
# bcc_addresses: ["EmailAddress"],
|
|
3204
|
+
# },
|
|
3205
|
+
# reply_to_addresses: ["EmailAddress"],
|
|
3206
|
+
# feedback_forwarding_email_address: "EmailAddress",
|
|
3207
|
+
# content: { # required
|
|
3208
|
+
# simple: {
|
|
3209
|
+
# subject: { # required
|
|
3210
|
+
# data: "MessageData", # required
|
|
3211
|
+
# charset: "Charset",
|
|
3212
|
+
# },
|
|
3213
|
+
# body: { # required
|
|
3214
|
+
# text: {
|
|
3215
|
+
# data: "MessageData", # required
|
|
3216
|
+
# charset: "Charset",
|
|
3217
|
+
# },
|
|
3218
|
+
# html: {
|
|
3219
|
+
# data: "MessageData", # required
|
|
3220
|
+
# charset: "Charset",
|
|
3221
|
+
# },
|
|
3222
|
+
# },
|
|
3223
|
+
# },
|
|
3224
|
+
# raw: {
|
|
3225
|
+
# data: "data", # required
|
|
3226
|
+
# },
|
|
3227
|
+
# template: {
|
|
3228
|
+
# template_arn: "TemplateArn",
|
|
3229
|
+
# template_data: "TemplateData",
|
|
3230
|
+
# },
|
|
3231
|
+
# },
|
|
3232
|
+
# email_tags: [
|
|
3233
|
+
# {
|
|
3234
|
+
# name: "MessageTagName", # required
|
|
3235
|
+
# value: "MessageTagValue", # required
|
|
3236
|
+
# },
|
|
3237
|
+
# ],
|
|
3238
|
+
# configuration_set_name: "ConfigurationSetName",
|
|
3239
|
+
# }
|
|
3240
|
+
#
|
|
3241
|
+
# @!attribute [rw] from_email_address
|
|
3242
|
+
# The email address that you want to use as the "From" address for
|
|
3243
|
+
# the email. The address that you specify has to be verified.
|
|
3244
|
+
# @return [String]
|
|
3245
|
+
#
|
|
3246
|
+
# @!attribute [rw] destination
|
|
3247
|
+
# An object that contains the recipients of the email message.
|
|
3248
|
+
# @return [Types::Destination]
|
|
3249
|
+
#
|
|
3250
|
+
# @!attribute [rw] reply_to_addresses
|
|
3251
|
+
# The "Reply-to" email addresses for the message. When the recipient
|
|
3252
|
+
# replies to the message, each Reply-to address receives the reply.
|
|
3253
|
+
# @return [Array<String>]
|
|
3254
|
+
#
|
|
3255
|
+
# @!attribute [rw] feedback_forwarding_email_address
|
|
3256
|
+
# The address that you want bounce and complaint notifications to be
|
|
3257
|
+
# sent to.
|
|
3258
|
+
# @return [String]
|
|
3259
|
+
#
|
|
3260
|
+
# @!attribute [rw] content
|
|
3261
|
+
# An object that contains the body of the message. You can send either
|
|
3262
|
+
# a Simple message or a Raw message.
|
|
3263
|
+
# @return [Types::EmailContent]
|
|
3264
|
+
#
|
|
3265
|
+
# @!attribute [rw] email_tags
|
|
3266
|
+
# A list of tags, in the form of name/value pairs, to apply to an
|
|
3267
|
+
# email that you send using the `SendEmail` operation. Tags correspond
|
|
3268
|
+
# to characteristics of the email that you define, so that you can
|
|
3269
|
+
# publish email sending events.
|
|
3270
|
+
# @return [Array<Types::MessageTag>]
|
|
3271
|
+
#
|
|
3272
|
+
# @!attribute [rw] configuration_set_name
|
|
3273
|
+
# The name of the configuration set that you want to use when sending
|
|
3274
|
+
# the email.
|
|
3275
|
+
# @return [String]
|
|
3276
|
+
#
|
|
3277
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/SendEmailRequest AWS API Documentation
|
|
3278
|
+
#
|
|
3279
|
+
class SendEmailRequest < Struct.new(
|
|
3280
|
+
:from_email_address,
|
|
3281
|
+
:destination,
|
|
3282
|
+
:reply_to_addresses,
|
|
3283
|
+
:feedback_forwarding_email_address,
|
|
3284
|
+
:content,
|
|
3285
|
+
:email_tags,
|
|
3286
|
+
:configuration_set_name)
|
|
3287
|
+
include Aws::Structure
|
|
3288
|
+
end
|
|
3289
|
+
|
|
3290
|
+
# A unique message ID that you receive when an email is accepted for
|
|
3291
|
+
# sending.
|
|
3292
|
+
#
|
|
3293
|
+
# @!attribute [rw] message_id
|
|
3294
|
+
# A unique identifier for the message that is generated when the
|
|
3295
|
+
# message is accepted.
|
|
3296
|
+
#
|
|
3297
|
+
# <note markdown="1"> It is possible for the Amazon SES API v2 to accept a message without
|
|
3298
|
+
# sending it. This can happen when the message that you're trying to
|
|
3299
|
+
# send has an attachment contains a virus, or when you send a
|
|
3300
|
+
# templated email that contains invalid personalization content, for
|
|
3301
|
+
# example.
|
|
3302
|
+
#
|
|
3303
|
+
# </note>
|
|
3304
|
+
# @return [String]
|
|
3305
|
+
#
|
|
3306
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/SendEmailResponse AWS API Documentation
|
|
3307
|
+
#
|
|
3308
|
+
class SendEmailResponse < Struct.new(
|
|
3309
|
+
:message_id)
|
|
3310
|
+
include Aws::Structure
|
|
3311
|
+
end
|
|
3312
|
+
|
|
3313
|
+
# An object that contains information about the per-day and per-second
|
|
3314
|
+
# sending limits for your Amazon SES account in the current AWS Region.
|
|
3315
|
+
#
|
|
3316
|
+
# @!attribute [rw] max_24_hour_send
|
|
3317
|
+
# The maximum number of emails that you can send in the current AWS
|
|
3318
|
+
# Region over a 24-hour period. This value is also called your
|
|
3319
|
+
# *sending quota*.
|
|
3320
|
+
# @return [Float]
|
|
3321
|
+
#
|
|
3322
|
+
# @!attribute [rw] max_send_rate
|
|
3323
|
+
# The maximum number of emails that you can send per second in the
|
|
3324
|
+
# current AWS Region. This value is also called your *maximum sending
|
|
3325
|
+
# rate* or your *maximum TPS (transactions per second) rate*.
|
|
3326
|
+
# @return [Float]
|
|
3327
|
+
#
|
|
3328
|
+
# @!attribute [rw] sent_last_24_hours
|
|
3329
|
+
# The number of emails sent from your Amazon SES account in the
|
|
3330
|
+
# current AWS Region over the past 24 hours.
|
|
3331
|
+
# @return [Float]
|
|
3332
|
+
#
|
|
3333
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/SendQuota AWS API Documentation
|
|
3334
|
+
#
|
|
3335
|
+
class SendQuota < Struct.new(
|
|
3336
|
+
:max_24_hour_send,
|
|
3337
|
+
:max_send_rate,
|
|
3338
|
+
:sent_last_24_hours)
|
|
3339
|
+
include Aws::Structure
|
|
3340
|
+
end
|
|
3341
|
+
|
|
3342
|
+
# Used to enable or disable email sending for messages that use this
|
|
3343
|
+
# configuration set in the current AWS Region.
|
|
3344
|
+
#
|
|
3345
|
+
# @note When making an API call, you may pass SendingOptions
|
|
3346
|
+
# data as a hash:
|
|
3347
|
+
#
|
|
3348
|
+
# {
|
|
3349
|
+
# sending_enabled: false,
|
|
3350
|
+
# }
|
|
3351
|
+
#
|
|
3352
|
+
# @!attribute [rw] sending_enabled
|
|
3353
|
+
# If `true`, email sending is enabled for the configuration set. If
|
|
3354
|
+
# `false`, email sending is disabled for the configuration set.
|
|
3355
|
+
# @return [Boolean]
|
|
3356
|
+
#
|
|
3357
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/SendingOptions AWS API Documentation
|
|
3358
|
+
#
|
|
3359
|
+
class SendingOptions < Struct.new(
|
|
3360
|
+
:sending_enabled)
|
|
3361
|
+
include Aws::Structure
|
|
3362
|
+
end
|
|
3363
|
+
|
|
3364
|
+
# An object that defines an Amazon SNS destination for email events. You
|
|
3365
|
+
# can use Amazon SNS to send notification when certain email events
|
|
3366
|
+
# occur.
|
|
3367
|
+
#
|
|
3368
|
+
# @note When making an API call, you may pass SnsDestination
|
|
3369
|
+
# data as a hash:
|
|
3370
|
+
#
|
|
3371
|
+
# {
|
|
3372
|
+
# topic_arn: "AmazonResourceName", # required
|
|
3373
|
+
# }
|
|
3374
|
+
#
|
|
3375
|
+
# @!attribute [rw] topic_arn
|
|
3376
|
+
# The Amazon Resource Name (ARN) of the Amazon SNS topic that you want
|
|
3377
|
+
# to publish email events to. For more information about Amazon SNS
|
|
3378
|
+
# topics, see the [Amazon SNS Developer Guide][1].
|
|
3379
|
+
#
|
|
3380
|
+
#
|
|
3381
|
+
#
|
|
3382
|
+
# [1]: https://docs.aws.amazon.com/sns/latest/dg/CreateTopic.html
|
|
3383
|
+
# @return [String]
|
|
3384
|
+
#
|
|
3385
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/SnsDestination AWS API Documentation
|
|
3386
|
+
#
|
|
3387
|
+
class SnsDestination < Struct.new(
|
|
3388
|
+
:topic_arn)
|
|
3389
|
+
include Aws::Structure
|
|
3390
|
+
end
|
|
3391
|
+
|
|
3392
|
+
# An object that defines the tags that are associated with a resource.
|
|
3393
|
+
# A *tag* is a label that you optionally define and associate with a
|
|
3394
|
+
# resource. Tags can help you categorize and manage resources in
|
|
3395
|
+
# different ways, such as by purpose, owner, environment, or other
|
|
3396
|
+
# criteria. A resource can have as many as 50 tags.
|
|
3397
|
+
#
|
|
3398
|
+
# Each tag consists of a required *tag key* and an associated *tag
|
|
3399
|
+
# value*, both of which you define. A tag key is a general label that
|
|
3400
|
+
# acts as a category for a more specific tag value. A tag value acts as
|
|
3401
|
+
# a descriptor within a tag key. A tag key can contain as many as 128
|
|
3402
|
+
# characters. A tag value can contain as many as 256 characters. The
|
|
3403
|
+
# characters can be Unicode letters, digits, white space, or one of the
|
|
3404
|
+
# following symbols: \_ . : / = + -. The following additional
|
|
3405
|
+
# restrictions apply to tags:
|
|
3406
|
+
#
|
|
3407
|
+
# * Tag keys and values are case sensitive.
|
|
3408
|
+
#
|
|
3409
|
+
# * For each associated resource, each tag key must be unique and it can
|
|
3410
|
+
# have only one value.
|
|
3411
|
+
#
|
|
3412
|
+
# * The `aws:` prefix is reserved for use by AWS; you can’t use it in
|
|
3413
|
+
# any tag keys or values that you define. In addition, you can't edit
|
|
3414
|
+
# or remove tag keys or values that use this prefix. Tags that use
|
|
3415
|
+
# this prefix don’t count against the limit of 50 tags per resource.
|
|
3416
|
+
#
|
|
3417
|
+
# * You can associate tags with public or shared resources, but the tags
|
|
3418
|
+
# are available only for your AWS account, not any other accounts that
|
|
3419
|
+
# share the resource. In addition, the tags are available only for
|
|
3420
|
+
# resources that are located in the specified AWS Region for your AWS
|
|
3421
|
+
# account.
|
|
3422
|
+
#
|
|
3423
|
+
# @note When making an API call, you may pass Tag
|
|
3424
|
+
# data as a hash:
|
|
3425
|
+
#
|
|
3426
|
+
# {
|
|
3427
|
+
# key: "TagKey", # required
|
|
3428
|
+
# value: "TagValue", # required
|
|
3429
|
+
# }
|
|
3430
|
+
#
|
|
3431
|
+
# @!attribute [rw] key
|
|
3432
|
+
# One part of a key-value pair that defines a tag. The maximum length
|
|
3433
|
+
# of a tag key is 128 characters. The minimum length is 1 character.
|
|
3434
|
+
# @return [String]
|
|
3435
|
+
#
|
|
3436
|
+
# @!attribute [rw] value
|
|
3437
|
+
# The optional part of a key-value pair that defines a tag. The
|
|
3438
|
+
# maximum length of a tag value is 256 characters. The minimum length
|
|
3439
|
+
# is 0 characters. If you don't want a resource to have a specific
|
|
3440
|
+
# tag value, don't specify a value for this parameter. If you don't
|
|
3441
|
+
# specify a value, Amazon SES sets the value to an empty string.
|
|
3442
|
+
# @return [String]
|
|
3443
|
+
#
|
|
3444
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/Tag AWS API Documentation
|
|
3445
|
+
#
|
|
3446
|
+
class Tag < Struct.new(
|
|
3447
|
+
:key,
|
|
3448
|
+
:value)
|
|
3449
|
+
include Aws::Structure
|
|
3450
|
+
end
|
|
3451
|
+
|
|
3452
|
+
# @note When making an API call, you may pass TagResourceRequest
|
|
3453
|
+
# data as a hash:
|
|
3454
|
+
#
|
|
3455
|
+
# {
|
|
3456
|
+
# resource_arn: "AmazonResourceName", # required
|
|
3457
|
+
# tags: [ # required
|
|
3458
|
+
# {
|
|
3459
|
+
# key: "TagKey", # required
|
|
3460
|
+
# value: "TagValue", # required
|
|
3461
|
+
# },
|
|
3462
|
+
# ],
|
|
3463
|
+
# }
|
|
3464
|
+
#
|
|
3465
|
+
# @!attribute [rw] resource_arn
|
|
3466
|
+
# The Amazon Resource Name (ARN) of the resource that you want to add
|
|
3467
|
+
# one or more tags to.
|
|
3468
|
+
# @return [String]
|
|
3469
|
+
#
|
|
3470
|
+
# @!attribute [rw] tags
|
|
3471
|
+
# A list of the tags that you want to add to the resource. A tag
|
|
3472
|
+
# consists of a required tag key (`Key`) and an associated tag value
|
|
3473
|
+
# (`Value`). The maximum length of a tag key is 128 characters. The
|
|
3474
|
+
# maximum length of a tag value is 256 characters.
|
|
3475
|
+
# @return [Array<Types::Tag>]
|
|
3476
|
+
#
|
|
3477
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/TagResourceRequest AWS API Documentation
|
|
3478
|
+
#
|
|
3479
|
+
class TagResourceRequest < Struct.new(
|
|
3480
|
+
:resource_arn,
|
|
3481
|
+
:tags)
|
|
3482
|
+
include Aws::Structure
|
|
3483
|
+
end
|
|
3484
|
+
|
|
3485
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/TagResourceResponse AWS API Documentation
|
|
3486
|
+
#
|
|
3487
|
+
class TagResourceResponse < Aws::EmptyStructure; end
|
|
3488
|
+
|
|
3489
|
+
# An object that defines the email template to use for an email message,
|
|
3490
|
+
# and the values to use for any message variables in that template. An
|
|
3491
|
+
# *email template* is a type of message template that contains content
|
|
3492
|
+
# that you want to define, save, and reuse in email messages that you
|
|
3493
|
+
# send.
|
|
3494
|
+
#
|
|
3495
|
+
# @note When making an API call, you may pass Template
|
|
3496
|
+
# data as a hash:
|
|
3497
|
+
#
|
|
3498
|
+
# {
|
|
3499
|
+
# template_arn: "TemplateArn",
|
|
3500
|
+
# template_data: "TemplateData",
|
|
3501
|
+
# }
|
|
3502
|
+
#
|
|
3503
|
+
# @!attribute [rw] template_arn
|
|
3504
|
+
# The Amazon Resource Name (ARN) of the template.
|
|
3505
|
+
# @return [String]
|
|
3506
|
+
#
|
|
3507
|
+
# @!attribute [rw] template_data
|
|
3508
|
+
# An object that defines the values to use for message variables in
|
|
3509
|
+
# the template. This object is a set of key-value pairs. Each key
|
|
3510
|
+
# defines a message variable in the template. The corresponding value
|
|
3511
|
+
# defines the value to use for that variable.
|
|
3512
|
+
# @return [String]
|
|
3513
|
+
#
|
|
3514
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/Template AWS API Documentation
|
|
3515
|
+
#
|
|
3516
|
+
class Template < Struct.new(
|
|
3517
|
+
:template_arn,
|
|
3518
|
+
:template_data)
|
|
3519
|
+
include Aws::Structure
|
|
3520
|
+
end
|
|
3521
|
+
|
|
3522
|
+
# An object that defines the tracking options for a configuration set.
|
|
3523
|
+
# When you use the Amazon SES API v2 to send an email, it contains an
|
|
3524
|
+
# invisible image that's used to track when recipients open your email.
|
|
3525
|
+
# If your email contains links, those links are changed slightly in
|
|
3526
|
+
# order to track when recipients click them.
|
|
3527
|
+
#
|
|
3528
|
+
# These images and links include references to a domain operated by AWS.
|
|
3529
|
+
# You can optionally configure the Amazon SES to use a domain that you
|
|
3530
|
+
# operate for these images and links.
|
|
3531
|
+
#
|
|
3532
|
+
# @note When making an API call, you may pass TrackingOptions
|
|
3533
|
+
# data as a hash:
|
|
3534
|
+
#
|
|
3535
|
+
# {
|
|
3536
|
+
# custom_redirect_domain: "CustomRedirectDomain", # required
|
|
3537
|
+
# }
|
|
3538
|
+
#
|
|
3539
|
+
# @!attribute [rw] custom_redirect_domain
|
|
3540
|
+
# The domain that you want to use for tracking open and click events.
|
|
3541
|
+
# @return [String]
|
|
3542
|
+
#
|
|
3543
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/TrackingOptions AWS API Documentation
|
|
3544
|
+
#
|
|
3545
|
+
class TrackingOptions < Struct.new(
|
|
3546
|
+
:custom_redirect_domain)
|
|
3547
|
+
include Aws::Structure
|
|
3548
|
+
end
|
|
3549
|
+
|
|
3550
|
+
# @note When making an API call, you may pass UntagResourceRequest
|
|
3551
|
+
# data as a hash:
|
|
3552
|
+
#
|
|
3553
|
+
# {
|
|
3554
|
+
# resource_arn: "AmazonResourceName", # required
|
|
3555
|
+
# tag_keys: ["TagKey"], # required
|
|
3556
|
+
# }
|
|
3557
|
+
#
|
|
3558
|
+
# @!attribute [rw] resource_arn
|
|
3559
|
+
# The Amazon Resource Name (ARN) of the resource that you want to
|
|
3560
|
+
# remove one or more tags from.
|
|
3561
|
+
# @return [String]
|
|
3562
|
+
#
|
|
3563
|
+
# @!attribute [rw] tag_keys
|
|
3564
|
+
# The tags (tag keys) that you want to remove from the resource. When
|
|
3565
|
+
# you specify a tag key, the action removes both that key and its
|
|
3566
|
+
# associated tag value.
|
|
3567
|
+
#
|
|
3568
|
+
# To remove more than one tag from the resource, append the `TagKeys`
|
|
3569
|
+
# parameter and argument for each additional tag to remove, separated
|
|
3570
|
+
# by an ampersand. For example:
|
|
3571
|
+
# `/v2/email/tags?ResourceArn=ResourceArn&TagKeys=Key1&TagKeys=Key2`
|
|
3572
|
+
# @return [Array<String>]
|
|
3573
|
+
#
|
|
3574
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/UntagResourceRequest AWS API Documentation
|
|
3575
|
+
#
|
|
3576
|
+
class UntagResourceRequest < Struct.new(
|
|
3577
|
+
:resource_arn,
|
|
3578
|
+
:tag_keys)
|
|
3579
|
+
include Aws::Structure
|
|
3580
|
+
end
|
|
3581
|
+
|
|
3582
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/UntagResourceResponse AWS API Documentation
|
|
3583
|
+
#
|
|
3584
|
+
class UntagResourceResponse < Aws::EmptyStructure; end
|
|
3585
|
+
|
|
3586
|
+
# A request to change the settings for an event destination for a
|
|
3587
|
+
# configuration set.
|
|
3588
|
+
#
|
|
3589
|
+
# @note When making an API call, you may pass UpdateConfigurationSetEventDestinationRequest
|
|
3590
|
+
# data as a hash:
|
|
3591
|
+
#
|
|
3592
|
+
# {
|
|
3593
|
+
# configuration_set_name: "ConfigurationSetName", # required
|
|
3594
|
+
# event_destination_name: "EventDestinationName", # required
|
|
3595
|
+
# event_destination: { # required
|
|
3596
|
+
# enabled: false,
|
|
3597
|
+
# matching_event_types: ["SEND"], # accepts SEND, REJECT, BOUNCE, COMPLAINT, DELIVERY, OPEN, CLICK, RENDERING_FAILURE
|
|
3598
|
+
# kinesis_firehose_destination: {
|
|
3599
|
+
# iam_role_arn: "AmazonResourceName", # required
|
|
3600
|
+
# delivery_stream_arn: "AmazonResourceName", # required
|
|
3601
|
+
# },
|
|
3602
|
+
# cloud_watch_destination: {
|
|
3603
|
+
# dimension_configurations: [ # required
|
|
3604
|
+
# {
|
|
3605
|
+
# dimension_name: "DimensionName", # required
|
|
3606
|
+
# dimension_value_source: "MESSAGE_TAG", # required, accepts MESSAGE_TAG, EMAIL_HEADER, LINK_TAG
|
|
3607
|
+
# default_dimension_value: "DefaultDimensionValue", # required
|
|
3608
|
+
# },
|
|
3609
|
+
# ],
|
|
3610
|
+
# },
|
|
3611
|
+
# sns_destination: {
|
|
3612
|
+
# topic_arn: "AmazonResourceName", # required
|
|
3613
|
+
# },
|
|
3614
|
+
# pinpoint_destination: {
|
|
3615
|
+
# application_arn: "AmazonResourceName",
|
|
3616
|
+
# },
|
|
3617
|
+
# },
|
|
3618
|
+
# }
|
|
3619
|
+
#
|
|
3620
|
+
# @!attribute [rw] configuration_set_name
|
|
3621
|
+
# The name of the configuration set that contains the event
|
|
3622
|
+
# destination that you want to modify.
|
|
3623
|
+
# @return [String]
|
|
3624
|
+
#
|
|
3625
|
+
# @!attribute [rw] event_destination_name
|
|
3626
|
+
# The name of the event destination that you want to modify.
|
|
3627
|
+
# @return [String]
|
|
3628
|
+
#
|
|
3629
|
+
# @!attribute [rw] event_destination
|
|
3630
|
+
# An object that defines the event destination.
|
|
3631
|
+
# @return [Types::EventDestinationDefinition]
|
|
3632
|
+
#
|
|
3633
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/UpdateConfigurationSetEventDestinationRequest AWS API Documentation
|
|
3634
|
+
#
|
|
3635
|
+
class UpdateConfigurationSetEventDestinationRequest < Struct.new(
|
|
3636
|
+
:configuration_set_name,
|
|
3637
|
+
:event_destination_name,
|
|
3638
|
+
:event_destination)
|
|
3639
|
+
include Aws::Structure
|
|
3640
|
+
end
|
|
3641
|
+
|
|
3642
|
+
# An HTTP 200 response if the request succeeds, or an error message if
|
|
3643
|
+
# the request fails.
|
|
3644
|
+
#
|
|
3645
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/UpdateConfigurationSetEventDestinationResponse AWS API Documentation
|
|
3646
|
+
#
|
|
3647
|
+
class UpdateConfigurationSetEventDestinationResponse < Aws::EmptyStructure; end
|
|
3648
|
+
|
|
3649
|
+
# An object that contains information about the amount of email that was
|
|
3650
|
+
# delivered to recipients.
|
|
3651
|
+
#
|
|
3652
|
+
# @!attribute [rw] inbox_raw_count
|
|
3653
|
+
# The total number of emails that arrived in recipients' inboxes.
|
|
3654
|
+
# @return [Integer]
|
|
3655
|
+
#
|
|
3656
|
+
# @!attribute [rw] spam_raw_count
|
|
3657
|
+
# The total number of emails that arrived in recipients' spam or junk
|
|
3658
|
+
# mail folders.
|
|
3659
|
+
# @return [Integer]
|
|
3660
|
+
#
|
|
3661
|
+
# @!attribute [rw] projected_inbox
|
|
3662
|
+
# An estimate of the percentage of emails sent from the current domain
|
|
3663
|
+
# that will arrive in recipients' inboxes.
|
|
3664
|
+
# @return [Integer]
|
|
3665
|
+
#
|
|
3666
|
+
# @!attribute [rw] projected_spam
|
|
3667
|
+
# An estimate of the percentage of emails sent from the current domain
|
|
3668
|
+
# that will arrive in recipients' spam or junk mail folders.
|
|
3669
|
+
# @return [Integer]
|
|
3670
|
+
#
|
|
3671
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/VolumeStatistics AWS API Documentation
|
|
3672
|
+
#
|
|
3673
|
+
class VolumeStatistics < Struct.new(
|
|
3674
|
+
:inbox_raw_count,
|
|
3675
|
+
:spam_raw_count,
|
|
3676
|
+
:projected_inbox,
|
|
3677
|
+
:projected_spam)
|
|
3678
|
+
include Aws::Structure
|
|
3679
|
+
end
|
|
3680
|
+
|
|
3681
|
+
end
|
|
3682
|
+
end
|