aws-sdk-pinpointemail 1.0.0

Sign up to get free protection for your applications and to get access to all the features.
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::PinpointEmail
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::PinpointEmail
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,2382 @@
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::PinpointEmail
9
+ module Types
10
+
11
+ # Represents the body of the email message.
12
+ #
13
+ # @note When making an API call, you may pass Body
14
+ # data as a hash:
15
+ #
16
+ # {
17
+ # text: {
18
+ # data: "MessageData", # required
19
+ # charset: "Charset",
20
+ # },
21
+ # html: {
22
+ # data: "MessageData", # required
23
+ # charset: "Charset",
24
+ # },
25
+ # }
26
+ #
27
+ # @!attribute [rw] text
28
+ # An object that represents the version of the message that is
29
+ # displayed in email clients that don't support HTML, or clients
30
+ # where the recipient has disabled HTML rendering.
31
+ # @return [Types::Content]
32
+ #
33
+ # @!attribute [rw] html
34
+ # An object that represents the version of the message that is
35
+ # displayed in email clients that support HTML. HTML messages can
36
+ # include formatted text, hyperlinks, images, and more.
37
+ # @return [Types::Content]
38
+ #
39
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26/Body AWS API Documentation
40
+ #
41
+ class Body < Struct.new(
42
+ :text,
43
+ :html)
44
+ include Aws::Structure
45
+ end
46
+
47
+ # An object that defines an Amazon CloudWatch destination for email
48
+ # events. You can use Amazon CloudWatch to monitor and gain insights on
49
+ # your email sending metrics.
50
+ #
51
+ # @note When making an API call, you may pass CloudWatchDestination
52
+ # data as a hash:
53
+ #
54
+ # {
55
+ # dimension_configurations: [ # required
56
+ # {
57
+ # dimension_name: "DimensionName", # required
58
+ # dimension_value_source: "MESSAGE_TAG", # required, accepts MESSAGE_TAG, EMAIL_HEADER, LINK_TAG
59
+ # default_dimension_value: "DefaultDimensionValue", # required
60
+ # },
61
+ # ],
62
+ # }
63
+ #
64
+ # @!attribute [rw] dimension_configurations
65
+ # An array of objects that define the dimensions to use when you send
66
+ # email events to Amazon CloudWatch.
67
+ # @return [Array<Types::CloudWatchDimensionConfiguration>]
68
+ #
69
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26/CloudWatchDestination AWS API Documentation
70
+ #
71
+ class CloudWatchDestination < Struct.new(
72
+ :dimension_configurations)
73
+ include Aws::Structure
74
+ end
75
+
76
+ # An object that defines the dimension configuration to use when you
77
+ # send Amazon Pinpoint email events to Amazon CloudWatch.
78
+ #
79
+ # @note When making an API call, you may pass CloudWatchDimensionConfiguration
80
+ # data as a hash:
81
+ #
82
+ # {
83
+ # dimension_name: "DimensionName", # required
84
+ # dimension_value_source: "MESSAGE_TAG", # required, accepts MESSAGE_TAG, EMAIL_HEADER, LINK_TAG
85
+ # default_dimension_value: "DefaultDimensionValue", # required
86
+ # }
87
+ #
88
+ # @!attribute [rw] dimension_name
89
+ # The name of an Amazon CloudWatch dimension associated with an email
90
+ # sending metric. The name has to meet the following criteria:
91
+ #
92
+ # * It can only contain ASCII letters (a-z, A-Z), numbers (0-9),
93
+ # underscores (\_), or dashes (-).
94
+ #
95
+ # * It can contain no more than 256 characters.
96
+ # @return [String]
97
+ #
98
+ # @!attribute [rw] dimension_value_source
99
+ # The location where Amazon Pinpoint finds the value of a dimension to
100
+ # publish to Amazon CloudWatch. If you want Amazon Pinpoint to use the
101
+ # message tags that you specify using an X-SES-MESSAGE-TAGS header or
102
+ # a parameter to the SendEmail/SendRawEmail API, choose `messageTag`.
103
+ # If you want Amazon Pinpoint to use your own email headers, choose
104
+ # `emailHeader`. If you want Amazon Pinpoint to use link tags, choose
105
+ # `linkTags`.
106
+ # @return [String]
107
+ #
108
+ # @!attribute [rw] default_dimension_value
109
+ # The default value of the dimension that is published to Amazon
110
+ # CloudWatch if you don't provide the value of the dimension when you
111
+ # send an email. This value has to meet the following criteria:
112
+ #
113
+ # * It can only contain ASCII letters (a-z, A-Z), numbers (0-9),
114
+ # underscores (\_), or dashes (-).
115
+ #
116
+ # * It can contain no more than 256 characters.
117
+ # @return [String]
118
+ #
119
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26/CloudWatchDimensionConfiguration AWS API Documentation
120
+ #
121
+ class CloudWatchDimensionConfiguration < Struct.new(
122
+ :dimension_name,
123
+ :dimension_value_source,
124
+ :default_dimension_value)
125
+ include Aws::Structure
126
+ end
127
+
128
+ # An object that represents the content of the email, and optionally a
129
+ # character set specification.
130
+ #
131
+ # @note When making an API call, you may pass Content
132
+ # data as a hash:
133
+ #
134
+ # {
135
+ # data: "MessageData", # required
136
+ # charset: "Charset",
137
+ # }
138
+ #
139
+ # @!attribute [rw] data
140
+ # The content of the message itself.
141
+ # @return [String]
142
+ #
143
+ # @!attribute [rw] charset
144
+ # The character set for the content. Because of the constraints of the
145
+ # SMTP protocol, Amazon Pinpoint uses 7-bit ASCII by default. If the
146
+ # text includes characters outside of the ASCII range, you have to
147
+ # specify a character set. For example, you could specify `UTF-8`,
148
+ # `ISO-8859-1`, or `Shift_JIS`.
149
+ # @return [String]
150
+ #
151
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26/Content AWS API Documentation
152
+ #
153
+ class Content < Struct.new(
154
+ :data,
155
+ :charset)
156
+ include Aws::Structure
157
+ end
158
+
159
+ # A request to add an event destination to a configuration set.
160
+ #
161
+ # @note When making an API call, you may pass CreateConfigurationSetEventDestinationRequest
162
+ # data as a hash:
163
+ #
164
+ # {
165
+ # configuration_set_name: "ConfigurationSetName", # required
166
+ # event_destination_name: "EventDestinationName", # required
167
+ # event_destination: { # required
168
+ # enabled: false,
169
+ # matching_event_types: ["SEND"], # accepts SEND, REJECT, BOUNCE, COMPLAINT, DELIVERY, OPEN, CLICK, RENDERING_FAILURE
170
+ # kinesis_firehose_destination: {
171
+ # iam_role_arn: "AmazonResourceName", # required
172
+ # delivery_stream_arn: "AmazonResourceName", # required
173
+ # },
174
+ # cloud_watch_destination: {
175
+ # dimension_configurations: [ # required
176
+ # {
177
+ # dimension_name: "DimensionName", # required
178
+ # dimension_value_source: "MESSAGE_TAG", # required, accepts MESSAGE_TAG, EMAIL_HEADER, LINK_TAG
179
+ # default_dimension_value: "DefaultDimensionValue", # required
180
+ # },
181
+ # ],
182
+ # },
183
+ # sns_destination: {
184
+ # topic_arn: "AmazonResourceName", # required
185
+ # },
186
+ # pinpoint_destination: {
187
+ # application_arn: "AmazonResourceName",
188
+ # },
189
+ # },
190
+ # }
191
+ #
192
+ # @!attribute [rw] configuration_set_name
193
+ # The name of the configuration set that you want to add an event
194
+ # destination to.
195
+ # @return [String]
196
+ #
197
+ # @!attribute [rw] event_destination_name
198
+ # A name that identifies the event destination within the
199
+ # configuration set.
200
+ # @return [String]
201
+ #
202
+ # @!attribute [rw] event_destination
203
+ # An object that defines the event destination.
204
+ # @return [Types::EventDestinationDefinition]
205
+ #
206
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26/CreateConfigurationSetEventDestinationRequest AWS API Documentation
207
+ #
208
+ class CreateConfigurationSetEventDestinationRequest < Struct.new(
209
+ :configuration_set_name,
210
+ :event_destination_name,
211
+ :event_destination)
212
+ include Aws::Structure
213
+ end
214
+
215
+ # An HTTP 200 response if the request succeeds, or an error message if
216
+ # the request fails.
217
+ #
218
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26/CreateConfigurationSetEventDestinationResponse AWS API Documentation
219
+ #
220
+ class CreateConfigurationSetEventDestinationResponse < Aws::EmptyStructure; end
221
+
222
+ # A request to create a configuration set.
223
+ #
224
+ # @note When making an API call, you may pass CreateConfigurationSetRequest
225
+ # data as a hash:
226
+ #
227
+ # {
228
+ # configuration_set_name: "ConfigurationSetName",
229
+ # tracking_options: {
230
+ # custom_redirect_domain: "CustomRedirectDomain", # required
231
+ # },
232
+ # delivery_options: {
233
+ # sending_pool_name: "PoolName",
234
+ # },
235
+ # reputation_options: {
236
+ # reputation_metrics_enabled: false,
237
+ # last_fresh_start: Time.now,
238
+ # },
239
+ # sending_options: {
240
+ # sending_enabled: false,
241
+ # },
242
+ # }
243
+ #
244
+ # @!attribute [rw] configuration_set_name
245
+ # The name of the configuration set.
246
+ # @return [String]
247
+ #
248
+ # @!attribute [rw] tracking_options
249
+ # An object that defines the open and click tracking options for
250
+ # emails that you send using the configuration set.
251
+ # @return [Types::TrackingOptions]
252
+ #
253
+ # @!attribute [rw] delivery_options
254
+ # An object that defines the dedicated IP pool that is used to send
255
+ # emails that you send using the configuration set.
256
+ # @return [Types::DeliveryOptions]
257
+ #
258
+ # @!attribute [rw] reputation_options
259
+ # An object that defines whether or not Amazon Pinpoint collects
260
+ # reputation metrics for the emails that you send that use the
261
+ # configuration set.
262
+ # @return [Types::ReputationOptions]
263
+ #
264
+ # @!attribute [rw] sending_options
265
+ # An object that defines whether or not Amazon Pinpoint can send email
266
+ # that you send using the configuration set.
267
+ # @return [Types::SendingOptions]
268
+ #
269
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26/CreateConfigurationSetRequest AWS API Documentation
270
+ #
271
+ class CreateConfigurationSetRequest < Struct.new(
272
+ :configuration_set_name,
273
+ :tracking_options,
274
+ :delivery_options,
275
+ :reputation_options,
276
+ :sending_options)
277
+ include Aws::Structure
278
+ end
279
+
280
+ # An HTTP 200 response if the request succeeds, or an error message if
281
+ # the request fails.
282
+ #
283
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26/CreateConfigurationSetResponse AWS API Documentation
284
+ #
285
+ class CreateConfigurationSetResponse < Aws::EmptyStructure; end
286
+
287
+ # A request to create a new dedicated IP pool.
288
+ #
289
+ # @note When making an API call, you may pass CreateDedicatedIpPoolRequest
290
+ # data as a hash:
291
+ #
292
+ # {
293
+ # pool_name: "PoolName", # required
294
+ # }
295
+ #
296
+ # @!attribute [rw] pool_name
297
+ # The name of the dedicated IP pool.
298
+ # @return [String]
299
+ #
300
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26/CreateDedicatedIpPoolRequest AWS API Documentation
301
+ #
302
+ class CreateDedicatedIpPoolRequest < Struct.new(
303
+ :pool_name)
304
+ include Aws::Structure
305
+ end
306
+
307
+ # An HTTP 200 response if the request succeeds, or an error message if
308
+ # the request fails.
309
+ #
310
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26/CreateDedicatedIpPoolResponse AWS API Documentation
311
+ #
312
+ class CreateDedicatedIpPoolResponse < Aws::EmptyStructure; end
313
+
314
+ # A request to begin the verification process for an email identity (an
315
+ # email address or domain).
316
+ #
317
+ # @note When making an API call, you may pass CreateEmailIdentityRequest
318
+ # data as a hash:
319
+ #
320
+ # {
321
+ # email_identity: "Identity", # required
322
+ # }
323
+ #
324
+ # @!attribute [rw] email_identity
325
+ # The email address or domain that you want to verify.
326
+ # @return [String]
327
+ #
328
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26/CreateEmailIdentityRequest AWS API Documentation
329
+ #
330
+ class CreateEmailIdentityRequest < Struct.new(
331
+ :email_identity)
332
+ include Aws::Structure
333
+ end
334
+
335
+ # If the email identity is a domain, this object contains tokens that
336
+ # you can use to create a set of CNAME records. To sucessfully verify
337
+ # your domain, you have to add these records to the DNS configuration
338
+ # for your domain.
339
+ #
340
+ # If the email identity is an email address, this object is empty.
341
+ #
342
+ # @!attribute [rw] identity_type
343
+ # The email identity type.
344
+ # @return [String]
345
+ #
346
+ # @!attribute [rw] verified_for_sending_status
347
+ # Specifies whether or not the identity is verified. In Amazon
348
+ # Pinpoint, you can only send email from verified email addresses or
349
+ # domains. For more information about verifying identities, see the
350
+ # [Amazon Pinpoint User Guide][1].
351
+ #
352
+ #
353
+ #
354
+ # [1]: http://docs.aws.amazon.com/pinpoint/latest/userguide/channels-email-manage-verify.html
355
+ # @return [Boolean]
356
+ #
357
+ # @!attribute [rw] dkim_attributes
358
+ # An object that contains information about the DKIM attributes for
359
+ # the identity. This object includes the tokens that you use to create
360
+ # the CNAME records that are required to complete the DKIM
361
+ # verification process.
362
+ # @return [Types::DkimAttributes]
363
+ #
364
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26/CreateEmailIdentityResponse AWS API Documentation
365
+ #
366
+ class CreateEmailIdentityResponse < Struct.new(
367
+ :identity_type,
368
+ :verified_for_sending_status,
369
+ :dkim_attributes)
370
+ include Aws::Structure
371
+ end
372
+
373
+ # Contains information about a dedicated IP address that is associated
374
+ # with your Amazon Pinpoint account.
375
+ #
376
+ # @!attribute [rw] ip
377
+ # An IP address that is reserved for use by your Amazon Pinpoint
378
+ # account.
379
+ # @return [String]
380
+ #
381
+ # @!attribute [rw] warmup_status
382
+ # The warm-up status of a dedicated IP address. The status can have
383
+ # one of the following values:
384
+ #
385
+ # * `IN_PROGRESS` – The IP address isn't ready to use because the
386
+ # dedicated IP warm-up process is ongoing.
387
+ #
388
+ # * `DONE` – The dedicated IP warm-up process is complete, and the IP
389
+ # address is ready to use.
390
+ # @return [String]
391
+ #
392
+ # @!attribute [rw] warmup_percentage
393
+ # Indicates how complete the dedicated IP warm-up process is. When
394
+ # this value equals 1, the address has completed the warm-up process
395
+ # and is ready for use.
396
+ # @return [Integer]
397
+ #
398
+ # @!attribute [rw] pool_name
399
+ # The name of the dedicated IP pool that the IP address is associated
400
+ # with.
401
+ # @return [String]
402
+ #
403
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26/DedicatedIp AWS API Documentation
404
+ #
405
+ class DedicatedIp < Struct.new(
406
+ :ip,
407
+ :warmup_status,
408
+ :warmup_percentage,
409
+ :pool_name)
410
+ include Aws::Structure
411
+ end
412
+
413
+ # A request to delete an event destination from a configuration set.
414
+ #
415
+ # @note When making an API call, you may pass DeleteConfigurationSetEventDestinationRequest
416
+ # data as a hash:
417
+ #
418
+ # {
419
+ # configuration_set_name: "ConfigurationSetName", # required
420
+ # event_destination_name: "EventDestinationName", # required
421
+ # }
422
+ #
423
+ # @!attribute [rw] configuration_set_name
424
+ # The name of the configuration set that contains the event
425
+ # destination that you want to delete.
426
+ # @return [String]
427
+ #
428
+ # @!attribute [rw] event_destination_name
429
+ # The name of the event destination that you want to delete.
430
+ # @return [String]
431
+ #
432
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26/DeleteConfigurationSetEventDestinationRequest AWS API Documentation
433
+ #
434
+ class DeleteConfigurationSetEventDestinationRequest < Struct.new(
435
+ :configuration_set_name,
436
+ :event_destination_name)
437
+ include Aws::Structure
438
+ end
439
+
440
+ # An HTTP 200 response if the request succeeds, or an error message if
441
+ # the request fails.
442
+ #
443
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26/DeleteConfigurationSetEventDestinationResponse AWS API Documentation
444
+ #
445
+ class DeleteConfigurationSetEventDestinationResponse < Aws::EmptyStructure; end
446
+
447
+ # A request to delete a configuration set.
448
+ #
449
+ # @note When making an API call, you may pass DeleteConfigurationSetRequest
450
+ # data as a hash:
451
+ #
452
+ # {
453
+ # configuration_set_name: "ConfigurationSetName", # required
454
+ # }
455
+ #
456
+ # @!attribute [rw] configuration_set_name
457
+ # The name of the configuration set that you want to delete.
458
+ # @return [String]
459
+ #
460
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26/DeleteConfigurationSetRequest AWS API Documentation
461
+ #
462
+ class DeleteConfigurationSetRequest < Struct.new(
463
+ :configuration_set_name)
464
+ include Aws::Structure
465
+ end
466
+
467
+ # An HTTP 200 response if the request succeeds, or an error message if
468
+ # the request fails.
469
+ #
470
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26/DeleteConfigurationSetResponse AWS API Documentation
471
+ #
472
+ class DeleteConfigurationSetResponse < Aws::EmptyStructure; end
473
+
474
+ # A request to delete a dedicated IP pool.
475
+ #
476
+ # @note When making an API call, you may pass DeleteDedicatedIpPoolRequest
477
+ # data as a hash:
478
+ #
479
+ # {
480
+ # pool_name: "PoolName", # required
481
+ # }
482
+ #
483
+ # @!attribute [rw] pool_name
484
+ # The name of the dedicated IP pool that you want to delete.
485
+ # @return [String]
486
+ #
487
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26/DeleteDedicatedIpPoolRequest AWS API Documentation
488
+ #
489
+ class DeleteDedicatedIpPoolRequest < Struct.new(
490
+ :pool_name)
491
+ include Aws::Structure
492
+ end
493
+
494
+ # An HTTP 200 response if the request succeeds, or an error message if
495
+ # the request fails.
496
+ #
497
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26/DeleteDedicatedIpPoolResponse AWS API Documentation
498
+ #
499
+ class DeleteDedicatedIpPoolResponse < Aws::EmptyStructure; end
500
+
501
+ # A request to delete an existing email identity. When you delete an
502
+ # identity, you lose the ability to use Amazon Pinpoint to send email
503
+ # from that identity. You can restore your ability to send email by
504
+ # completing the verification process for the identity again.
505
+ #
506
+ # @note When making an API call, you may pass DeleteEmailIdentityRequest
507
+ # data as a hash:
508
+ #
509
+ # {
510
+ # email_identity: "Identity", # required
511
+ # }
512
+ #
513
+ # @!attribute [rw] email_identity
514
+ # The identity (that is, the email address or domain) that you want to
515
+ # delete from your Amazon Pinpoint account.
516
+ # @return [String]
517
+ #
518
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26/DeleteEmailIdentityRequest AWS API Documentation
519
+ #
520
+ class DeleteEmailIdentityRequest < Struct.new(
521
+ :email_identity)
522
+ include Aws::Structure
523
+ end
524
+
525
+ # An HTTP 200 response if the request succeeds, or an error message if
526
+ # the request fails.
527
+ #
528
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26/DeleteEmailIdentityResponse AWS API Documentation
529
+ #
530
+ class DeleteEmailIdentityResponse < Aws::EmptyStructure; end
531
+
532
+ # Used to associate a configuration set with a dedicated IP pool.
533
+ #
534
+ # @note When making an API call, you may pass DeliveryOptions
535
+ # data as a hash:
536
+ #
537
+ # {
538
+ # sending_pool_name: "PoolName",
539
+ # }
540
+ #
541
+ # @!attribute [rw] sending_pool_name
542
+ # The name of the dedicated IP pool that you want to associate with
543
+ # the configuration set.
544
+ # @return [String]
545
+ #
546
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26/DeliveryOptions AWS API Documentation
547
+ #
548
+ class DeliveryOptions < Struct.new(
549
+ :sending_pool_name)
550
+ include Aws::Structure
551
+ end
552
+
553
+ # An object that describes the recipients for an email.
554
+ #
555
+ # @note When making an API call, you may pass Destination
556
+ # data as a hash:
557
+ #
558
+ # {
559
+ # to_addresses: ["EmailAddress"],
560
+ # cc_addresses: ["EmailAddress"],
561
+ # bcc_addresses: ["EmailAddress"],
562
+ # }
563
+ #
564
+ # @!attribute [rw] to_addresses
565
+ # An array that contains the email addresses of the "To" recipients
566
+ # for the email.
567
+ # @return [Array<String>]
568
+ #
569
+ # @!attribute [rw] cc_addresses
570
+ # An array that contains the email addresses of the "CC" (carbon
571
+ # copy) recipients for the email.
572
+ # @return [Array<String>]
573
+ #
574
+ # @!attribute [rw] bcc_addresses
575
+ # An array that contains the email addresses of the "BCC" (blind
576
+ # carbon copy) recipients for the email.
577
+ # @return [Array<String>]
578
+ #
579
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26/Destination AWS API Documentation
580
+ #
581
+ class Destination < Struct.new(
582
+ :to_addresses,
583
+ :cc_addresses,
584
+ :bcc_addresses)
585
+ include Aws::Structure
586
+ end
587
+
588
+ # An object that contains information about the DKIM configuration for
589
+ # an email identity.
590
+ #
591
+ # @!attribute [rw] signing_enabled
592
+ # If the value is `true`, then the messages that Amazon Pinpoint sends
593
+ # from the identity are DKIM-signed. If the value is `false`, then the
594
+ # messages that Amazon Pinpoint sends from the identity aren't
595
+ # DKIM-signed.
596
+ # @return [Boolean]
597
+ #
598
+ # @!attribute [rw] status
599
+ # Describes whether or not Amazon Pinpoint has successfully located
600
+ # the DKIM records in the DNS records for the domain. The status can
601
+ # be one of the following:
602
+ #
603
+ # * `PENDING` – Amazon Pinpoint hasn't yet located the DKIM records
604
+ # in the DNS configuration for the domain, but will continue to
605
+ # attempt to locate them.
606
+ #
607
+ # * `SUCCESS` – Amazon Pinpoint located the DKIM records in the DNS
608
+ # configuration for the domain and determined that they're correct.
609
+ # Amazon Pinpoint can now send DKIM-signed email from the identity.
610
+ #
611
+ # * `FAILED` – Amazon Pinpoint was unable to locate the DKIM records
612
+ # in the DNS settings for the domain, and won't continue to search
613
+ # for them.
614
+ #
615
+ # * `TEMPORARY_FAILURE` – A temporary issue occurred, which prevented
616
+ # Amazon Pinpoint from determining the DKIM status for the domain.
617
+ #
618
+ # * `NOT_STARTED` – Amazon Pinpoint hasn't yet started searching for
619
+ # the DKIM records in the DKIM records for the domain.
620
+ # @return [String]
621
+ #
622
+ # @!attribute [rw] tokens
623
+ # A set of unique strings that you use to create a set of CNAME
624
+ # records that you add to the DNS configuration for your domain. When
625
+ # Amazon Pinpoint detects these records in the DNS configuration for
626
+ # your domain, the DKIM authentication process is complete. Amazon
627
+ # Pinpoint usually detects these records within about 72 hours of
628
+ # adding them to the DNS configuration for your domain.
629
+ # @return [Array<String>]
630
+ #
631
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26/DkimAttributes AWS API Documentation
632
+ #
633
+ class DkimAttributes < Struct.new(
634
+ :signing_enabled,
635
+ :status,
636
+ :tokens)
637
+ include Aws::Structure
638
+ end
639
+
640
+ # An object that defines the entire content of the email, including the
641
+ # message headers and the body content. You can create a simple email
642
+ # message, in which you specify the subject and the text and HTML
643
+ # versions of the message body. You can also create raw messages, in
644
+ # which you specify a complete MIME-formatted message. Raw messages can
645
+ # include attachments and custom headers.
646
+ #
647
+ # @note When making an API call, you may pass EmailContent
648
+ # data as a hash:
649
+ #
650
+ # {
651
+ # simple: {
652
+ # subject: { # required
653
+ # data: "MessageData", # required
654
+ # charset: "Charset",
655
+ # },
656
+ # body: { # required
657
+ # text: {
658
+ # data: "MessageData", # required
659
+ # charset: "Charset",
660
+ # },
661
+ # html: {
662
+ # data: "MessageData", # required
663
+ # charset: "Charset",
664
+ # },
665
+ # },
666
+ # },
667
+ # raw: {
668
+ # data: "data", # required
669
+ # },
670
+ # }
671
+ #
672
+ # @!attribute [rw] simple
673
+ # The simple email message. The message consists of a subject and a
674
+ # message body.
675
+ # @return [Types::Message]
676
+ #
677
+ # @!attribute [rw] raw
678
+ # The raw email message. The message has to meet the following
679
+ # criteria:
680
+ #
681
+ # * The message has to contain a header and a body, separated by one
682
+ # blank line.
683
+ #
684
+ # * All of the required header fields must be present in the message.
685
+ #
686
+ # * Each part of a multipart MIME message must be formatted properly.
687
+ #
688
+ # * If you include attachments, they must be in a file format that
689
+ # Amazon Pinpoint supports.
690
+ #
691
+ # * The entire message must be Base64 encoded.
692
+ #
693
+ # * If any of the MIME parts in your message contain content that is
694
+ # outside of the 7-bit ASCII character range, you should encode that
695
+ # content to ensure that recipients' email clients render the
696
+ # message properly.
697
+ #
698
+ # * The length of any single line of text in the message can't exceed
699
+ # 1,000 characters. This restriction is defined in [RFC 5321][1].
700
+ #
701
+ #
702
+ #
703
+ # [1]: https://tools.ietf.org/html/rfc5321
704
+ # @return [Types::RawMessage]
705
+ #
706
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26/EmailContent AWS API Documentation
707
+ #
708
+ class EmailContent < Struct.new(
709
+ :simple,
710
+ :raw)
711
+ include Aws::Structure
712
+ end
713
+
714
+ # In Amazon Pinpoint, *events* include message sends, deliveries, opens,
715
+ # clicks, bounces, and complaints. *Event destinations* are places that
716
+ # you can send information about these events to. For example, you can
717
+ # send event data to Amazon SNS to receive notifications when you
718
+ # receive bounces or complaints, or you can use Amazon Kinesis Data
719
+ # Firehose to stream data to Amazon S3 for long-term storage.
720
+ #
721
+ # @!attribute [rw] name
722
+ # A name that identifies the event destination.
723
+ # @return [String]
724
+ #
725
+ # @!attribute [rw] enabled
726
+ # If `true`, the event destination is enabled. When the event
727
+ # destination is enabled, the specified event types are sent to the
728
+ # destinations in this `EventDestinationDefinition`.
729
+ #
730
+ # If `false`, the event destination is disabled. When the event
731
+ # destination is disabled, events aren't sent to the specified
732
+ # destinations.
733
+ # @return [Boolean]
734
+ #
735
+ # @!attribute [rw] matching_event_types
736
+ # The types of events that Amazon Pinpoint sends to the specified
737
+ # event destinations.
738
+ # @return [Array<String>]
739
+ #
740
+ # @!attribute [rw] kinesis_firehose_destination
741
+ # An object that defines an Amazon Kinesis Data Firehose destination
742
+ # for email events. You can use Amazon Kinesis Data Firehose to stream
743
+ # data to other services, such as Amazon S3 and Amazon Redshift.
744
+ # @return [Types::KinesisFirehoseDestination]
745
+ #
746
+ # @!attribute [rw] cloud_watch_destination
747
+ # An object that defines an Amazon CloudWatch destination for email
748
+ # events. You can use Amazon CloudWatch to monitor and gain insights
749
+ # on your email sending metrics.
750
+ # @return [Types::CloudWatchDestination]
751
+ #
752
+ # @!attribute [rw] sns_destination
753
+ # An object that defines an Amazon SNS destination for email events.
754
+ # You can use Amazon SNS to send notification when certain email
755
+ # events occur.
756
+ # @return [Types::SnsDestination]
757
+ #
758
+ # @!attribute [rw] pinpoint_destination
759
+ # An object that defines a Amazon Pinpoint destination for email
760
+ # events. You can use Amazon Pinpoint events to create attributes in
761
+ # Amazon Pinpoint projects. You can use these attributes to create
762
+ # segments for your campaigns.
763
+ # @return [Types::PinpointDestination]
764
+ #
765
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26/EventDestination AWS API Documentation
766
+ #
767
+ class EventDestination < Struct.new(
768
+ :name,
769
+ :enabled,
770
+ :matching_event_types,
771
+ :kinesis_firehose_destination,
772
+ :cloud_watch_destination,
773
+ :sns_destination,
774
+ :pinpoint_destination)
775
+ include Aws::Structure
776
+ end
777
+
778
+ # An object that defines the event destination. Specifically, it defines
779
+ # which services receive events from emails sent using the configuration
780
+ # set that the event destination is associated with. Also defines the
781
+ # types of events that are sent to the event destination.
782
+ #
783
+ # @note When making an API call, you may pass EventDestinationDefinition
784
+ # data as a hash:
785
+ #
786
+ # {
787
+ # enabled: false,
788
+ # matching_event_types: ["SEND"], # accepts SEND, REJECT, BOUNCE, COMPLAINT, DELIVERY, OPEN, CLICK, RENDERING_FAILURE
789
+ # kinesis_firehose_destination: {
790
+ # iam_role_arn: "AmazonResourceName", # required
791
+ # delivery_stream_arn: "AmazonResourceName", # required
792
+ # },
793
+ # cloud_watch_destination: {
794
+ # dimension_configurations: [ # required
795
+ # {
796
+ # dimension_name: "DimensionName", # required
797
+ # dimension_value_source: "MESSAGE_TAG", # required, accepts MESSAGE_TAG, EMAIL_HEADER, LINK_TAG
798
+ # default_dimension_value: "DefaultDimensionValue", # required
799
+ # },
800
+ # ],
801
+ # },
802
+ # sns_destination: {
803
+ # topic_arn: "AmazonResourceName", # required
804
+ # },
805
+ # pinpoint_destination: {
806
+ # application_arn: "AmazonResourceName",
807
+ # },
808
+ # }
809
+ #
810
+ # @!attribute [rw] enabled
811
+ # If `true`, the event destination is enabled. When the event
812
+ # destination is enabled, the specified event types are sent to the
813
+ # destinations in this `EventDestinationDefinition`.
814
+ #
815
+ # If `false`, the event destination is disabled. When the event
816
+ # destination is disabled, events aren't sent to the specified
817
+ # destinations.
818
+ # @return [Boolean]
819
+ #
820
+ # @!attribute [rw] matching_event_types
821
+ # An array that specifies which events Amazon Pinpoint should send to
822
+ # the destinations in this `EventDestinationDefinition`.
823
+ # @return [Array<String>]
824
+ #
825
+ # @!attribute [rw] kinesis_firehose_destination
826
+ # An object that defines an Amazon Kinesis Data Firehose destination
827
+ # for email events. You can use Amazon Kinesis Data Firehose to stream
828
+ # data to other services, such as Amazon S3 and Amazon Redshift.
829
+ # @return [Types::KinesisFirehoseDestination]
830
+ #
831
+ # @!attribute [rw] cloud_watch_destination
832
+ # An object that defines an Amazon CloudWatch destination for email
833
+ # events. You can use Amazon CloudWatch to monitor and gain insights
834
+ # on your email sending metrics.
835
+ # @return [Types::CloudWatchDestination]
836
+ #
837
+ # @!attribute [rw] sns_destination
838
+ # An object that defines an Amazon SNS destination for email events.
839
+ # You can use Amazon SNS to send notification when certain email
840
+ # events occur.
841
+ # @return [Types::SnsDestination]
842
+ #
843
+ # @!attribute [rw] pinpoint_destination
844
+ # An object that defines a Amazon Pinpoint destination for email
845
+ # events. You can use Amazon Pinpoint events to create attributes in
846
+ # Amazon Pinpoint projects. You can use these attributes to create
847
+ # segments for your campaigns.
848
+ # @return [Types::PinpointDestination]
849
+ #
850
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26/EventDestinationDefinition AWS API Documentation
851
+ #
852
+ class EventDestinationDefinition < Struct.new(
853
+ :enabled,
854
+ :matching_event_types,
855
+ :kinesis_firehose_destination,
856
+ :cloud_watch_destination,
857
+ :sns_destination,
858
+ :pinpoint_destination)
859
+ include Aws::Structure
860
+ end
861
+
862
+ # A request to obtain information about the email-sending capabilities
863
+ # of your Amazon Pinpoint account.
864
+ #
865
+ # @api private
866
+ #
867
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26/GetAccountRequest AWS API Documentation
868
+ #
869
+ class GetAccountRequest < Aws::EmptyStructure; end
870
+
871
+ # A list of details about the email-sending capabilities of your Amazon
872
+ # Pinpoint account in the current AWS Region.
873
+ #
874
+ # @!attribute [rw] send_quota
875
+ # An object that contains information about the per-day and per-second
876
+ # sending limits for your Amazon Pinpoint account in the current AWS
877
+ # Region.
878
+ # @return [Types::SendQuota]
879
+ #
880
+ # @!attribute [rw] sending_enabled
881
+ # Indicates whether or not email sending is enabled for your Amazon
882
+ # Pinpoint account in the current AWS Region.
883
+ # @return [Boolean]
884
+ #
885
+ # @!attribute [rw] dedicated_ip_auto_warmup_enabled
886
+ # Indicates whether or not the automatic warm-up feature is enabled
887
+ # for dedicated IP addresses that are associated with your account.
888
+ # @return [Boolean]
889
+ #
890
+ # @!attribute [rw] enforcement_status
891
+ # The reputation status of your Amazon Pinpoint account. The status
892
+ # can be one of the following:
893
+ #
894
+ # * `HEALTHY` – There are no reputation-related issues that currently
895
+ # impact your account.
896
+ #
897
+ # * `PROBATION` – We've identified some issues with your Amazon
898
+ # Pinpoint account. We're placing your account under review while
899
+ # you work on correcting these issues.
900
+ #
901
+ # * `SHUTDOWN` – Your account's ability to send email is currently
902
+ # paused because of an issue with the email sent from your account.
903
+ # When you correct the issue, you can contact us and request that
904
+ # your account's ability to send email is resumed.
905
+ # @return [String]
906
+ #
907
+ # @!attribute [rw] production_access_enabled
908
+ # Indicates whether or not your account has production access in the
909
+ # current AWS Region.
910
+ #
911
+ # If the value is `false`, then your account is in the *sandbox*. When
912
+ # your account is in the sandbox, you can only send email to verified
913
+ # identities. Additionally, the maximum number of emails you can send
914
+ # in a 24-hour period (your sending quota) is 200, and the maximum
915
+ # number of emails you can send per second (your maximum sending rate)
916
+ # is 1.
917
+ #
918
+ # If the value is `true`, then your account has production access.
919
+ # When your account has production access, you can send email to any
920
+ # address. The sending quota and maximum sending rate for your account
921
+ # vary based on your specific use case.
922
+ # @return [Boolean]
923
+ #
924
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26/GetAccountResponse AWS API Documentation
925
+ #
926
+ class GetAccountResponse < Struct.new(
927
+ :send_quota,
928
+ :sending_enabled,
929
+ :dedicated_ip_auto_warmup_enabled,
930
+ :enforcement_status,
931
+ :production_access_enabled)
932
+ include Aws::Structure
933
+ end
934
+
935
+ # A request to obtain information about the event destinations for a
936
+ # configuration set.
937
+ #
938
+ # @note When making an API call, you may pass GetConfigurationSetEventDestinationsRequest
939
+ # data as a hash:
940
+ #
941
+ # {
942
+ # configuration_set_name: "ConfigurationSetName", # required
943
+ # }
944
+ #
945
+ # @!attribute [rw] configuration_set_name
946
+ # The name of the configuration set that contains the event
947
+ # destination.
948
+ # @return [String]
949
+ #
950
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26/GetConfigurationSetEventDestinationsRequest AWS API Documentation
951
+ #
952
+ class GetConfigurationSetEventDestinationsRequest < Struct.new(
953
+ :configuration_set_name)
954
+ include Aws::Structure
955
+ end
956
+
957
+ # Information about an event destination for a configuration set.
958
+ #
959
+ # @!attribute [rw] event_destinations
960
+ # An array that includes all of the events destinations that have been
961
+ # configured for the configuration set.
962
+ # @return [Array<Types::EventDestination>]
963
+ #
964
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26/GetConfigurationSetEventDestinationsResponse AWS API Documentation
965
+ #
966
+ class GetConfigurationSetEventDestinationsResponse < Struct.new(
967
+ :event_destinations)
968
+ include Aws::Structure
969
+ end
970
+
971
+ # A request to obtain information about a configuration set.
972
+ #
973
+ # @note When making an API call, you may pass GetConfigurationSetRequest
974
+ # data as a hash:
975
+ #
976
+ # {
977
+ # configuration_set_name: "ConfigurationSetName", # required
978
+ # }
979
+ #
980
+ # @!attribute [rw] configuration_set_name
981
+ # The name of the configuration set that you want to obtain more
982
+ # information about.
983
+ # @return [String]
984
+ #
985
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26/GetConfigurationSetRequest AWS API Documentation
986
+ #
987
+ class GetConfigurationSetRequest < Struct.new(
988
+ :configuration_set_name)
989
+ include Aws::Structure
990
+ end
991
+
992
+ # Information about a configuration set.
993
+ #
994
+ # @!attribute [rw] configuration_set_name
995
+ # The name of the configuration set.
996
+ # @return [String]
997
+ #
998
+ # @!attribute [rw] tracking_options
999
+ # An object that defines the open and click tracking options for
1000
+ # emails that you send using the configuration set.
1001
+ # @return [Types::TrackingOptions]
1002
+ #
1003
+ # @!attribute [rw] delivery_options
1004
+ # An object that defines the dedicated IP pool that is used to send
1005
+ # emails that you send using the configuration set.
1006
+ # @return [Types::DeliveryOptions]
1007
+ #
1008
+ # @!attribute [rw] reputation_options
1009
+ # An object that defines whether or not Amazon Pinpoint collects
1010
+ # reputation metrics for the emails that you send that use the
1011
+ # configuration set.
1012
+ # @return [Types::ReputationOptions]
1013
+ #
1014
+ # @!attribute [rw] sending_options
1015
+ # An object that defines whether or not Amazon Pinpoint can send email
1016
+ # that you send using the configuration set.
1017
+ # @return [Types::SendingOptions]
1018
+ #
1019
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26/GetConfigurationSetResponse AWS API Documentation
1020
+ #
1021
+ class GetConfigurationSetResponse < Struct.new(
1022
+ :configuration_set_name,
1023
+ :tracking_options,
1024
+ :delivery_options,
1025
+ :reputation_options,
1026
+ :sending_options)
1027
+ include Aws::Structure
1028
+ end
1029
+
1030
+ # A request to obtain more information about a dedicated IP address.
1031
+ #
1032
+ # @note When making an API call, you may pass GetDedicatedIpRequest
1033
+ # data as a hash:
1034
+ #
1035
+ # {
1036
+ # ip: "Ip", # required
1037
+ # }
1038
+ #
1039
+ # @!attribute [rw] ip
1040
+ # The IP address that you want to obtain more information about. The
1041
+ # value you specify has to be a dedicated IP address that's
1042
+ # assocaited with your Amazon Pinpoint account.
1043
+ # @return [String]
1044
+ #
1045
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26/GetDedicatedIpRequest AWS API Documentation
1046
+ #
1047
+ class GetDedicatedIpRequest < Struct.new(
1048
+ :ip)
1049
+ include Aws::Structure
1050
+ end
1051
+
1052
+ # Information about a dedicated IP address.
1053
+ #
1054
+ # @!attribute [rw] dedicated_ip
1055
+ # An object that contains information about a dedicated IP address.
1056
+ # @return [Types::DedicatedIp]
1057
+ #
1058
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26/GetDedicatedIpResponse AWS API Documentation
1059
+ #
1060
+ class GetDedicatedIpResponse < Struct.new(
1061
+ :dedicated_ip)
1062
+ include Aws::Structure
1063
+ end
1064
+
1065
+ # A request to obtain more information about dedicated IP pools.
1066
+ #
1067
+ # @note When making an API call, you may pass GetDedicatedIpsRequest
1068
+ # data as a hash:
1069
+ #
1070
+ # {
1071
+ # pool_name: "PoolName",
1072
+ # next_token: "NextToken",
1073
+ # page_size: 1,
1074
+ # }
1075
+ #
1076
+ # @!attribute [rw] pool_name
1077
+ # The name of the IP pool that the dedicated IP address is associated
1078
+ # with.
1079
+ # @return [String]
1080
+ #
1081
+ # @!attribute [rw] next_token
1082
+ # A token returned from a previous call to `GetDedicatedIps` to
1083
+ # indicate the position of the dedicated IP pool in the list of IP
1084
+ # pools.
1085
+ # @return [String]
1086
+ #
1087
+ # @!attribute [rw] page_size
1088
+ # The number of results to show in a single call to
1089
+ # `GetDedicatedIpsRequest`. If the number of results is larger than
1090
+ # the number you specified in this parameter, then the response
1091
+ # includes a `NextToken` element, which you can use to obtain
1092
+ # additional results.
1093
+ # @return [Integer]
1094
+ #
1095
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26/GetDedicatedIpsRequest AWS API Documentation
1096
+ #
1097
+ class GetDedicatedIpsRequest < Struct.new(
1098
+ :pool_name,
1099
+ :next_token,
1100
+ :page_size)
1101
+ include Aws::Structure
1102
+ end
1103
+
1104
+ # Information about the dedicated IP addresses that are associated with
1105
+ # your Amazon Pinpoint account.
1106
+ #
1107
+ # @!attribute [rw] dedicated_ips
1108
+ # A list of dedicated IP addresses that are reserved for use by your
1109
+ # Amazon Pinpoint account.
1110
+ # @return [Array<Types::DedicatedIp>]
1111
+ #
1112
+ # @!attribute [rw] next_token
1113
+ # A token that indicates that there are additional dedicated IP
1114
+ # addresses to list. To view additional addresses, issue another
1115
+ # request to `GetDedicatedIps`, passing this token in the `NextToken`
1116
+ # parameter.
1117
+ # @return [String]
1118
+ #
1119
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26/GetDedicatedIpsResponse AWS API Documentation
1120
+ #
1121
+ class GetDedicatedIpsResponse < Struct.new(
1122
+ :dedicated_ips,
1123
+ :next_token)
1124
+ include Aws::Structure
1125
+ end
1126
+
1127
+ # A request to return details about an email identity.
1128
+ #
1129
+ # @note When making an API call, you may pass GetEmailIdentityRequest
1130
+ # data as a hash:
1131
+ #
1132
+ # {
1133
+ # email_identity: "Identity", # required
1134
+ # }
1135
+ #
1136
+ # @!attribute [rw] email_identity
1137
+ # The email identity that you want to retrieve details for.
1138
+ # @return [String]
1139
+ #
1140
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26/GetEmailIdentityRequest AWS API Documentation
1141
+ #
1142
+ class GetEmailIdentityRequest < Struct.new(
1143
+ :email_identity)
1144
+ include Aws::Structure
1145
+ end
1146
+
1147
+ # Details about an email identity.
1148
+ #
1149
+ # @!attribute [rw] identity_type
1150
+ # The email identity type.
1151
+ # @return [String]
1152
+ #
1153
+ # @!attribute [rw] feedback_forwarding_status
1154
+ # The feedback forwarding configuration for the identity.
1155
+ #
1156
+ # If the value is `true`, Amazon Pinpoint sends you email
1157
+ # notifications when bounce or complaint events occur. Amazon Pinpoint
1158
+ # sends this notification to the address that you specified in the
1159
+ # Return-Path header of the original email.
1160
+ #
1161
+ # When you set this value to `false`, Amazon Pinpoint sends
1162
+ # notifications through other mechanisms, such as by notifying an
1163
+ # Amazon SNS topic or another event destination. You're required to
1164
+ # have a method of tracking bounces and complaints. If you haven't
1165
+ # set up another mechanism for receiving bounce or complaint
1166
+ # notifications, Amazon Pinpoint sends an email notification when
1167
+ # these events occur (even if this setting is disabled).
1168
+ # @return [Boolean]
1169
+ #
1170
+ # @!attribute [rw] verified_for_sending_status
1171
+ # Specifies whether or not the identity is verified. In Amazon
1172
+ # Pinpoint, you can only send email from verified email addresses or
1173
+ # domains. For more information about verifying identities, see the
1174
+ # [Amazon Pinpoint User Guide][1].
1175
+ #
1176
+ #
1177
+ #
1178
+ # [1]: http://docs.aws.amazon.com/pinpoint/latest/userguide/channels-email-manage-verify.html
1179
+ # @return [Boolean]
1180
+ #
1181
+ # @!attribute [rw] dkim_attributes
1182
+ # An object that contains information about the DKIM attributes for
1183
+ # the identity. This object includes the tokens that you use to create
1184
+ # the CNAME records that are required to complete the DKIM
1185
+ # verification process.
1186
+ # @return [Types::DkimAttributes]
1187
+ #
1188
+ # @!attribute [rw] mail_from_attributes
1189
+ # An object that contains information about the Mail-From attributes
1190
+ # for the email identity.
1191
+ # @return [Types::MailFromAttributes]
1192
+ #
1193
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26/GetEmailIdentityResponse AWS API Documentation
1194
+ #
1195
+ class GetEmailIdentityResponse < Struct.new(
1196
+ :identity_type,
1197
+ :feedback_forwarding_status,
1198
+ :verified_for_sending_status,
1199
+ :dkim_attributes,
1200
+ :mail_from_attributes)
1201
+ include Aws::Structure
1202
+ end
1203
+
1204
+ # Information about an email identity.
1205
+ #
1206
+ # @!attribute [rw] identity_type
1207
+ # The email identity type. The identity type can be one of the
1208
+ # following:
1209
+ #
1210
+ # * `EMAIL_ADDRESS` – The identity is an email address.
1211
+ #
1212
+ # * `DOMAIN` – The identity is a domain.
1213
+ #
1214
+ # * `MANAGED_DOMAIN` – The identity is a domain that is managed by
1215
+ # AWS.
1216
+ # @return [String]
1217
+ #
1218
+ # @!attribute [rw] identity_name
1219
+ # The address or domain of the identity.
1220
+ # @return [String]
1221
+ #
1222
+ # @!attribute [rw] sending_enabled
1223
+ # Indicates whether or not you can send email from the identity.
1224
+ #
1225
+ # In Amazon Pinpoint, an identity is an email address or domain that
1226
+ # you send email from. Before you can send email from an identity, you
1227
+ # have to demostrate that you own the identity, and that you authorize
1228
+ # Amazon Pinpoint to send email from that identity.
1229
+ # @return [Boolean]
1230
+ #
1231
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26/IdentityInfo AWS API Documentation
1232
+ #
1233
+ class IdentityInfo < Struct.new(
1234
+ :identity_type,
1235
+ :identity_name,
1236
+ :sending_enabled)
1237
+ include Aws::Structure
1238
+ end
1239
+
1240
+ # An object that defines an Amazon Kinesis Data Firehose destination for
1241
+ # email events. You can use Amazon Kinesis Data Firehose to stream data
1242
+ # to other services, such as Amazon S3 and Amazon Redshift.
1243
+ #
1244
+ # @note When making an API call, you may pass KinesisFirehoseDestination
1245
+ # data as a hash:
1246
+ #
1247
+ # {
1248
+ # iam_role_arn: "AmazonResourceName", # required
1249
+ # delivery_stream_arn: "AmazonResourceName", # required
1250
+ # }
1251
+ #
1252
+ # @!attribute [rw] iam_role_arn
1253
+ # The Amazon Resource Name (ARN) of the IAM role that Amazon Pinpoint
1254
+ # uses when sending email events to the Amazon Kinesis Data Firehose
1255
+ # stream.
1256
+ # @return [String]
1257
+ #
1258
+ # @!attribute [rw] delivery_stream_arn
1259
+ # The Amazon Resource Name (ARN) of the Amazon Kinesis Data Firehose
1260
+ # stream that Amazon Pinpoint sends email events to.
1261
+ # @return [String]
1262
+ #
1263
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26/KinesisFirehoseDestination AWS API Documentation
1264
+ #
1265
+ class KinesisFirehoseDestination < Struct.new(
1266
+ :iam_role_arn,
1267
+ :delivery_stream_arn)
1268
+ include Aws::Structure
1269
+ end
1270
+
1271
+ # A request to obtain a list of configuration sets for your Amazon
1272
+ # Pinpoint account in the current AWS Region.
1273
+ #
1274
+ # @note When making an API call, you may pass ListConfigurationSetsRequest
1275
+ # data as a hash:
1276
+ #
1277
+ # {
1278
+ # next_token: "NextToken",
1279
+ # page_size: 1,
1280
+ # }
1281
+ #
1282
+ # @!attribute [rw] next_token
1283
+ # A token returned from a previous call to `ListConfigurationSets` to
1284
+ # indicate the position in the list of configuration sets.
1285
+ # @return [String]
1286
+ #
1287
+ # @!attribute [rw] page_size
1288
+ # The number of results to show in a single call to
1289
+ # `ListConfigurationSets`. If the number of results is larger than the
1290
+ # number you specified in this parameter, then the response includes a
1291
+ # `NextToken` element, which you can use to obtain additional results.
1292
+ # @return [Integer]
1293
+ #
1294
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26/ListConfigurationSetsRequest AWS API Documentation
1295
+ #
1296
+ class ListConfigurationSetsRequest < Struct.new(
1297
+ :next_token,
1298
+ :page_size)
1299
+ include Aws::Structure
1300
+ end
1301
+
1302
+ # A list of configuration sets in your Amazon Pinpoint account in the
1303
+ # current AWS Region.
1304
+ #
1305
+ # @!attribute [rw] configuration_sets
1306
+ # An array that contains all of the configuration sets in your Amazon
1307
+ # Pinpoint account in the current AWS Region.
1308
+ # @return [Array<String>]
1309
+ #
1310
+ # @!attribute [rw] next_token
1311
+ # A token that indicates that there are additional configuration sets
1312
+ # to list. To view additional configuration sets, issue another
1313
+ # request to `ListConfigurationSets`, and pass this token in the
1314
+ # `NextToken` parameter.
1315
+ # @return [String]
1316
+ #
1317
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26/ListConfigurationSetsResponse AWS API Documentation
1318
+ #
1319
+ class ListConfigurationSetsResponse < Struct.new(
1320
+ :configuration_sets,
1321
+ :next_token)
1322
+ include Aws::Structure
1323
+ end
1324
+
1325
+ # A request to obtain a list of dedicated IP pools.
1326
+ #
1327
+ # @note When making an API call, you may pass ListDedicatedIpPoolsRequest
1328
+ # data as a hash:
1329
+ #
1330
+ # {
1331
+ # next_token: "NextToken",
1332
+ # page_size: 1,
1333
+ # }
1334
+ #
1335
+ # @!attribute [rw] next_token
1336
+ # A token returned from a previous call to `ListDedicatedIpPools` to
1337
+ # indicate the position in the list of dedicated IP pools.
1338
+ # @return [String]
1339
+ #
1340
+ # @!attribute [rw] page_size
1341
+ # The number of results to show in a single call to
1342
+ # `ListDedicatedIpPools`. If the number of results is larger than the
1343
+ # number you specified in this parameter, then the response includes a
1344
+ # `NextToken` element, which you can use to obtain additional results.
1345
+ # @return [Integer]
1346
+ #
1347
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26/ListDedicatedIpPoolsRequest AWS API Documentation
1348
+ #
1349
+ class ListDedicatedIpPoolsRequest < Struct.new(
1350
+ :next_token,
1351
+ :page_size)
1352
+ include Aws::Structure
1353
+ end
1354
+
1355
+ # A list of dedicated IP pools.
1356
+ #
1357
+ # @!attribute [rw] dedicated_ip_pools
1358
+ # A list of all of the dedicated IP pools that are associated with
1359
+ # your Amazon Pinpoint account.
1360
+ # @return [Array<String>]
1361
+ #
1362
+ # @!attribute [rw] next_token
1363
+ # A token that indicates that there are additional IP pools to list.
1364
+ # To view additional IP pools, issue another request to
1365
+ # `ListDedicatedIpPools`, passing this token in the `NextToken`
1366
+ # parameter.
1367
+ # @return [String]
1368
+ #
1369
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26/ListDedicatedIpPoolsResponse AWS API Documentation
1370
+ #
1371
+ class ListDedicatedIpPoolsResponse < Struct.new(
1372
+ :dedicated_ip_pools,
1373
+ :next_token)
1374
+ include Aws::Structure
1375
+ end
1376
+
1377
+ # A request to list all of the email identities associated with your
1378
+ # Amazon Pinpoint account. This list includes identities that you've
1379
+ # already verified, identities that are unverified, and identities that
1380
+ # were verified in the past, but are no longer verified.
1381
+ #
1382
+ # @note When making an API call, you may pass ListEmailIdentitiesRequest
1383
+ # data as a hash:
1384
+ #
1385
+ # {
1386
+ # next_token: "NextToken",
1387
+ # page_size: 1,
1388
+ # }
1389
+ #
1390
+ # @!attribute [rw] next_token
1391
+ # A token returned from a previous call to `ListEmailIdentities` to
1392
+ # indicate the position in the list of identities.
1393
+ # @return [String]
1394
+ #
1395
+ # @!attribute [rw] page_size
1396
+ # The number of results to show in a single call to
1397
+ # `ListEmailIdentities`. If the number of results is larger than the
1398
+ # number you specified in this parameter, then the response includes a
1399
+ # `NextToken` element, which you can use to obtain additional results.
1400
+ #
1401
+ # The value you specify has to be at least 0, and can be no more than
1402
+ # 1000.
1403
+ # @return [Integer]
1404
+ #
1405
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26/ListEmailIdentitiesRequest AWS API Documentation
1406
+ #
1407
+ class ListEmailIdentitiesRequest < Struct.new(
1408
+ :next_token,
1409
+ :page_size)
1410
+ include Aws::Structure
1411
+ end
1412
+
1413
+ # A list of all of the identities that you've attempted to verify for
1414
+ # use with Amazon Pinpoint, regardless of whether or not those
1415
+ # identities were successfully verified.
1416
+ #
1417
+ # @!attribute [rw] email_identities
1418
+ # An array that includes all of the identities associated with your
1419
+ # Amazon Pinpoint account.
1420
+ # @return [Array<Types::IdentityInfo>]
1421
+ #
1422
+ # @!attribute [rw] next_token
1423
+ # A token that indicates that there are additional configuration sets
1424
+ # to list. To view additional configuration sets, issue another
1425
+ # request to `ListEmailIdentities`, and pass this token in the
1426
+ # `NextToken` parameter.
1427
+ # @return [String]
1428
+ #
1429
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26/ListEmailIdentitiesResponse AWS API Documentation
1430
+ #
1431
+ class ListEmailIdentitiesResponse < Struct.new(
1432
+ :email_identities,
1433
+ :next_token)
1434
+ include Aws::Structure
1435
+ end
1436
+
1437
+ # A list of attributes that are associated with a MAIL FROM domain.
1438
+ #
1439
+ # @!attribute [rw] mail_from_domain
1440
+ # The name of a domain that an email identity uses as a custom MAIL
1441
+ # FROM domain.
1442
+ # @return [String]
1443
+ #
1444
+ # @!attribute [rw] mail_from_domain_status
1445
+ # The status of the MAIL FROM domain. This status can have the
1446
+ # following values:
1447
+ #
1448
+ # * `PENDING` – Amazon Pinpoint hasn't started searching for the MX
1449
+ # record yet.
1450
+ #
1451
+ # * `SUCCESS` – Amazon Pinpoint detected the required MX record for
1452
+ # the MAIL FROM domain.
1453
+ #
1454
+ # * `FAILED` – Amazon Pinpoint can't find the required MX record, or
1455
+ # the record no longer exists.
1456
+ #
1457
+ # * `TEMPORARY_FAILURE` – A temporary issue occurred, which prevented
1458
+ # Amazon Pinpoint from determining the status of the MAIL FROM
1459
+ # domain.
1460
+ # @return [String]
1461
+ #
1462
+ # @!attribute [rw] behavior_on_mx_failure
1463
+ # The action that Amazon Pinpoint to takes if it can't read the
1464
+ # required MX record for a custom MAIL FROM domain. When you set this
1465
+ # value to `UseDefaultValue`, Amazon Pinpoint uses *amazonses.com* as
1466
+ # the MAIL FROM domain. When you set this value to `RejectMessage`,
1467
+ # Amazon Pinpoint returns a `MailFromDomainNotVerified` error, and
1468
+ # doesn't attempt to deliver the email.
1469
+ #
1470
+ # These behaviors are taken when the custom MAIL FROM domain
1471
+ # configuration is in the `Pending`, `Failed`, and `TemporaryFailure`
1472
+ # states.
1473
+ # @return [String]
1474
+ #
1475
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26/MailFromAttributes AWS API Documentation
1476
+ #
1477
+ class MailFromAttributes < Struct.new(
1478
+ :mail_from_domain,
1479
+ :mail_from_domain_status,
1480
+ :behavior_on_mx_failure)
1481
+ include Aws::Structure
1482
+ end
1483
+
1484
+ # Represents the email message that you're sending. The `Message`
1485
+ # object consists of a subject line and a message body.
1486
+ #
1487
+ # @note When making an API call, you may pass Message
1488
+ # data as a hash:
1489
+ #
1490
+ # {
1491
+ # subject: { # required
1492
+ # data: "MessageData", # required
1493
+ # charset: "Charset",
1494
+ # },
1495
+ # body: { # required
1496
+ # text: {
1497
+ # data: "MessageData", # required
1498
+ # charset: "Charset",
1499
+ # },
1500
+ # html: {
1501
+ # data: "MessageData", # required
1502
+ # charset: "Charset",
1503
+ # },
1504
+ # },
1505
+ # }
1506
+ #
1507
+ # @!attribute [rw] subject
1508
+ # The subject line of the email. The subject line can only contain
1509
+ # 7-bit ASCII characters. However, you can specify non-ASCII
1510
+ # characters in the subject line by using encoded-word syntax, as
1511
+ # described in [RFC 2047][1].
1512
+ #
1513
+ #
1514
+ #
1515
+ # [1]: https://tools.ietf.org/html/rfc2047
1516
+ # @return [Types::Content]
1517
+ #
1518
+ # @!attribute [rw] body
1519
+ # The body of the message. You can specify an HTML version of the
1520
+ # message, a text-only version of the message, or both.
1521
+ # @return [Types::Body]
1522
+ #
1523
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26/Message AWS API Documentation
1524
+ #
1525
+ class Message < Struct.new(
1526
+ :subject,
1527
+ :body)
1528
+ include Aws::Structure
1529
+ end
1530
+
1531
+ # Contains the name and value of a tag that you apply to an email. You
1532
+ # can use message tags when you publish email sending events.
1533
+ #
1534
+ # @note When making an API call, you may pass MessageTag
1535
+ # data as a hash:
1536
+ #
1537
+ # {
1538
+ # name: "MessageTagName", # required
1539
+ # value: "MessageTagValue", # required
1540
+ # }
1541
+ #
1542
+ # @!attribute [rw] name
1543
+ # The name of the message tag. The message tag name has to meet the
1544
+ # following criteria:
1545
+ #
1546
+ # * It can only contain ASCII letters (a–z, A–Z), numbers (0–9),
1547
+ # underscores (\_), or dashes (-).
1548
+ #
1549
+ # * It can contain no more than 256 characters.
1550
+ # @return [String]
1551
+ #
1552
+ # @!attribute [rw] value
1553
+ # The value of the message tag. The message tag value has to meet the
1554
+ # following criteria:
1555
+ #
1556
+ # * It can only contain ASCII letters (a–z, A–Z), numbers (0–9),
1557
+ # underscores (\_), or dashes (-).
1558
+ #
1559
+ # * It can contain no more than 256 characters.
1560
+ # @return [String]
1561
+ #
1562
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26/MessageTag AWS API Documentation
1563
+ #
1564
+ class MessageTag < Struct.new(
1565
+ :name,
1566
+ :value)
1567
+ include Aws::Structure
1568
+ end
1569
+
1570
+ # An object that defines a Amazon Pinpoint destination for email events.
1571
+ # You can use Amazon Pinpoint events to create attributes in Amazon
1572
+ # Pinpoint projects. You can use these attributes to create segments for
1573
+ # your campaigns.
1574
+ #
1575
+ # @note When making an API call, you may pass PinpointDestination
1576
+ # data as a hash:
1577
+ #
1578
+ # {
1579
+ # application_arn: "AmazonResourceName",
1580
+ # }
1581
+ #
1582
+ # @!attribute [rw] application_arn
1583
+ # The Amazon Resource Name (ARN) of the Amazon Pinpoint project that
1584
+ # you want to send email events to.
1585
+ # @return [String]
1586
+ #
1587
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26/PinpointDestination AWS API Documentation
1588
+ #
1589
+ class PinpointDestination < Struct.new(
1590
+ :application_arn)
1591
+ include Aws::Structure
1592
+ end
1593
+
1594
+ # A request to enable or disable the automatic IP address warm-up
1595
+ # feature.
1596
+ #
1597
+ # @note When making an API call, you may pass PutAccountDedicatedIpWarmupAttributesRequest
1598
+ # data as a hash:
1599
+ #
1600
+ # {
1601
+ # auto_warmup_enabled: false,
1602
+ # }
1603
+ #
1604
+ # @!attribute [rw] auto_warmup_enabled
1605
+ # Enables or disables the automatic warm-up feature for dedicated IP
1606
+ # addresses that are associated with your Amazon Pinpoint account in
1607
+ # the current AWS Region. Set to `true` to enable the automatic
1608
+ # warm-up feature, or set to `false` to disable it.
1609
+ # @return [Boolean]
1610
+ #
1611
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26/PutAccountDedicatedIpWarmupAttributesRequest AWS API Documentation
1612
+ #
1613
+ class PutAccountDedicatedIpWarmupAttributesRequest < Struct.new(
1614
+ :auto_warmup_enabled)
1615
+ include Aws::Structure
1616
+ end
1617
+
1618
+ # An HTTP 200 response if the request succeeds, or an error message if
1619
+ # the request fails.
1620
+ #
1621
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26/PutAccountDedicatedIpWarmupAttributesResponse AWS API Documentation
1622
+ #
1623
+ class PutAccountDedicatedIpWarmupAttributesResponse < Aws::EmptyStructure; end
1624
+
1625
+ # A request to change the ability of your account to send email.
1626
+ #
1627
+ # @note When making an API call, you may pass PutAccountSendingAttributesRequest
1628
+ # data as a hash:
1629
+ #
1630
+ # {
1631
+ # sending_enabled: false,
1632
+ # }
1633
+ #
1634
+ # @!attribute [rw] sending_enabled
1635
+ # Enables or disables your account's ability to send email. Set to
1636
+ # `true` to enable email sending, or set to `false` to disable email
1637
+ # sending.
1638
+ #
1639
+ # <note markdown="1"> If AWS paused your account's ability to send email, you can't use
1640
+ # this operation to resume your account's ability to send email.
1641
+ #
1642
+ # </note>
1643
+ # @return [Boolean]
1644
+ #
1645
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26/PutAccountSendingAttributesRequest AWS API Documentation
1646
+ #
1647
+ class PutAccountSendingAttributesRequest < Struct.new(
1648
+ :sending_enabled)
1649
+ include Aws::Structure
1650
+ end
1651
+
1652
+ # An HTTP 200 response if the request succeeds, or an error message if
1653
+ # the request fails.
1654
+ #
1655
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26/PutAccountSendingAttributesResponse AWS API Documentation
1656
+ #
1657
+ class PutAccountSendingAttributesResponse < Aws::EmptyStructure; end
1658
+
1659
+ # A request to associate a configuration set with a dedicated IP pool.
1660
+ #
1661
+ # @note When making an API call, you may pass PutConfigurationSetDeliveryOptionsRequest
1662
+ # data as a hash:
1663
+ #
1664
+ # {
1665
+ # configuration_set_name: "ConfigurationSetName", # required
1666
+ # sending_pool_name: "SendingPoolName",
1667
+ # }
1668
+ #
1669
+ # @!attribute [rw] configuration_set_name
1670
+ # The name of the configuration set that you want to associate with a
1671
+ # dedicated IP pool.
1672
+ # @return [String]
1673
+ #
1674
+ # @!attribute [rw] sending_pool_name
1675
+ # The name of the dedicated IP pool that you want to associate with
1676
+ # the configuration set.
1677
+ # @return [String]
1678
+ #
1679
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26/PutConfigurationSetDeliveryOptionsRequest AWS API Documentation
1680
+ #
1681
+ class PutConfigurationSetDeliveryOptionsRequest < Struct.new(
1682
+ :configuration_set_name,
1683
+ :sending_pool_name)
1684
+ include Aws::Structure
1685
+ end
1686
+
1687
+ # An HTTP 200 response if the request succeeds, or an error message if
1688
+ # the request fails.
1689
+ #
1690
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26/PutConfigurationSetDeliveryOptionsResponse AWS API Documentation
1691
+ #
1692
+ class PutConfigurationSetDeliveryOptionsResponse < Aws::EmptyStructure; end
1693
+
1694
+ # A request to enable or disable tracking of reputation metrics for a
1695
+ # configuration set.
1696
+ #
1697
+ # @note When making an API call, you may pass PutConfigurationSetReputationOptionsRequest
1698
+ # data as a hash:
1699
+ #
1700
+ # {
1701
+ # configuration_set_name: "ConfigurationSetName", # required
1702
+ # reputation_metrics_enabled: false,
1703
+ # }
1704
+ #
1705
+ # @!attribute [rw] configuration_set_name
1706
+ # The name of the configuration set that you want to enable or disable
1707
+ # reputation metric tracking for.
1708
+ # @return [String]
1709
+ #
1710
+ # @!attribute [rw] reputation_metrics_enabled
1711
+ # If `true`, tracking of reputation metrics is enabled for the
1712
+ # configuration set. If `false`, tracking of reputation metrics is
1713
+ # disabled for the configuration set.
1714
+ # @return [Boolean]
1715
+ #
1716
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26/PutConfigurationSetReputationOptionsRequest AWS API Documentation
1717
+ #
1718
+ class PutConfigurationSetReputationOptionsRequest < Struct.new(
1719
+ :configuration_set_name,
1720
+ :reputation_metrics_enabled)
1721
+ include Aws::Structure
1722
+ end
1723
+
1724
+ # An HTTP 200 response if the request succeeds, or an error message if
1725
+ # the request fails.
1726
+ #
1727
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26/PutConfigurationSetReputationOptionsResponse AWS API Documentation
1728
+ #
1729
+ class PutConfigurationSetReputationOptionsResponse < Aws::EmptyStructure; end
1730
+
1731
+ # A request to enable or disable the ability of Amazon Pinpoint to send
1732
+ # emails that use a specific configuration set.
1733
+ #
1734
+ # @note When making an API call, you may pass PutConfigurationSetSendingOptionsRequest
1735
+ # data as a hash:
1736
+ #
1737
+ # {
1738
+ # configuration_set_name: "ConfigurationSetName", # required
1739
+ # sending_enabled: false,
1740
+ # }
1741
+ #
1742
+ # @!attribute [rw] configuration_set_name
1743
+ # The name of the configuration set that you want to enable or disable
1744
+ # email sending for.
1745
+ # @return [String]
1746
+ #
1747
+ # @!attribute [rw] sending_enabled
1748
+ # If `true`, email sending is enabled for the configuration set. If
1749
+ # `false`, email sending is disabled for the configuration set.
1750
+ # @return [Boolean]
1751
+ #
1752
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26/PutConfigurationSetSendingOptionsRequest AWS API Documentation
1753
+ #
1754
+ class PutConfigurationSetSendingOptionsRequest < Struct.new(
1755
+ :configuration_set_name,
1756
+ :sending_enabled)
1757
+ include Aws::Structure
1758
+ end
1759
+
1760
+ # An HTTP 200 response if the request succeeds, or an error message if
1761
+ # the request fails.
1762
+ #
1763
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26/PutConfigurationSetSendingOptionsResponse AWS API Documentation
1764
+ #
1765
+ class PutConfigurationSetSendingOptionsResponse < Aws::EmptyStructure; end
1766
+
1767
+ # A request to add a custom domain for tracking open and click events to
1768
+ # a configuration set.
1769
+ #
1770
+ # @note When making an API call, you may pass PutConfigurationSetTrackingOptionsRequest
1771
+ # data as a hash:
1772
+ #
1773
+ # {
1774
+ # configuration_set_name: "ConfigurationSetName", # required
1775
+ # custom_redirect_domain: "CustomRedirectDomain",
1776
+ # }
1777
+ #
1778
+ # @!attribute [rw] configuration_set_name
1779
+ # The name of the configuration set that you want to add a custom
1780
+ # tracking domain to.
1781
+ # @return [String]
1782
+ #
1783
+ # @!attribute [rw] custom_redirect_domain
1784
+ # The domain that you want to use to track open and click events.
1785
+ # @return [String]
1786
+ #
1787
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26/PutConfigurationSetTrackingOptionsRequest AWS API Documentation
1788
+ #
1789
+ class PutConfigurationSetTrackingOptionsRequest < Struct.new(
1790
+ :configuration_set_name,
1791
+ :custom_redirect_domain)
1792
+ include Aws::Structure
1793
+ end
1794
+
1795
+ # An HTTP 200 response if the request succeeds, or an error message if
1796
+ # the request fails.
1797
+ #
1798
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26/PutConfigurationSetTrackingOptionsResponse AWS API Documentation
1799
+ #
1800
+ class PutConfigurationSetTrackingOptionsResponse < Aws::EmptyStructure; end
1801
+
1802
+ # A request to move a dedicated IP address to a dedicated IP pool.
1803
+ #
1804
+ # @note When making an API call, you may pass PutDedicatedIpInPoolRequest
1805
+ # data as a hash:
1806
+ #
1807
+ # {
1808
+ # ip: "Ip", # required
1809
+ # destination_pool_name: "PoolName", # required
1810
+ # }
1811
+ #
1812
+ # @!attribute [rw] ip
1813
+ # The IP address that you want to move to the dedicated IP pool. The
1814
+ # value you specify has to be a dedicated IP address that's
1815
+ # associated with your Amazon Pinpoint account.
1816
+ # @return [String]
1817
+ #
1818
+ # @!attribute [rw] destination_pool_name
1819
+ # The name of the IP pool that you want to add the dedicated IP
1820
+ # address to. You have to specify an IP pool that already exists.
1821
+ # @return [String]
1822
+ #
1823
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26/PutDedicatedIpInPoolRequest AWS API Documentation
1824
+ #
1825
+ class PutDedicatedIpInPoolRequest < Struct.new(
1826
+ :ip,
1827
+ :destination_pool_name)
1828
+ include Aws::Structure
1829
+ end
1830
+
1831
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26/PutDedicatedIpInPoolResponse AWS API Documentation
1832
+ #
1833
+ class PutDedicatedIpInPoolResponse < Aws::EmptyStructure; end
1834
+
1835
+ # A request to change the warm-up attributes for a dedicated IP address.
1836
+ # This operation is useful when you want to resume the warm-up process
1837
+ # for an existing IP address.
1838
+ #
1839
+ # @note When making an API call, you may pass PutDedicatedIpWarmupAttributesRequest
1840
+ # data as a hash:
1841
+ #
1842
+ # {
1843
+ # ip: "Ip", # required
1844
+ # warmup_percentage: 1, # required
1845
+ # }
1846
+ #
1847
+ # @!attribute [rw] ip
1848
+ # The dedicated IP address that you want to update the warm-up
1849
+ # attributes for.
1850
+ # @return [String]
1851
+ #
1852
+ # @!attribute [rw] warmup_percentage
1853
+ # The warm-up percentage that you want to associate with the dedicated
1854
+ # IP address.
1855
+ # @return [Integer]
1856
+ #
1857
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26/PutDedicatedIpWarmupAttributesRequest AWS API Documentation
1858
+ #
1859
+ class PutDedicatedIpWarmupAttributesRequest < Struct.new(
1860
+ :ip,
1861
+ :warmup_percentage)
1862
+ include Aws::Structure
1863
+ end
1864
+
1865
+ # An HTTP 200 response if the request succeeds, or an error message if
1866
+ # the request fails.
1867
+ #
1868
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26/PutDedicatedIpWarmupAttributesResponse AWS API Documentation
1869
+ #
1870
+ class PutDedicatedIpWarmupAttributesResponse < Aws::EmptyStructure; end
1871
+
1872
+ # A request to enable or disable DKIM signing of email that you send
1873
+ # from an email identity.
1874
+ #
1875
+ # @note When making an API call, you may pass PutEmailIdentityDkimAttributesRequest
1876
+ # data as a hash:
1877
+ #
1878
+ # {
1879
+ # email_identity: "Identity", # required
1880
+ # signing_enabled: false,
1881
+ # }
1882
+ #
1883
+ # @!attribute [rw] email_identity
1884
+ # The email identity that you want to change the DKIM settings for.
1885
+ # @return [String]
1886
+ #
1887
+ # @!attribute [rw] signing_enabled
1888
+ # Sets the DKIM signing configuration for the identity.
1889
+ #
1890
+ # When you set this value `true`, then the messages that Amazon
1891
+ # Pinpoint sends from the identity are DKIM-signed. When you set this
1892
+ # value to `false`, then the messages that Amazon Pinpoint sends from
1893
+ # the identity aren't DKIM-signed.
1894
+ # @return [Boolean]
1895
+ #
1896
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26/PutEmailIdentityDkimAttributesRequest AWS API Documentation
1897
+ #
1898
+ class PutEmailIdentityDkimAttributesRequest < Struct.new(
1899
+ :email_identity,
1900
+ :signing_enabled)
1901
+ include Aws::Structure
1902
+ end
1903
+
1904
+ # An HTTP 200 response if the request succeeds, or an error message if
1905
+ # the request fails.
1906
+ #
1907
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26/PutEmailIdentityDkimAttributesResponse AWS API Documentation
1908
+ #
1909
+ class PutEmailIdentityDkimAttributesResponse < Aws::EmptyStructure; end
1910
+
1911
+ # A request to set the attributes that control how bounce and complaint
1912
+ # events are processed.
1913
+ #
1914
+ # @note When making an API call, you may pass PutEmailIdentityFeedbackAttributesRequest
1915
+ # data as a hash:
1916
+ #
1917
+ # {
1918
+ # email_identity: "Identity", # required
1919
+ # email_forwarding_enabled: false,
1920
+ # }
1921
+ #
1922
+ # @!attribute [rw] email_identity
1923
+ # The email identity that you want to configure bounce and complaint
1924
+ # feedback forwarding for.
1925
+ # @return [String]
1926
+ #
1927
+ # @!attribute [rw] email_forwarding_enabled
1928
+ # Sets the feedback forwarding configuration for the identity.
1929
+ #
1930
+ # If the value is `true`, Amazon Pinpoint sends you email
1931
+ # notifications when bounce or complaint events occur. Amazon Pinpoint
1932
+ # sends this notification to the address that you specified in the
1933
+ # Return-Path header of the original email.
1934
+ #
1935
+ # When you set this value to `false`, Amazon Pinpoint sends
1936
+ # notifications through other mechanisms, such as by notifying an
1937
+ # Amazon SNS topic or another event destination. You're required to
1938
+ # have a method of tracking bounces and complaints. If you haven't
1939
+ # set up another mechanism for receiving bounce or complaint
1940
+ # notifications, Amazon Pinpoint sends an email notification when
1941
+ # these events occur (even if this setting is disabled).
1942
+ # @return [Boolean]
1943
+ #
1944
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26/PutEmailIdentityFeedbackAttributesRequest AWS API Documentation
1945
+ #
1946
+ class PutEmailIdentityFeedbackAttributesRequest < Struct.new(
1947
+ :email_identity,
1948
+ :email_forwarding_enabled)
1949
+ include Aws::Structure
1950
+ end
1951
+
1952
+ # An HTTP 200 response if the request succeeds, or an error message if
1953
+ # the request fails.
1954
+ #
1955
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26/PutEmailIdentityFeedbackAttributesResponse AWS API Documentation
1956
+ #
1957
+ class PutEmailIdentityFeedbackAttributesResponse < Aws::EmptyStructure; end
1958
+
1959
+ # A request to configure the custom MAIL FROM domain for a verified
1960
+ # identity.
1961
+ #
1962
+ # @note When making an API call, you may pass PutEmailIdentityMailFromAttributesRequest
1963
+ # data as a hash:
1964
+ #
1965
+ # {
1966
+ # email_identity: "Identity", # required
1967
+ # mail_from_domain: "MailFromDomainName",
1968
+ # behavior_on_mx_failure: "USE_DEFAULT_VALUE", # accepts USE_DEFAULT_VALUE, REJECT_MESSAGE
1969
+ # }
1970
+ #
1971
+ # @!attribute [rw] email_identity
1972
+ # The verified email identity that you want to set up the custom MAIL
1973
+ # FROM domain for.
1974
+ # @return [String]
1975
+ #
1976
+ # @!attribute [rw] mail_from_domain
1977
+ # The custom MAIL FROM domain that you want the verified identity to
1978
+ # use. The MAIL FROM domain must meet the following criteria:
1979
+ #
1980
+ # * It has to be a subdomain of the verified identity.
1981
+ #
1982
+ # * It can't be used to receive email.
1983
+ #
1984
+ # * It can't be used in a "From" address if the MAIL FROM domain is
1985
+ # a destination for feedback forwarding emails.
1986
+ # @return [String]
1987
+ #
1988
+ # @!attribute [rw] behavior_on_mx_failure
1989
+ # The action that you want Amazon Pinpoint to take if it can't read
1990
+ # the required MX record when you send an email. When you set this
1991
+ # value to `UseDefaultValue`, Amazon Pinpoint uses *amazonses.com* as
1992
+ # the MAIL FROM domain. When you set this value to `RejectMessage`,
1993
+ # Amazon Pinpoint returns a `MailFromDomainNotVerified` error, and
1994
+ # doesn't attempt to deliver the email.
1995
+ #
1996
+ # These behaviors are taken when the custom MAIL FROM domain
1997
+ # configuration is in the `Pending`, `Failed`, and `TemporaryFailure`
1998
+ # states.
1999
+ # @return [String]
2000
+ #
2001
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26/PutEmailIdentityMailFromAttributesRequest AWS API Documentation
2002
+ #
2003
+ class PutEmailIdentityMailFromAttributesRequest < Struct.new(
2004
+ :email_identity,
2005
+ :mail_from_domain,
2006
+ :behavior_on_mx_failure)
2007
+ include Aws::Structure
2008
+ end
2009
+
2010
+ # An HTTP 200 response if the request succeeds, or an error message if
2011
+ # the request fails.
2012
+ #
2013
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26/PutEmailIdentityMailFromAttributesResponse AWS API Documentation
2014
+ #
2015
+ class PutEmailIdentityMailFromAttributesResponse < Aws::EmptyStructure; end
2016
+
2017
+ # The raw email message.
2018
+ #
2019
+ # @note When making an API call, you may pass RawMessage
2020
+ # data as a hash:
2021
+ #
2022
+ # {
2023
+ # data: "data", # required
2024
+ # }
2025
+ #
2026
+ # @!attribute [rw] data
2027
+ # The raw email message. The message has to meet the following
2028
+ # criteria:
2029
+ #
2030
+ # * The message has to contain a header and a body, separated by one
2031
+ # blank line.
2032
+ #
2033
+ # * All of the required header fields must be present in the message.
2034
+ #
2035
+ # * Each part of a multipart MIME message must be formatted properly.
2036
+ #
2037
+ # * Attachments must be in a file format that Amazon Pinpoint
2038
+ # supports.
2039
+ #
2040
+ # * The entire message must be Base64 encoded.
2041
+ #
2042
+ # * If any of the MIME parts in your message contain content that is
2043
+ # outside of the 7-bit ASCII character range, you should encode that
2044
+ # content to ensure that recipients' email clients render the
2045
+ # message properly.
2046
+ #
2047
+ # * The length of any single line of text in the message can't exceed
2048
+ # 1,000 characters. This restriction is defined in [RFC 5321][1].
2049
+ #
2050
+ #
2051
+ #
2052
+ # [1]: https://tools.ietf.org/html/rfc5321
2053
+ # @return [String]
2054
+ #
2055
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26/RawMessage AWS API Documentation
2056
+ #
2057
+ class RawMessage < Struct.new(
2058
+ :data)
2059
+ include Aws::Structure
2060
+ end
2061
+
2062
+ # Enable or disable collection of reputation metrics for emails that you
2063
+ # send using this configuration set in the current AWS Region.
2064
+ #
2065
+ # @note When making an API call, you may pass ReputationOptions
2066
+ # data as a hash:
2067
+ #
2068
+ # {
2069
+ # reputation_metrics_enabled: false,
2070
+ # last_fresh_start: Time.now,
2071
+ # }
2072
+ #
2073
+ # @!attribute [rw] reputation_metrics_enabled
2074
+ # If `true`, tracking of reputation metrics is enabled for the
2075
+ # configuration set. If `false`, tracking of reputation metrics is
2076
+ # disabled for the configuration set.
2077
+ # @return [Boolean]
2078
+ #
2079
+ # @!attribute [rw] last_fresh_start
2080
+ # The date and time when the reputation metrics were last given a
2081
+ # fresh start. When your account is given a fresh start, your
2082
+ # reputation metrics are calculated starting from the date of the
2083
+ # fresh start.
2084
+ # @return [Time]
2085
+ #
2086
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26/ReputationOptions AWS API Documentation
2087
+ #
2088
+ class ReputationOptions < Struct.new(
2089
+ :reputation_metrics_enabled,
2090
+ :last_fresh_start)
2091
+ include Aws::Structure
2092
+ end
2093
+
2094
+ # A request to send an email message.
2095
+ #
2096
+ # @note When making an API call, you may pass SendEmailRequest
2097
+ # data as a hash:
2098
+ #
2099
+ # {
2100
+ # from_email_address: "EmailAddress",
2101
+ # destination: { # required
2102
+ # to_addresses: ["EmailAddress"],
2103
+ # cc_addresses: ["EmailAddress"],
2104
+ # bcc_addresses: ["EmailAddress"],
2105
+ # },
2106
+ # reply_to_addresses: ["EmailAddress"],
2107
+ # feedback_forwarding_email_address: "EmailAddress",
2108
+ # content: { # required
2109
+ # simple: {
2110
+ # subject: { # required
2111
+ # data: "MessageData", # required
2112
+ # charset: "Charset",
2113
+ # },
2114
+ # body: { # required
2115
+ # text: {
2116
+ # data: "MessageData", # required
2117
+ # charset: "Charset",
2118
+ # },
2119
+ # html: {
2120
+ # data: "MessageData", # required
2121
+ # charset: "Charset",
2122
+ # },
2123
+ # },
2124
+ # },
2125
+ # raw: {
2126
+ # data: "data", # required
2127
+ # },
2128
+ # },
2129
+ # email_tags: [
2130
+ # {
2131
+ # name: "MessageTagName", # required
2132
+ # value: "MessageTagValue", # required
2133
+ # },
2134
+ # ],
2135
+ # configuration_set_name: "ConfigurationSetName",
2136
+ # }
2137
+ #
2138
+ # @!attribute [rw] from_email_address
2139
+ # The email address that you want to use as the "From" address for
2140
+ # the email. The address that you specify has to be verified.
2141
+ # @return [String]
2142
+ #
2143
+ # @!attribute [rw] destination
2144
+ # An object that contains the recipients of the email message.
2145
+ # @return [Types::Destination]
2146
+ #
2147
+ # @!attribute [rw] reply_to_addresses
2148
+ # The "Reply-to" email addresses for the message. When the recipient
2149
+ # replies to the message, each Reply-to address receives the reply.
2150
+ # @return [Array<String>]
2151
+ #
2152
+ # @!attribute [rw] feedback_forwarding_email_address
2153
+ # The address that Amazon Pinpoint should send bounce and complaint
2154
+ # notifications to.
2155
+ # @return [String]
2156
+ #
2157
+ # @!attribute [rw] content
2158
+ # An object that contains the body of the message. You can send either
2159
+ # a Simple message or a Raw message.
2160
+ # @return [Types::EmailContent]
2161
+ #
2162
+ # @!attribute [rw] email_tags
2163
+ # A list of tags, in the form of name/value pairs, to apply to an
2164
+ # email that you send using the `SendEmail` operation. Tags correspond
2165
+ # to characteristics of the email that you define, so that you can
2166
+ # publish email sending events.
2167
+ # @return [Array<Types::MessageTag>]
2168
+ #
2169
+ # @!attribute [rw] configuration_set_name
2170
+ # The name of the configuration set that you want to use when sending
2171
+ # the email.
2172
+ # @return [String]
2173
+ #
2174
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26/SendEmailRequest AWS API Documentation
2175
+ #
2176
+ class SendEmailRequest < Struct.new(
2177
+ :from_email_address,
2178
+ :destination,
2179
+ :reply_to_addresses,
2180
+ :feedback_forwarding_email_address,
2181
+ :content,
2182
+ :email_tags,
2183
+ :configuration_set_name)
2184
+ include Aws::Structure
2185
+ end
2186
+
2187
+ # A unique message ID that you receive when Amazon Pinpoint accepts an
2188
+ # email for sending.
2189
+ #
2190
+ # @!attribute [rw] message_id
2191
+ # A unique identifier for the message that is generated when Amazon
2192
+ # Pinpoint accepts the message.
2193
+ #
2194
+ # <note markdown="1"> It is possible for Amazon Pinpoint to accept a message without
2195
+ # sending it. This can happen when the message you're trying to send
2196
+ # has an attachment doesn't pass a virus check, or when you send a
2197
+ # templated email that contains invalid personalization content, for
2198
+ # example.
2199
+ #
2200
+ # </note>
2201
+ # @return [String]
2202
+ #
2203
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26/SendEmailResponse AWS API Documentation
2204
+ #
2205
+ class SendEmailResponse < Struct.new(
2206
+ :message_id)
2207
+ include Aws::Structure
2208
+ end
2209
+
2210
+ # An object that contains information about the per-day and per-second
2211
+ # sending limits for your Amazon Pinpoint account in the current AWS
2212
+ # Region.
2213
+ #
2214
+ # @!attribute [rw] max_24_hour_send
2215
+ # The maximum number of emails that you can send in the current AWS
2216
+ # Region over a 24-hour period. This value is also called your
2217
+ # *sending quota*.
2218
+ # @return [Float]
2219
+ #
2220
+ # @!attribute [rw] max_send_rate
2221
+ # The maximum number of emails that you can send per second in the
2222
+ # current AWS Region. This value is also called your *maximum sending
2223
+ # rate* or your *maximum TPS (transactions per second) rate*.
2224
+ # @return [Float]
2225
+ #
2226
+ # @!attribute [rw] sent_last_24_hours
2227
+ # The number of emails sent from your Amazon Pinpoint account in the
2228
+ # current AWS Region over the past 24 hours.
2229
+ # @return [Float]
2230
+ #
2231
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26/SendQuota AWS API Documentation
2232
+ #
2233
+ class SendQuota < Struct.new(
2234
+ :max_24_hour_send,
2235
+ :max_send_rate,
2236
+ :sent_last_24_hours)
2237
+ include Aws::Structure
2238
+ end
2239
+
2240
+ # Used to enable or disable email sending for messages that use this
2241
+ # configuration set in the current AWS Region.
2242
+ #
2243
+ # @note When making an API call, you may pass SendingOptions
2244
+ # data as a hash:
2245
+ #
2246
+ # {
2247
+ # sending_enabled: false,
2248
+ # }
2249
+ #
2250
+ # @!attribute [rw] sending_enabled
2251
+ # If `true`, email sending is enabled for the configuration set. If
2252
+ # `false`, email sending is disabled for the configuration set.
2253
+ # @return [Boolean]
2254
+ #
2255
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26/SendingOptions AWS API Documentation
2256
+ #
2257
+ class SendingOptions < Struct.new(
2258
+ :sending_enabled)
2259
+ include Aws::Structure
2260
+ end
2261
+
2262
+ # An object that defines an Amazon SNS destination for email events. You
2263
+ # can use Amazon SNS to send notification when certain email events
2264
+ # occur.
2265
+ #
2266
+ # @note When making an API call, you may pass SnsDestination
2267
+ # data as a hash:
2268
+ #
2269
+ # {
2270
+ # topic_arn: "AmazonResourceName", # required
2271
+ # }
2272
+ #
2273
+ # @!attribute [rw] topic_arn
2274
+ # The Amazon Resource Name (ARN) of the Amazon SNS topic that you want
2275
+ # to publish email events to. For more information about Amazon SNS
2276
+ # topics, see the [Amazon SNS Developer Guide][1].
2277
+ #
2278
+ #
2279
+ #
2280
+ # [1]: http://docs.aws.amazon.com/sns/latest/dg/CreateTopic.html
2281
+ # @return [String]
2282
+ #
2283
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26/SnsDestination AWS API Documentation
2284
+ #
2285
+ class SnsDestination < Struct.new(
2286
+ :topic_arn)
2287
+ include Aws::Structure
2288
+ end
2289
+
2290
+ # An object that defines the tracking options for a configuration set.
2291
+ # When you use Amazon Pinpoint to send an email, it contains an
2292
+ # invisible image that's used to track when recipients open your email.
2293
+ # If your email contains links, those links are changed slightly in
2294
+ # order to track when recipients click them.
2295
+ #
2296
+ # These images and links include references to a domain operated by AWS.
2297
+ # You can optionally configure Amazon Pinpoint to use a domain that you
2298
+ # operate for these images and links.
2299
+ #
2300
+ # @note When making an API call, you may pass TrackingOptions
2301
+ # data as a hash:
2302
+ #
2303
+ # {
2304
+ # custom_redirect_domain: "CustomRedirectDomain", # required
2305
+ # }
2306
+ #
2307
+ # @!attribute [rw] custom_redirect_domain
2308
+ # The domain that you want to use for tracking open and click events.
2309
+ # @return [String]
2310
+ #
2311
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26/TrackingOptions AWS API Documentation
2312
+ #
2313
+ class TrackingOptions < Struct.new(
2314
+ :custom_redirect_domain)
2315
+ include Aws::Structure
2316
+ end
2317
+
2318
+ # A request to change the settings for an event destination for a
2319
+ # configuration set.
2320
+ #
2321
+ # @note When making an API call, you may pass UpdateConfigurationSetEventDestinationRequest
2322
+ # data as a hash:
2323
+ #
2324
+ # {
2325
+ # configuration_set_name: "ConfigurationSetName", # required
2326
+ # event_destination_name: "EventDestinationName", # required
2327
+ # event_destination: { # required
2328
+ # enabled: false,
2329
+ # matching_event_types: ["SEND"], # accepts SEND, REJECT, BOUNCE, COMPLAINT, DELIVERY, OPEN, CLICK, RENDERING_FAILURE
2330
+ # kinesis_firehose_destination: {
2331
+ # iam_role_arn: "AmazonResourceName", # required
2332
+ # delivery_stream_arn: "AmazonResourceName", # required
2333
+ # },
2334
+ # cloud_watch_destination: {
2335
+ # dimension_configurations: [ # required
2336
+ # {
2337
+ # dimension_name: "DimensionName", # required
2338
+ # dimension_value_source: "MESSAGE_TAG", # required, accepts MESSAGE_TAG, EMAIL_HEADER, LINK_TAG
2339
+ # default_dimension_value: "DefaultDimensionValue", # required
2340
+ # },
2341
+ # ],
2342
+ # },
2343
+ # sns_destination: {
2344
+ # topic_arn: "AmazonResourceName", # required
2345
+ # },
2346
+ # pinpoint_destination: {
2347
+ # application_arn: "AmazonResourceName",
2348
+ # },
2349
+ # },
2350
+ # }
2351
+ #
2352
+ # @!attribute [rw] configuration_set_name
2353
+ # The name of the configuration set that contains the event
2354
+ # destination that you want to modify.
2355
+ # @return [String]
2356
+ #
2357
+ # @!attribute [rw] event_destination_name
2358
+ # The name of the event destination that you want to modify.
2359
+ # @return [String]
2360
+ #
2361
+ # @!attribute [rw] event_destination
2362
+ # An object that defines the event destination.
2363
+ # @return [Types::EventDestinationDefinition]
2364
+ #
2365
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26/UpdateConfigurationSetEventDestinationRequest AWS API Documentation
2366
+ #
2367
+ class UpdateConfigurationSetEventDestinationRequest < Struct.new(
2368
+ :configuration_set_name,
2369
+ :event_destination_name,
2370
+ :event_destination)
2371
+ include Aws::Structure
2372
+ end
2373
+
2374
+ # An HTTP 200 response if the request succeeds, or an error message if
2375
+ # the request fails.
2376
+ #
2377
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26/UpdateConfigurationSetEventDestinationResponse AWS API Documentation
2378
+ #
2379
+ class UpdateConfigurationSetEventDestinationResponse < Aws::EmptyStructure; end
2380
+
2381
+ end
2382
+ end