aws-sdk-mailmanager 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,3634 @@
1
+ # frozen_string_literal: true
2
+
3
+ # WARNING ABOUT GENERATED CODE
4
+ #
5
+ # This file is generated. See the contributing guide for more information:
6
+ # https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
7
+ #
8
+ # WARNING ABOUT GENERATED CODE
9
+
10
+ module Aws::MailManager
11
+ module Types
12
+
13
+ # Occurs when a user is denied access to a specific resource or action.
14
+ #
15
+ # @!attribute [rw] message
16
+ # @return [String]
17
+ #
18
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mailmanager-2023-10-17/AccessDeniedException AWS API Documentation
19
+ #
20
+ class AccessDeniedException < Struct.new(
21
+ :message)
22
+ SENSITIVE = []
23
+ include Aws::Structure
24
+ end
25
+
26
+ # The action to add a header to a message. When executed, this action
27
+ # will add the given header to the message.
28
+ #
29
+ # @!attribute [rw] header_name
30
+ # The name of the header to add to an email. The header must be
31
+ # prefixed with "X-". Headers are added regardless of whether the
32
+ # header name pre-existed in the email.
33
+ # @return [String]
34
+ #
35
+ # @!attribute [rw] header_value
36
+ # The value of the header to add to the email.
37
+ # @return [String]
38
+ #
39
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mailmanager-2023-10-17/AddHeaderAction AWS API Documentation
40
+ #
41
+ class AddHeaderAction < Struct.new(
42
+ :header_name,
43
+ :header_value)
44
+ SENSITIVE = []
45
+ include Aws::Structure
46
+ end
47
+
48
+ # An Add On instance represents a specific configuration of an Add On.
49
+ #
50
+ # @!attribute [rw] addon_instance_arn
51
+ # The Amazon Resource Name (ARN) of the Add On instance.
52
+ # @return [String]
53
+ #
54
+ # @!attribute [rw] addon_instance_id
55
+ # The unique ID of the Add On instance.
56
+ # @return [String]
57
+ #
58
+ # @!attribute [rw] addon_name
59
+ # The name of the Add On for the instance.
60
+ # @return [String]
61
+ #
62
+ # @!attribute [rw] addon_subscription_id
63
+ # The subscription ID for the instance.
64
+ # @return [String]
65
+ #
66
+ # @!attribute [rw] created_timestamp
67
+ # The timestamp of when the Add On instance was created.
68
+ # @return [Time]
69
+ #
70
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mailmanager-2023-10-17/AddonInstance AWS API Documentation
71
+ #
72
+ class AddonInstance < Struct.new(
73
+ :addon_instance_arn,
74
+ :addon_instance_id,
75
+ :addon_name,
76
+ :addon_subscription_id,
77
+ :created_timestamp)
78
+ SENSITIVE = []
79
+ include Aws::Structure
80
+ end
81
+
82
+ # A subscription for an Add On representing the acceptance of its terms
83
+ # of use and additional pricing.
84
+ #
85
+ # @!attribute [rw] addon_name
86
+ # The name of the Add On.
87
+ # @return [String]
88
+ #
89
+ # @!attribute [rw] addon_subscription_arn
90
+ # The Amazon Resource Name (ARN) of the Add On subscription.
91
+ # @return [String]
92
+ #
93
+ # @!attribute [rw] addon_subscription_id
94
+ # The unique ID of the Add On subscription.
95
+ # @return [String]
96
+ #
97
+ # @!attribute [rw] created_timestamp
98
+ # The timestamp of when the Add On subscription was created.
99
+ # @return [Time]
100
+ #
101
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mailmanager-2023-10-17/AddonSubscription AWS API Documentation
102
+ #
103
+ class AddonSubscription < Struct.new(
104
+ :addon_name,
105
+ :addon_subscription_arn,
106
+ :addon_subscription_id,
107
+ :created_timestamp)
108
+ SENSITIVE = []
109
+ include Aws::Structure
110
+ end
111
+
112
+ # The result of an analysis can be used in conditions to trigger
113
+ # actions. Analyses can inspect the email content and report a certain
114
+ # aspect of the email.
115
+ #
116
+ # @!attribute [rw] analyzer
117
+ # The Amazon Resource Name (ARN) of an Add On.
118
+ # @return [String]
119
+ #
120
+ # @!attribute [rw] result_field
121
+ # The returned value from an Add On.
122
+ # @return [String]
123
+ #
124
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mailmanager-2023-10-17/Analysis AWS API Documentation
125
+ #
126
+ class Analysis < Struct.new(
127
+ :analyzer,
128
+ :result_field)
129
+ SENSITIVE = []
130
+ include Aws::Structure
131
+ end
132
+
133
+ # An archive resource for storing and retaining emails.
134
+ #
135
+ # @!attribute [rw] archive_id
136
+ # The unique identifier of the archive.
137
+ # @return [String]
138
+ #
139
+ # @!attribute [rw] archive_name
140
+ # The unique name assigned to the archive.
141
+ # @return [String]
142
+ #
143
+ # @!attribute [rw] archive_state
144
+ # The current state of the archive:
145
+ #
146
+ # * `ACTIVE` – The archive is ready and available for use.
147
+ #
148
+ # * `PENDING_DELETION` – The archive has been marked for deletion and
149
+ # will be permanently deleted in 30 days. No further modifications
150
+ # can be made in this state.
151
+ # @return [String]
152
+ #
153
+ # @!attribute [rw] last_updated_timestamp
154
+ # The timestamp of when the archive was last updated.
155
+ # @return [Time]
156
+ #
157
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mailmanager-2023-10-17/Archive AWS API Documentation
158
+ #
159
+ class Archive < Struct.new(
160
+ :archive_id,
161
+ :archive_name,
162
+ :archive_state,
163
+ :last_updated_timestamp)
164
+ SENSITIVE = []
165
+ include Aws::Structure
166
+ end
167
+
168
+ # The action to archive the email by delivering the email to an Amazon
169
+ # SES archive.
170
+ #
171
+ # @!attribute [rw] action_failure_policy
172
+ # A policy that states what to do in the case of failure. The action
173
+ # will fail if there are configuration errors. For example, the
174
+ # specified archive has been deleted.
175
+ # @return [String]
176
+ #
177
+ # @!attribute [rw] target_archive
178
+ # The identifier of the archive to send the email to.
179
+ # @return [String]
180
+ #
181
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mailmanager-2023-10-17/ArchiveAction AWS API Documentation
182
+ #
183
+ class ArchiveAction < Struct.new(
184
+ :action_failure_policy,
185
+ :target_archive)
186
+ SENSITIVE = []
187
+ include Aws::Structure
188
+ end
189
+
190
+ # A boolean expression to evaluate email attribute values.
191
+ #
192
+ # @!attribute [rw] evaluate
193
+ # The email attribute value to evaluate.
194
+ # @return [Types::ArchiveBooleanToEvaluate]
195
+ #
196
+ # @!attribute [rw] operator
197
+ # The boolean operator to use for evaluation.
198
+ # @return [String]
199
+ #
200
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mailmanager-2023-10-17/ArchiveBooleanExpression AWS API Documentation
201
+ #
202
+ class ArchiveBooleanExpression < Struct.new(
203
+ :evaluate,
204
+ :operator)
205
+ SENSITIVE = []
206
+ include Aws::Structure
207
+ end
208
+
209
+ # The attribute to evaluate in a boolean expression.
210
+ #
211
+ # @note ArchiveBooleanToEvaluate is a union - when making an API calls you must set exactly one of the members.
212
+ #
213
+ # @note ArchiveBooleanToEvaluate is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of ArchiveBooleanToEvaluate corresponding to the set member.
214
+ #
215
+ # @!attribute [rw] attribute
216
+ # The name of the email attribute to evaluate.
217
+ # @return [String]
218
+ #
219
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mailmanager-2023-10-17/ArchiveBooleanToEvaluate AWS API Documentation
220
+ #
221
+ class ArchiveBooleanToEvaluate < Struct.new(
222
+ :attribute,
223
+ :unknown)
224
+ SENSITIVE = []
225
+ include Aws::Structure
226
+ include Aws::Structure::Union
227
+
228
+ class Attribute < ArchiveBooleanToEvaluate; end
229
+ class Unknown < ArchiveBooleanToEvaluate; end
230
+ end
231
+
232
+ # A filter condition used to include or exclude emails when exporting
233
+ # from or searching an archive.
234
+ #
235
+ # @note ArchiveFilterCondition is a union - when making an API calls you must set exactly one of the members.
236
+ #
237
+ # @note ArchiveFilterCondition is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of ArchiveFilterCondition corresponding to the set member.
238
+ #
239
+ # @!attribute [rw] boolean_expression
240
+ # A boolean expression to evaluate against email attributes.
241
+ # @return [Types::ArchiveBooleanExpression]
242
+ #
243
+ # @!attribute [rw] string_expression
244
+ # A string expression to evaluate against email attributes.
245
+ # @return [Types::ArchiveStringExpression]
246
+ #
247
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mailmanager-2023-10-17/ArchiveFilterCondition AWS API Documentation
248
+ #
249
+ class ArchiveFilterCondition < Struct.new(
250
+ :boolean_expression,
251
+ :string_expression,
252
+ :unknown)
253
+ SENSITIVE = []
254
+ include Aws::Structure
255
+ include Aws::Structure::Union
256
+
257
+ class BooleanExpression < ArchiveFilterCondition; end
258
+ class StringExpression < ArchiveFilterCondition; end
259
+ class Unknown < ArchiveFilterCondition; end
260
+ end
261
+
262
+ # A set of filter conditions to include and/or exclude emails.
263
+ #
264
+ # @!attribute [rw] include
265
+ # The filter conditions for emails to include.
266
+ # @return [Array<Types::ArchiveFilterCondition>]
267
+ #
268
+ # @!attribute [rw] unless
269
+ # The filter conditions for emails to exclude.
270
+ # @return [Array<Types::ArchiveFilterCondition>]
271
+ #
272
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mailmanager-2023-10-17/ArchiveFilters AWS API Documentation
273
+ #
274
+ class ArchiveFilters < Struct.new(
275
+ :include,
276
+ :unless)
277
+ SENSITIVE = []
278
+ include Aws::Structure
279
+ end
280
+
281
+ # The retention policy for an email archive that specifies how long
282
+ # emails are kept before being automatically deleted.
283
+ #
284
+ # @note ArchiveRetention is a union - when making an API calls you must set exactly one of the members.
285
+ #
286
+ # @note ArchiveRetention is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of ArchiveRetention corresponding to the set member.
287
+ #
288
+ # @!attribute [rw] retention_period
289
+ # The enum value sets the period for retaining emails in an archive.
290
+ # @return [String]
291
+ #
292
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mailmanager-2023-10-17/ArchiveRetention AWS API Documentation
293
+ #
294
+ class ArchiveRetention < Struct.new(
295
+ :retention_period,
296
+ :unknown)
297
+ SENSITIVE = []
298
+ include Aws::Structure
299
+ include Aws::Structure::Union
300
+
301
+ class RetentionPeriod < ArchiveRetention; end
302
+ class Unknown < ArchiveRetention; end
303
+ end
304
+
305
+ # A string expression to evaluate an email attribute value against one
306
+ # or more string values.
307
+ #
308
+ # @!attribute [rw] evaluate
309
+ # The attribute of the email to evaluate.
310
+ # @return [Types::ArchiveStringToEvaluate]
311
+ #
312
+ # @!attribute [rw] operator
313
+ # The operator to use when evaluating the string values.
314
+ # @return [String]
315
+ #
316
+ # @!attribute [rw] values
317
+ # The list of string values to evaluate the email attribute against.
318
+ # @return [Array<String>]
319
+ #
320
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mailmanager-2023-10-17/ArchiveStringExpression AWS API Documentation
321
+ #
322
+ class ArchiveStringExpression < Struct.new(
323
+ :evaluate,
324
+ :operator,
325
+ :values)
326
+ SENSITIVE = []
327
+ include Aws::Structure
328
+ end
329
+
330
+ # Specifies the email attribute to evaluate in a string expression.
331
+ #
332
+ # @note ArchiveStringToEvaluate is a union - when making an API calls you must set exactly one of the members.
333
+ #
334
+ # @note ArchiveStringToEvaluate is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of ArchiveStringToEvaluate corresponding to the set member.
335
+ #
336
+ # @!attribute [rw] attribute
337
+ # The name of the email attribute to evaluate.
338
+ # @return [String]
339
+ #
340
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mailmanager-2023-10-17/ArchiveStringToEvaluate AWS API Documentation
341
+ #
342
+ class ArchiveStringToEvaluate < Struct.new(
343
+ :attribute,
344
+ :unknown)
345
+ SENSITIVE = []
346
+ include Aws::Structure
347
+ include Aws::Structure::Union
348
+
349
+ class Attribute < ArchiveStringToEvaluate; end
350
+ class Unknown < ArchiveStringToEvaluate; end
351
+ end
352
+
353
+ # The request configuration has conflicts. For details, see the
354
+ # accompanying error message.
355
+ #
356
+ # @!attribute [rw] message
357
+ # @return [String]
358
+ #
359
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mailmanager-2023-10-17/ConflictException AWS API Documentation
360
+ #
361
+ class ConflictException < Struct.new(
362
+ :message)
363
+ SENSITIVE = []
364
+ include Aws::Structure
365
+ end
366
+
367
+ # @!attribute [rw] addon_subscription_id
368
+ # The unique ID of a previously created subscription that an Add On
369
+ # instance is created for. You can only have one instance per
370
+ # subscription.
371
+ # @return [String]
372
+ #
373
+ # @!attribute [rw] client_token
374
+ # A unique token that Amazon SES uses to recognize subsequent retries
375
+ # of the same request.
376
+ #
377
+ # **A suitable default value is auto-generated.** You should normally
378
+ # not need to pass this option.
379
+ # @return [String]
380
+ #
381
+ # @!attribute [rw] tags
382
+ # The tags used to organize, track, or control access for the
383
+ # resource. For example, \\\{ "tags": \\\{"key1":"value1",
384
+ # "key2":"value2"\\} \\}.
385
+ # @return [Array<Types::Tag>]
386
+ #
387
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mailmanager-2023-10-17/CreateAddonInstanceRequest AWS API Documentation
388
+ #
389
+ class CreateAddonInstanceRequest < Struct.new(
390
+ :addon_subscription_id,
391
+ :client_token,
392
+ :tags)
393
+ SENSITIVE = []
394
+ include Aws::Structure
395
+ end
396
+
397
+ # @!attribute [rw] addon_instance_id
398
+ # The unique ID of the Add On instance created by this API.
399
+ # @return [String]
400
+ #
401
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mailmanager-2023-10-17/CreateAddonInstanceResponse AWS API Documentation
402
+ #
403
+ class CreateAddonInstanceResponse < Struct.new(
404
+ :addon_instance_id)
405
+ SENSITIVE = []
406
+ include Aws::Structure
407
+ end
408
+
409
+ # @!attribute [rw] addon_name
410
+ # The name of the Add On to subscribe to. You can only have one
411
+ # subscription for each Add On name.
412
+ # @return [String]
413
+ #
414
+ # @!attribute [rw] client_token
415
+ # A unique token that Amazon SES uses to recognize subsequent retries
416
+ # of the same request.
417
+ #
418
+ # **A suitable default value is auto-generated.** You should normally
419
+ # not need to pass this option.
420
+ # @return [String]
421
+ #
422
+ # @!attribute [rw] tags
423
+ # The tags used to organize, track, or control access for the
424
+ # resource. For example, \\\{ "tags": \\\{"key1":"value1",
425
+ # "key2":"value2"\\} \\}.
426
+ # @return [Array<Types::Tag>]
427
+ #
428
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mailmanager-2023-10-17/CreateAddonSubscriptionRequest AWS API Documentation
429
+ #
430
+ class CreateAddonSubscriptionRequest < Struct.new(
431
+ :addon_name,
432
+ :client_token,
433
+ :tags)
434
+ SENSITIVE = []
435
+ include Aws::Structure
436
+ end
437
+
438
+ # @!attribute [rw] addon_subscription_id
439
+ # The unique ID of the Add On subscription created by this API.
440
+ # @return [String]
441
+ #
442
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mailmanager-2023-10-17/CreateAddonSubscriptionResponse AWS API Documentation
443
+ #
444
+ class CreateAddonSubscriptionResponse < Struct.new(
445
+ :addon_subscription_id)
446
+ SENSITIVE = []
447
+ include Aws::Structure
448
+ end
449
+
450
+ # The request to create a new email archive.
451
+ #
452
+ # @!attribute [rw] archive_name
453
+ # A unique name for the new archive.
454
+ # @return [String]
455
+ #
456
+ # @!attribute [rw] client_token
457
+ # A unique token Amazon SES uses to recognize retries of this request.
458
+ #
459
+ # **A suitable default value is auto-generated.** You should normally
460
+ # not need to pass this option.
461
+ # @return [String]
462
+ #
463
+ # @!attribute [rw] kms_key_arn
464
+ # The Amazon Resource Name (ARN) of the KMS key for encrypting emails
465
+ # in the archive.
466
+ # @return [String]
467
+ #
468
+ # @!attribute [rw] retention
469
+ # The period for retaining emails in the archive before automatic
470
+ # deletion.
471
+ # @return [Types::ArchiveRetention]
472
+ #
473
+ # @!attribute [rw] tags
474
+ # The tags used to organize, track, or control access for the
475
+ # resource. For example, \\\{ "tags": \\\{"key1":"value1",
476
+ # "key2":"value2"\\} \\}.
477
+ # @return [Array<Types::Tag>]
478
+ #
479
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mailmanager-2023-10-17/CreateArchiveRequest AWS API Documentation
480
+ #
481
+ class CreateArchiveRequest < Struct.new(
482
+ :archive_name,
483
+ :client_token,
484
+ :kms_key_arn,
485
+ :retention,
486
+ :tags)
487
+ SENSITIVE = []
488
+ include Aws::Structure
489
+ end
490
+
491
+ # The response from creating a new email archive.
492
+ #
493
+ # @!attribute [rw] archive_id
494
+ # The unique identifier for the newly created archive.
495
+ # @return [String]
496
+ #
497
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mailmanager-2023-10-17/CreateArchiveResponse AWS API Documentation
498
+ #
499
+ class CreateArchiveResponse < Struct.new(
500
+ :archive_id)
501
+ SENSITIVE = []
502
+ include Aws::Structure
503
+ end
504
+
505
+ # @!attribute [rw] client_token
506
+ # A unique token that Amazon SES uses to recognize subsequent retries
507
+ # of the same request.
508
+ #
509
+ # **A suitable default value is auto-generated.** You should normally
510
+ # not need to pass this option.
511
+ # @return [String]
512
+ #
513
+ # @!attribute [rw] ingress_point_configuration
514
+ # If you choose an Authenticated ingress endpoint, you must configure
515
+ # either an SMTP password or a secret ARN.
516
+ # @return [Types::IngressPointConfiguration]
517
+ #
518
+ # @!attribute [rw] ingress_point_name
519
+ # A user friendly name for an ingress endpoint resource.
520
+ # @return [String]
521
+ #
522
+ # @!attribute [rw] rule_set_id
523
+ # The identifier of an existing rule set that you attach to an ingress
524
+ # endpoint resource.
525
+ # @return [String]
526
+ #
527
+ # @!attribute [rw] tags
528
+ # The tags used to organize, track, or control access for the
529
+ # resource. For example, \\\{ "tags": \\\{"key1":"value1",
530
+ # "key2":"value2"\\} \\}.
531
+ # @return [Array<Types::Tag>]
532
+ #
533
+ # @!attribute [rw] traffic_policy_id
534
+ # The identifier of an existing traffic policy that you attach to an
535
+ # ingress endpoint resource.
536
+ # @return [String]
537
+ #
538
+ # @!attribute [rw] type
539
+ # The type of the ingress endpoint to create.
540
+ # @return [String]
541
+ #
542
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mailmanager-2023-10-17/CreateIngressPointRequest AWS API Documentation
543
+ #
544
+ class CreateIngressPointRequest < Struct.new(
545
+ :client_token,
546
+ :ingress_point_configuration,
547
+ :ingress_point_name,
548
+ :rule_set_id,
549
+ :tags,
550
+ :traffic_policy_id,
551
+ :type)
552
+ SENSITIVE = []
553
+ include Aws::Structure
554
+ end
555
+
556
+ # @!attribute [rw] ingress_point_id
557
+ # The unique identifier for a previously created ingress endpoint.
558
+ # @return [String]
559
+ #
560
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mailmanager-2023-10-17/CreateIngressPointResponse AWS API Documentation
561
+ #
562
+ class CreateIngressPointResponse < Struct.new(
563
+ :ingress_point_id)
564
+ SENSITIVE = []
565
+ include Aws::Structure
566
+ end
567
+
568
+ # @!attribute [rw] authentication
569
+ # Authentication for the relay destination server—specify the
570
+ # secretARN where the SMTP credentials are stored.
571
+ # @return [Types::RelayAuthentication]
572
+ #
573
+ # @!attribute [rw] client_token
574
+ # A unique token that Amazon SES uses to recognize subsequent retries
575
+ # of the same request.
576
+ #
577
+ # **A suitable default value is auto-generated.** You should normally
578
+ # not need to pass this option.
579
+ # @return [String]
580
+ #
581
+ # @!attribute [rw] relay_name
582
+ # The unique name of the relay resource.
583
+ # @return [String]
584
+ #
585
+ # @!attribute [rw] server_name
586
+ # The destination relay server address.
587
+ # @return [String]
588
+ #
589
+ # @!attribute [rw] server_port
590
+ # The destination relay server port.
591
+ # @return [Integer]
592
+ #
593
+ # @!attribute [rw] tags
594
+ # The tags used to organize, track, or control access for the
595
+ # resource. For example, \\\{ "tags": \\\{"key1":"value1",
596
+ # "key2":"value2"\\} \\}.
597
+ # @return [Array<Types::Tag>]
598
+ #
599
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mailmanager-2023-10-17/CreateRelayRequest AWS API Documentation
600
+ #
601
+ class CreateRelayRequest < Struct.new(
602
+ :authentication,
603
+ :client_token,
604
+ :relay_name,
605
+ :server_name,
606
+ :server_port,
607
+ :tags)
608
+ SENSITIVE = []
609
+ include Aws::Structure
610
+ end
611
+
612
+ # @!attribute [rw] relay_id
613
+ # A unique identifier of the created relay resource.
614
+ # @return [String]
615
+ #
616
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mailmanager-2023-10-17/CreateRelayResponse AWS API Documentation
617
+ #
618
+ class CreateRelayResponse < Struct.new(
619
+ :relay_id)
620
+ SENSITIVE = []
621
+ include Aws::Structure
622
+ end
623
+
624
+ # @!attribute [rw] client_token
625
+ # A unique token that Amazon SES uses to recognize subsequent retries
626
+ # of the same request.
627
+ #
628
+ # **A suitable default value is auto-generated.** You should normally
629
+ # not need to pass this option.
630
+ # @return [String]
631
+ #
632
+ # @!attribute [rw] rule_set_name
633
+ # A user-friendly name for the rule set.
634
+ # @return [String]
635
+ #
636
+ # @!attribute [rw] rules
637
+ # Conditional rules that are evaluated for determining actions on
638
+ # email.
639
+ # @return [Array<Types::Rule>]
640
+ #
641
+ # @!attribute [rw] tags
642
+ # The tags used to organize, track, or control access for the
643
+ # resource. For example, \\\{ "tags": \\\{"key1":"value1",
644
+ # "key2":"value2"\\} \\}.
645
+ # @return [Array<Types::Tag>]
646
+ #
647
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mailmanager-2023-10-17/CreateRuleSetRequest AWS API Documentation
648
+ #
649
+ class CreateRuleSetRequest < Struct.new(
650
+ :client_token,
651
+ :rule_set_name,
652
+ :rules,
653
+ :tags)
654
+ SENSITIVE = []
655
+ include Aws::Structure
656
+ end
657
+
658
+ # @!attribute [rw] rule_set_id
659
+ # The identifier of the created rule set.
660
+ # @return [String]
661
+ #
662
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mailmanager-2023-10-17/CreateRuleSetResponse AWS API Documentation
663
+ #
664
+ class CreateRuleSetResponse < Struct.new(
665
+ :rule_set_id)
666
+ SENSITIVE = []
667
+ include Aws::Structure
668
+ end
669
+
670
+ # @!attribute [rw] client_token
671
+ # A unique token that Amazon SES uses to recognize subsequent retries
672
+ # of the same request.
673
+ #
674
+ # **A suitable default value is auto-generated.** You should normally
675
+ # not need to pass this option.
676
+ # @return [String]
677
+ #
678
+ # @!attribute [rw] default_action
679
+ # Default action instructs the traffic policy to either Allow or Deny
680
+ # (block) messages that fall outside of (or not addressed by) the
681
+ # conditions of your policy statements
682
+ # @return [String]
683
+ #
684
+ # @!attribute [rw] max_message_size_bytes
685
+ # The maximum message size in bytes of email which is allowed in by
686
+ # this traffic policy—anything larger will be blocked.
687
+ # @return [Integer]
688
+ #
689
+ # @!attribute [rw] policy_statements
690
+ # Conditional statements for filtering email traffic.
691
+ # @return [Array<Types::PolicyStatement>]
692
+ #
693
+ # @!attribute [rw] tags
694
+ # The tags used to organize, track, or control access for the
695
+ # resource. For example, \\\{ "tags": \\\{"key1":"value1",
696
+ # "key2":"value2"\\} \\}.
697
+ # @return [Array<Types::Tag>]
698
+ #
699
+ # @!attribute [rw] traffic_policy_name
700
+ # A user-friendly name for the traffic policy resource.
701
+ # @return [String]
702
+ #
703
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mailmanager-2023-10-17/CreateTrafficPolicyRequest AWS API Documentation
704
+ #
705
+ class CreateTrafficPolicyRequest < Struct.new(
706
+ :client_token,
707
+ :default_action,
708
+ :max_message_size_bytes,
709
+ :policy_statements,
710
+ :tags,
711
+ :traffic_policy_name)
712
+ SENSITIVE = []
713
+ include Aws::Structure
714
+ end
715
+
716
+ # @!attribute [rw] traffic_policy_id
717
+ # The identifier of the traffic policy resource.
718
+ # @return [String]
719
+ #
720
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mailmanager-2023-10-17/CreateTrafficPolicyResponse AWS API Documentation
721
+ #
722
+ class CreateTrafficPolicyResponse < Struct.new(
723
+ :traffic_policy_id)
724
+ SENSITIVE = []
725
+ include Aws::Structure
726
+ end
727
+
728
+ # @!attribute [rw] addon_instance_id
729
+ # The Add On instance ID to delete.
730
+ # @return [String]
731
+ #
732
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mailmanager-2023-10-17/DeleteAddonInstanceRequest AWS API Documentation
733
+ #
734
+ class DeleteAddonInstanceRequest < Struct.new(
735
+ :addon_instance_id)
736
+ SENSITIVE = []
737
+ include Aws::Structure
738
+ end
739
+
740
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mailmanager-2023-10-17/DeleteAddonInstanceResponse AWS API Documentation
741
+ #
742
+ class DeleteAddonInstanceResponse < Aws::EmptyStructure; end
743
+
744
+ # @!attribute [rw] addon_subscription_id
745
+ # The Add On subscription ID to delete.
746
+ # @return [String]
747
+ #
748
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mailmanager-2023-10-17/DeleteAddonSubscriptionRequest AWS API Documentation
749
+ #
750
+ class DeleteAddonSubscriptionRequest < Struct.new(
751
+ :addon_subscription_id)
752
+ SENSITIVE = []
753
+ include Aws::Structure
754
+ end
755
+
756
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mailmanager-2023-10-17/DeleteAddonSubscriptionResponse AWS API Documentation
757
+ #
758
+ class DeleteAddonSubscriptionResponse < Aws::EmptyStructure; end
759
+
760
+ # The request to initiate deletion of an email archive.
761
+ #
762
+ # @!attribute [rw] archive_id
763
+ # The identifier of the archive to delete.
764
+ # @return [String]
765
+ #
766
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mailmanager-2023-10-17/DeleteArchiveRequest AWS API Documentation
767
+ #
768
+ class DeleteArchiveRequest < Struct.new(
769
+ :archive_id)
770
+ SENSITIVE = []
771
+ include Aws::Structure
772
+ end
773
+
774
+ # The response indicating if the archive deletion was successfully
775
+ # initiated.
776
+ #
777
+ # On success, returns an HTTP 200 status code. On failure, returns an
778
+ # error message.
779
+ #
780
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mailmanager-2023-10-17/DeleteArchiveResponse AWS API Documentation
781
+ #
782
+ class DeleteArchiveResponse < Aws::EmptyStructure; end
783
+
784
+ # @!attribute [rw] ingress_point_id
785
+ # The identifier of the ingress endpoint resource that you want to
786
+ # delete.
787
+ # @return [String]
788
+ #
789
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mailmanager-2023-10-17/DeleteIngressPointRequest AWS API Documentation
790
+ #
791
+ class DeleteIngressPointRequest < Struct.new(
792
+ :ingress_point_id)
793
+ SENSITIVE = []
794
+ include Aws::Structure
795
+ end
796
+
797
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mailmanager-2023-10-17/DeleteIngressPointResponse AWS API Documentation
798
+ #
799
+ class DeleteIngressPointResponse < Aws::EmptyStructure; end
800
+
801
+ # @!attribute [rw] relay_id
802
+ # The unique relay identifier.
803
+ # @return [String]
804
+ #
805
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mailmanager-2023-10-17/DeleteRelayRequest AWS API Documentation
806
+ #
807
+ class DeleteRelayRequest < Struct.new(
808
+ :relay_id)
809
+ SENSITIVE = []
810
+ include Aws::Structure
811
+ end
812
+
813
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mailmanager-2023-10-17/DeleteRelayResponse AWS API Documentation
814
+ #
815
+ class DeleteRelayResponse < Aws::EmptyStructure; end
816
+
817
+ # @!attribute [rw] rule_set_id
818
+ # The identifier of an existing rule set resource to delete.
819
+ # @return [String]
820
+ #
821
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mailmanager-2023-10-17/DeleteRuleSetRequest AWS API Documentation
822
+ #
823
+ class DeleteRuleSetRequest < Struct.new(
824
+ :rule_set_id)
825
+ SENSITIVE = []
826
+ include Aws::Structure
827
+ end
828
+
829
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mailmanager-2023-10-17/DeleteRuleSetResponse AWS API Documentation
830
+ #
831
+ class DeleteRuleSetResponse < Aws::EmptyStructure; end
832
+
833
+ # @!attribute [rw] traffic_policy_id
834
+ # The identifier of the traffic policy that you want to delete.
835
+ # @return [String]
836
+ #
837
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mailmanager-2023-10-17/DeleteTrafficPolicyRequest AWS API Documentation
838
+ #
839
+ class DeleteTrafficPolicyRequest < Struct.new(
840
+ :traffic_policy_id)
841
+ SENSITIVE = []
842
+ include Aws::Structure
843
+ end
844
+
845
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mailmanager-2023-10-17/DeleteTrafficPolicyResponse AWS API Documentation
846
+ #
847
+ class DeleteTrafficPolicyResponse < Aws::EmptyStructure; end
848
+
849
+ # This action to delivers an email to a mailbox.
850
+ #
851
+ # @!attribute [rw] action_failure_policy
852
+ # A policy that states what to do in the case of failure. The action
853
+ # will fail if there are configuration errors. For example, the
854
+ # mailbox ARN is no longer valid.
855
+ # @return [String]
856
+ #
857
+ # @!attribute [rw] mailbox_arn
858
+ # The Amazon Resource Name (ARN) of a WorkMail organization to deliver
859
+ # the email to.
860
+ # @return [String]
861
+ #
862
+ # @!attribute [rw] role_arn
863
+ # The Amazon Resource Name (ARN) of an IAM role to use to execute this
864
+ # action. The role must have access to the workmail:DeliverToMailbox
865
+ # API.
866
+ # @return [String]
867
+ #
868
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mailmanager-2023-10-17/DeliverToMailboxAction AWS API Documentation
869
+ #
870
+ class DeliverToMailboxAction < Struct.new(
871
+ :action_failure_policy,
872
+ :mailbox_arn,
873
+ :role_arn)
874
+ SENSITIVE = []
875
+ include Aws::Structure
876
+ end
877
+
878
+ # This action causes processing to stop and the email to be dropped. If
879
+ # the action applies only to certain recipients, only those recipients
880
+ # are dropped, and processing continues for other recipients.
881
+ #
882
+ # @api private
883
+ #
884
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mailmanager-2023-10-17/DropAction AWS API Documentation
885
+ #
886
+ class DropAction < Aws::EmptyStructure; end
887
+
888
+ # The destination configuration for delivering exported email data.
889
+ #
890
+ # @note ExportDestinationConfiguration is a union - when making an API calls you must set exactly one of the members.
891
+ #
892
+ # @note ExportDestinationConfiguration is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of ExportDestinationConfiguration corresponding to the set member.
893
+ #
894
+ # @!attribute [rw] s3
895
+ # Configuration for delivering to an Amazon S3 bucket.
896
+ # @return [Types::S3ExportDestinationConfiguration]
897
+ #
898
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mailmanager-2023-10-17/ExportDestinationConfiguration AWS API Documentation
899
+ #
900
+ class ExportDestinationConfiguration < Struct.new(
901
+ :s3,
902
+ :unknown)
903
+ SENSITIVE = []
904
+ include Aws::Structure
905
+ include Aws::Structure::Union
906
+
907
+ class S3 < ExportDestinationConfiguration; end
908
+ class Unknown < ExportDestinationConfiguration; end
909
+ end
910
+
911
+ # The current status of an archive export job.
912
+ #
913
+ # @!attribute [rw] completion_timestamp
914
+ # The timestamp of when the export job completed (if finished).
915
+ # @return [Time]
916
+ #
917
+ # @!attribute [rw] error_message
918
+ # An error message if the export job failed.
919
+ # @return [String]
920
+ #
921
+ # @!attribute [rw] state
922
+ # The current state of the export job.
923
+ # @return [String]
924
+ #
925
+ # @!attribute [rw] submission_timestamp
926
+ # The timestamp of when the export job was submitted.
927
+ # @return [Time]
928
+ #
929
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mailmanager-2023-10-17/ExportStatus AWS API Documentation
930
+ #
931
+ class ExportStatus < Struct.new(
932
+ :completion_timestamp,
933
+ :error_message,
934
+ :state,
935
+ :submission_timestamp)
936
+ SENSITIVE = []
937
+ include Aws::Structure
938
+ end
939
+
940
+ # Summary statuses of an archive export job.
941
+ #
942
+ # @!attribute [rw] export_id
943
+ # The unique identifier of the export job.
944
+ # @return [String]
945
+ #
946
+ # @!attribute [rw] status
947
+ # The current status of the export job.
948
+ # @return [Types::ExportStatus]
949
+ #
950
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mailmanager-2023-10-17/ExportSummary AWS API Documentation
951
+ #
952
+ class ExportSummary < Struct.new(
953
+ :export_id,
954
+ :status)
955
+ SENSITIVE = []
956
+ include Aws::Structure
957
+ end
958
+
959
+ # @!attribute [rw] addon_instance_id
960
+ # The Add On instance ID to retrieve information for.
961
+ # @return [String]
962
+ #
963
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mailmanager-2023-10-17/GetAddonInstanceRequest AWS API Documentation
964
+ #
965
+ class GetAddonInstanceRequest < Struct.new(
966
+ :addon_instance_id)
967
+ SENSITIVE = []
968
+ include Aws::Structure
969
+ end
970
+
971
+ # @!attribute [rw] addon_instance_arn
972
+ # The Amazon Resource Name (ARN) of the Add On instance.
973
+ # @return [String]
974
+ #
975
+ # @!attribute [rw] addon_name
976
+ # The name of the Add On provider associated to the subscription of
977
+ # the instance.
978
+ # @return [String]
979
+ #
980
+ # @!attribute [rw] addon_subscription_id
981
+ # The subscription ID associated to the instance.
982
+ # @return [String]
983
+ #
984
+ # @!attribute [rw] created_timestamp
985
+ # The timestamp of when the Add On instance was created.
986
+ # @return [Time]
987
+ #
988
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mailmanager-2023-10-17/GetAddonInstanceResponse AWS API Documentation
989
+ #
990
+ class GetAddonInstanceResponse < Struct.new(
991
+ :addon_instance_arn,
992
+ :addon_name,
993
+ :addon_subscription_id,
994
+ :created_timestamp)
995
+ SENSITIVE = []
996
+ include Aws::Structure
997
+ end
998
+
999
+ # @!attribute [rw] addon_subscription_id
1000
+ # The Add On subscription ID to retrieve information for.
1001
+ # @return [String]
1002
+ #
1003
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mailmanager-2023-10-17/GetAddonSubscriptionRequest AWS API Documentation
1004
+ #
1005
+ class GetAddonSubscriptionRequest < Struct.new(
1006
+ :addon_subscription_id)
1007
+ SENSITIVE = []
1008
+ include Aws::Structure
1009
+ end
1010
+
1011
+ # @!attribute [rw] addon_name
1012
+ # The name of the Add On for the subscription.
1013
+ # @return [String]
1014
+ #
1015
+ # @!attribute [rw] addon_subscription_arn
1016
+ # Amazon Resource Name (ARN) for the subscription.
1017
+ # @return [String]
1018
+ #
1019
+ # @!attribute [rw] created_timestamp
1020
+ # The timestamp of when the Add On subscription was created.
1021
+ # @return [Time]
1022
+ #
1023
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mailmanager-2023-10-17/GetAddonSubscriptionResponse AWS API Documentation
1024
+ #
1025
+ class GetAddonSubscriptionResponse < Struct.new(
1026
+ :addon_name,
1027
+ :addon_subscription_arn,
1028
+ :created_timestamp)
1029
+ SENSITIVE = []
1030
+ include Aws::Structure
1031
+ end
1032
+
1033
+ # The request to retrieve details of a specific archive export job.
1034
+ #
1035
+ # @!attribute [rw] export_id
1036
+ # The identifier of the export job to get details for.
1037
+ # @return [String]
1038
+ #
1039
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mailmanager-2023-10-17/GetArchiveExportRequest AWS API Documentation
1040
+ #
1041
+ class GetArchiveExportRequest < Struct.new(
1042
+ :export_id)
1043
+ SENSITIVE = []
1044
+ include Aws::Structure
1045
+ end
1046
+
1047
+ # The response containing details of the specified archive export job.
1048
+ #
1049
+ # @!attribute [rw] archive_id
1050
+ # The identifier of the archive the email export was performed from.
1051
+ # @return [String]
1052
+ #
1053
+ # @!attribute [rw] export_destination_configuration
1054
+ # Where the exported emails are being delivered.
1055
+ # @return [Types::ExportDestinationConfiguration]
1056
+ #
1057
+ # @!attribute [rw] filters
1058
+ # The criteria used to filter emails included in the export.
1059
+ # @return [Types::ArchiveFilters]
1060
+ #
1061
+ # @!attribute [rw] from_timestamp
1062
+ # The start of the timestamp range the exported emails cover.
1063
+ # @return [Time]
1064
+ #
1065
+ # @!attribute [rw] max_results
1066
+ # The maximum number of email items included in the export.
1067
+ # @return [Integer]
1068
+ #
1069
+ # @!attribute [rw] status
1070
+ # The current status of the export job.
1071
+ # @return [Types::ExportStatus]
1072
+ #
1073
+ # @!attribute [rw] to_timestamp
1074
+ # The end of the date range the exported emails cover.
1075
+ # @return [Time]
1076
+ #
1077
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mailmanager-2023-10-17/GetArchiveExportResponse AWS API Documentation
1078
+ #
1079
+ class GetArchiveExportResponse < Struct.new(
1080
+ :archive_id,
1081
+ :export_destination_configuration,
1082
+ :filters,
1083
+ :from_timestamp,
1084
+ :max_results,
1085
+ :status,
1086
+ :to_timestamp)
1087
+ SENSITIVE = []
1088
+ include Aws::Structure
1089
+ end
1090
+
1091
+ # The request to get the textual content of a specific email message
1092
+ # stored in an archive.
1093
+ #
1094
+ # @!attribute [rw] archived_message_id
1095
+ # The unique identifier of the archived email message.
1096
+ # @return [String]
1097
+ #
1098
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mailmanager-2023-10-17/GetArchiveMessageContentRequest AWS API Documentation
1099
+ #
1100
+ class GetArchiveMessageContentRequest < Struct.new(
1101
+ :archived_message_id)
1102
+ SENSITIVE = []
1103
+ include Aws::Structure
1104
+ end
1105
+
1106
+ # The response containing the textual content of the requested archived
1107
+ # email message.
1108
+ #
1109
+ # @!attribute [rw] body
1110
+ # The textual body content of the email message.
1111
+ # @return [Types::MessageBody]
1112
+ #
1113
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mailmanager-2023-10-17/GetArchiveMessageContentResponse AWS API Documentation
1114
+ #
1115
+ class GetArchiveMessageContentResponse < Struct.new(
1116
+ :body)
1117
+ SENSITIVE = []
1118
+ include Aws::Structure
1119
+ end
1120
+
1121
+ # The request to get details of a specific email message stored in an
1122
+ # archive.
1123
+ #
1124
+ # @!attribute [rw] archived_message_id
1125
+ # The unique identifier of the archived email message.
1126
+ # @return [String]
1127
+ #
1128
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mailmanager-2023-10-17/GetArchiveMessageRequest AWS API Documentation
1129
+ #
1130
+ class GetArchiveMessageRequest < Struct.new(
1131
+ :archived_message_id)
1132
+ SENSITIVE = []
1133
+ include Aws::Structure
1134
+ end
1135
+
1136
+ # The response containing details about the requested archived email
1137
+ # message.
1138
+ #
1139
+ # @!attribute [rw] message_download_link
1140
+ # A pre-signed URL to temporarily download the full message content.
1141
+ # @return [String]
1142
+ #
1143
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mailmanager-2023-10-17/GetArchiveMessageResponse AWS API Documentation
1144
+ #
1145
+ class GetArchiveMessageResponse < Struct.new(
1146
+ :message_download_link)
1147
+ SENSITIVE = []
1148
+ include Aws::Structure
1149
+ end
1150
+
1151
+ # The request to retrieve details of an email archive.
1152
+ #
1153
+ # @!attribute [rw] archive_id
1154
+ # The identifier of the archive to retrieve.
1155
+ # @return [String]
1156
+ #
1157
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mailmanager-2023-10-17/GetArchiveRequest AWS API Documentation
1158
+ #
1159
+ class GetArchiveRequest < Struct.new(
1160
+ :archive_id)
1161
+ SENSITIVE = []
1162
+ include Aws::Structure
1163
+ end
1164
+
1165
+ # The response containing details of the requested archive.
1166
+ #
1167
+ # @!attribute [rw] archive_arn
1168
+ # The Amazon Resource Name (ARN) of the archive.
1169
+ # @return [String]
1170
+ #
1171
+ # @!attribute [rw] archive_id
1172
+ # The unique identifier of the archive.
1173
+ # @return [String]
1174
+ #
1175
+ # @!attribute [rw] archive_name
1176
+ # The unique name assigned to the archive.
1177
+ # @return [String]
1178
+ #
1179
+ # @!attribute [rw] archive_state
1180
+ # The current state of the archive:
1181
+ #
1182
+ # * `ACTIVE` – The archive is ready and available for use.
1183
+ #
1184
+ # * `PENDING_DELETION` – The archive has been marked for deletion and
1185
+ # will be permanently deleted in 30 days. No further modifications
1186
+ # can be made in this state.
1187
+ # @return [String]
1188
+ #
1189
+ # @!attribute [rw] created_timestamp
1190
+ # The timestamp of when the archive was created.
1191
+ # @return [Time]
1192
+ #
1193
+ # @!attribute [rw] kms_key_arn
1194
+ # The Amazon Resource Name (ARN) of the KMS key used to encrypt the
1195
+ # archive.
1196
+ # @return [String]
1197
+ #
1198
+ # @!attribute [rw] last_updated_timestamp
1199
+ # The timestamp of when the archive was modified.
1200
+ # @return [Time]
1201
+ #
1202
+ # @!attribute [rw] retention
1203
+ # The retention period for emails in this archive.
1204
+ # @return [Types::ArchiveRetention]
1205
+ #
1206
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mailmanager-2023-10-17/GetArchiveResponse AWS API Documentation
1207
+ #
1208
+ class GetArchiveResponse < Struct.new(
1209
+ :archive_arn,
1210
+ :archive_id,
1211
+ :archive_name,
1212
+ :archive_state,
1213
+ :created_timestamp,
1214
+ :kms_key_arn,
1215
+ :last_updated_timestamp,
1216
+ :retention)
1217
+ SENSITIVE = []
1218
+ include Aws::Structure
1219
+ end
1220
+
1221
+ # The request to retrieve details of a specific archive search job.
1222
+ #
1223
+ # @!attribute [rw] search_id
1224
+ # The identifier of the search job to get details for.
1225
+ # @return [String]
1226
+ #
1227
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mailmanager-2023-10-17/GetArchiveSearchRequest AWS API Documentation
1228
+ #
1229
+ class GetArchiveSearchRequest < Struct.new(
1230
+ :search_id)
1231
+ SENSITIVE = []
1232
+ include Aws::Structure
1233
+ end
1234
+
1235
+ # The response containing details of the specified archive search job.
1236
+ #
1237
+ # @!attribute [rw] archive_id
1238
+ # The identifier of the archive the email search was performed in.
1239
+ # @return [String]
1240
+ #
1241
+ # @!attribute [rw] filters
1242
+ # The criteria used to filter emails included in the search.
1243
+ # @return [Types::ArchiveFilters]
1244
+ #
1245
+ # @!attribute [rw] from_timestamp
1246
+ # The start timestamp of the range the searched emails cover.
1247
+ # @return [Time]
1248
+ #
1249
+ # @!attribute [rw] max_results
1250
+ # The maximum number of search results to return.
1251
+ # @return [Integer]
1252
+ #
1253
+ # @!attribute [rw] status
1254
+ # The current status of the search job.
1255
+ # @return [Types::SearchStatus]
1256
+ #
1257
+ # @!attribute [rw] to_timestamp
1258
+ # The end timestamp of the range the searched emails cover.
1259
+ # @return [Time]
1260
+ #
1261
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mailmanager-2023-10-17/GetArchiveSearchResponse AWS API Documentation
1262
+ #
1263
+ class GetArchiveSearchResponse < Struct.new(
1264
+ :archive_id,
1265
+ :filters,
1266
+ :from_timestamp,
1267
+ :max_results,
1268
+ :status,
1269
+ :to_timestamp)
1270
+ SENSITIVE = []
1271
+ include Aws::Structure
1272
+ end
1273
+
1274
+ # The request to retrieve results from a completed archive search job.
1275
+ #
1276
+ # @!attribute [rw] search_id
1277
+ # The identifier of the completed search job.
1278
+ # @return [String]
1279
+ #
1280
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mailmanager-2023-10-17/GetArchiveSearchResultsRequest AWS API Documentation
1281
+ #
1282
+ class GetArchiveSearchResultsRequest < Struct.new(
1283
+ :search_id)
1284
+ SENSITIVE = []
1285
+ include Aws::Structure
1286
+ end
1287
+
1288
+ # The response containing search results from a completed archive
1289
+ # search.
1290
+ #
1291
+ # @!attribute [rw] rows
1292
+ # The list of email result objects matching the search criteria.
1293
+ # @return [Array<Types::Row>]
1294
+ #
1295
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mailmanager-2023-10-17/GetArchiveSearchResultsResponse AWS API Documentation
1296
+ #
1297
+ class GetArchiveSearchResultsResponse < Struct.new(
1298
+ :rows)
1299
+ SENSITIVE = []
1300
+ include Aws::Structure
1301
+ end
1302
+
1303
+ # @!attribute [rw] ingress_point_id
1304
+ # The identifier of an ingress endpoint.
1305
+ # @return [String]
1306
+ #
1307
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mailmanager-2023-10-17/GetIngressPointRequest AWS API Documentation
1308
+ #
1309
+ class GetIngressPointRequest < Struct.new(
1310
+ :ingress_point_id)
1311
+ SENSITIVE = []
1312
+ include Aws::Structure
1313
+ end
1314
+
1315
+ # @!attribute [rw] a_record
1316
+ # The DNS A Record that identifies your ingress endpoint. Configure
1317
+ # your DNS Mail Exchange (MX) record with this value to route emails
1318
+ # to Mail Manager.
1319
+ # @return [String]
1320
+ #
1321
+ # @!attribute [rw] created_timestamp
1322
+ # The timestamp of when the ingress endpoint was created.
1323
+ # @return [Time]
1324
+ #
1325
+ # @!attribute [rw] ingress_point_arn
1326
+ # The Amazon Resource Name (ARN) of the ingress endpoint resource.
1327
+ # @return [String]
1328
+ #
1329
+ # @!attribute [rw] ingress_point_auth_configuration
1330
+ # The authentication configuration of the ingress endpoint resource.
1331
+ # @return [Types::IngressPointAuthConfiguration]
1332
+ #
1333
+ # @!attribute [rw] ingress_point_id
1334
+ # The identifier of an ingress endpoint resource.
1335
+ # @return [String]
1336
+ #
1337
+ # @!attribute [rw] ingress_point_name
1338
+ # A user friendly name for the ingress endpoint.
1339
+ # @return [String]
1340
+ #
1341
+ # @!attribute [rw] last_updated_timestamp
1342
+ # The timestamp of when the ingress endpoint was last updated.
1343
+ # @return [Time]
1344
+ #
1345
+ # @!attribute [rw] rule_set_id
1346
+ # The identifier of a rule set resource associated with the ingress
1347
+ # endpoint.
1348
+ # @return [String]
1349
+ #
1350
+ # @!attribute [rw] status
1351
+ # The status of the ingress endpoint resource.
1352
+ # @return [String]
1353
+ #
1354
+ # @!attribute [rw] traffic_policy_id
1355
+ # The identifier of the traffic policy resource associated with the
1356
+ # ingress endpoint.
1357
+ # @return [String]
1358
+ #
1359
+ # @!attribute [rw] type
1360
+ # The type of ingress endpoint.
1361
+ # @return [String]
1362
+ #
1363
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mailmanager-2023-10-17/GetIngressPointResponse AWS API Documentation
1364
+ #
1365
+ class GetIngressPointResponse < Struct.new(
1366
+ :a_record,
1367
+ :created_timestamp,
1368
+ :ingress_point_arn,
1369
+ :ingress_point_auth_configuration,
1370
+ :ingress_point_id,
1371
+ :ingress_point_name,
1372
+ :last_updated_timestamp,
1373
+ :rule_set_id,
1374
+ :status,
1375
+ :traffic_policy_id,
1376
+ :type)
1377
+ SENSITIVE = []
1378
+ include Aws::Structure
1379
+ end
1380
+
1381
+ # @!attribute [rw] relay_id
1382
+ # A unique relay identifier.
1383
+ # @return [String]
1384
+ #
1385
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mailmanager-2023-10-17/GetRelayRequest AWS API Documentation
1386
+ #
1387
+ class GetRelayRequest < Struct.new(
1388
+ :relay_id)
1389
+ SENSITIVE = []
1390
+ include Aws::Structure
1391
+ end
1392
+
1393
+ # @!attribute [rw] authentication
1394
+ # The authentication attribute—contains the secret ARN where the
1395
+ # customer relay server credentials are stored.
1396
+ # @return [Types::RelayAuthentication]
1397
+ #
1398
+ # @!attribute [rw] created_timestamp
1399
+ # The timestamp of when the relay was created.
1400
+ # @return [Time]
1401
+ #
1402
+ # @!attribute [rw] last_modified_timestamp
1403
+ # The timestamp of when relay was last updated.
1404
+ # @return [Time]
1405
+ #
1406
+ # @!attribute [rw] relay_arn
1407
+ # The Amazon Resource Name (ARN) of the relay.
1408
+ # @return [String]
1409
+ #
1410
+ # @!attribute [rw] relay_id
1411
+ # The unique relay identifier.
1412
+ # @return [String]
1413
+ #
1414
+ # @!attribute [rw] relay_name
1415
+ # The unique name of the relay.
1416
+ # @return [String]
1417
+ #
1418
+ # @!attribute [rw] server_name
1419
+ # The destination relay server address.
1420
+ # @return [String]
1421
+ #
1422
+ # @!attribute [rw] server_port
1423
+ # The destination relay server port.
1424
+ # @return [Integer]
1425
+ #
1426
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mailmanager-2023-10-17/GetRelayResponse AWS API Documentation
1427
+ #
1428
+ class GetRelayResponse < Struct.new(
1429
+ :authentication,
1430
+ :created_timestamp,
1431
+ :last_modified_timestamp,
1432
+ :relay_arn,
1433
+ :relay_id,
1434
+ :relay_name,
1435
+ :server_name,
1436
+ :server_port)
1437
+ SENSITIVE = []
1438
+ include Aws::Structure
1439
+ end
1440
+
1441
+ # @!attribute [rw] rule_set_id
1442
+ # The identifier of an existing rule set to be retrieved.
1443
+ # @return [String]
1444
+ #
1445
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mailmanager-2023-10-17/GetRuleSetRequest AWS API Documentation
1446
+ #
1447
+ class GetRuleSetRequest < Struct.new(
1448
+ :rule_set_id)
1449
+ SENSITIVE = []
1450
+ include Aws::Structure
1451
+ end
1452
+
1453
+ # @!attribute [rw] created_date
1454
+ # The date of when then rule set was created.
1455
+ # @return [Time]
1456
+ #
1457
+ # @!attribute [rw] last_modification_date
1458
+ # The date of when the rule set was last modified.
1459
+ # @return [Time]
1460
+ #
1461
+ # @!attribute [rw] rule_set_arn
1462
+ # The Amazon Resource Name (ARN) of the rule set resource.
1463
+ # @return [String]
1464
+ #
1465
+ # @!attribute [rw] rule_set_id
1466
+ # The identifier of the rule set resource.
1467
+ # @return [String]
1468
+ #
1469
+ # @!attribute [rw] rule_set_name
1470
+ # A user-friendly name for the rule set resource.
1471
+ # @return [String]
1472
+ #
1473
+ # @!attribute [rw] rules
1474
+ # The rules contained in the rule set.
1475
+ # @return [Array<Types::Rule>]
1476
+ #
1477
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mailmanager-2023-10-17/GetRuleSetResponse AWS API Documentation
1478
+ #
1479
+ class GetRuleSetResponse < Struct.new(
1480
+ :created_date,
1481
+ :last_modification_date,
1482
+ :rule_set_arn,
1483
+ :rule_set_id,
1484
+ :rule_set_name,
1485
+ :rules)
1486
+ SENSITIVE = []
1487
+ include Aws::Structure
1488
+ end
1489
+
1490
+ # @!attribute [rw] traffic_policy_id
1491
+ # The identifier of the traffic policy resource.
1492
+ # @return [String]
1493
+ #
1494
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mailmanager-2023-10-17/GetTrafficPolicyRequest AWS API Documentation
1495
+ #
1496
+ class GetTrafficPolicyRequest < Struct.new(
1497
+ :traffic_policy_id)
1498
+ SENSITIVE = []
1499
+ include Aws::Structure
1500
+ end
1501
+
1502
+ # @!attribute [rw] created_timestamp
1503
+ # The timestamp of when the traffic policy was created.
1504
+ # @return [Time]
1505
+ #
1506
+ # @!attribute [rw] default_action
1507
+ # The default action of the traffic policy.
1508
+ # @return [String]
1509
+ #
1510
+ # @!attribute [rw] last_updated_timestamp
1511
+ # The timestamp of when the traffic policy was last updated.
1512
+ # @return [Time]
1513
+ #
1514
+ # @!attribute [rw] max_message_size_bytes
1515
+ # The maximum message size in bytes of email which is allowed in by
1516
+ # this traffic policy—anything larger will be blocked.
1517
+ # @return [Integer]
1518
+ #
1519
+ # @!attribute [rw] policy_statements
1520
+ # The list of conditions which are in the traffic policy resource.
1521
+ # @return [Array<Types::PolicyStatement>]
1522
+ #
1523
+ # @!attribute [rw] traffic_policy_arn
1524
+ # The Amazon Resource Name (ARN) of the traffic policy resource.
1525
+ # @return [String]
1526
+ #
1527
+ # @!attribute [rw] traffic_policy_id
1528
+ # The identifier of the traffic policy resource.
1529
+ # @return [String]
1530
+ #
1531
+ # @!attribute [rw] traffic_policy_name
1532
+ # A user-friendly name for the traffic policy resource.
1533
+ # @return [String]
1534
+ #
1535
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mailmanager-2023-10-17/GetTrafficPolicyResponse AWS API Documentation
1536
+ #
1537
+ class GetTrafficPolicyResponse < Struct.new(
1538
+ :created_timestamp,
1539
+ :default_action,
1540
+ :last_updated_timestamp,
1541
+ :max_message_size_bytes,
1542
+ :policy_statements,
1543
+ :traffic_policy_arn,
1544
+ :traffic_policy_id,
1545
+ :traffic_policy_name)
1546
+ SENSITIVE = []
1547
+ include Aws::Structure
1548
+ end
1549
+
1550
+ # The Add On ARN and its returned value that is evaluated in a policy
1551
+ # statement's conditional expression to either deny or block the
1552
+ # incoming email.
1553
+ #
1554
+ # @!attribute [rw] analyzer
1555
+ # The Amazon Resource Name (ARN) of an Add On.
1556
+ # @return [String]
1557
+ #
1558
+ # @!attribute [rw] result_field
1559
+ # The returned value from an Add On.
1560
+ # @return [String]
1561
+ #
1562
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mailmanager-2023-10-17/IngressAnalysis AWS API Documentation
1563
+ #
1564
+ class IngressAnalysis < Struct.new(
1565
+ :analyzer,
1566
+ :result_field)
1567
+ SENSITIVE = []
1568
+ include Aws::Structure
1569
+ end
1570
+
1571
+ # The structure for a boolean condition matching on the incoming mail.
1572
+ #
1573
+ # @!attribute [rw] evaluate
1574
+ # The operand on which to perform a boolean condition operation.
1575
+ # @return [Types::IngressBooleanToEvaluate]
1576
+ #
1577
+ # @!attribute [rw] operator
1578
+ # The matching operator for a boolean condition expression.
1579
+ # @return [String]
1580
+ #
1581
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mailmanager-2023-10-17/IngressBooleanExpression AWS API Documentation
1582
+ #
1583
+ class IngressBooleanExpression < Struct.new(
1584
+ :evaluate,
1585
+ :operator)
1586
+ SENSITIVE = []
1587
+ include Aws::Structure
1588
+ end
1589
+
1590
+ # The union type representing the allowed types of operands for a
1591
+ # boolean condition.
1592
+ #
1593
+ # @note IngressBooleanToEvaluate is a union - when making an API calls you must set exactly one of the members.
1594
+ #
1595
+ # @note IngressBooleanToEvaluate is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of IngressBooleanToEvaluate corresponding to the set member.
1596
+ #
1597
+ # @!attribute [rw] analysis
1598
+ # The structure type for a boolean condition stating the Add On ARN
1599
+ # and its returned value.
1600
+ # @return [Types::IngressAnalysis]
1601
+ #
1602
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mailmanager-2023-10-17/IngressBooleanToEvaluate AWS API Documentation
1603
+ #
1604
+ class IngressBooleanToEvaluate < Struct.new(
1605
+ :analysis,
1606
+ :unknown)
1607
+ SENSITIVE = []
1608
+ include Aws::Structure
1609
+ include Aws::Structure::Union
1610
+
1611
+ class Analysis < IngressBooleanToEvaluate; end
1612
+ class Unknown < IngressBooleanToEvaluate; end
1613
+ end
1614
+
1615
+ # The structure for an IP based condition matching on the incoming mail.
1616
+ #
1617
+ # @note IngressIpToEvaluate is a union - when making an API calls you must set exactly one of the members.
1618
+ #
1619
+ # @note IngressIpToEvaluate is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of IngressIpToEvaluate corresponding to the set member.
1620
+ #
1621
+ # @!attribute [rw] attribute
1622
+ # An enum type representing the allowed attribute types for an IP
1623
+ # condition.
1624
+ # @return [String]
1625
+ #
1626
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mailmanager-2023-10-17/IngressIpToEvaluate AWS API Documentation
1627
+ #
1628
+ class IngressIpToEvaluate < Struct.new(
1629
+ :attribute,
1630
+ :unknown)
1631
+ SENSITIVE = []
1632
+ include Aws::Structure
1633
+ include Aws::Structure::Union
1634
+
1635
+ class Attribute < IngressIpToEvaluate; end
1636
+ class Unknown < IngressIpToEvaluate; end
1637
+ end
1638
+
1639
+ # The union type representing the allowed types for the left hand side
1640
+ # of an IP condition.
1641
+ #
1642
+ # @!attribute [rw] evaluate
1643
+ # The left hand side argument of an IP condition expression.
1644
+ # @return [Types::IngressIpToEvaluate]
1645
+ #
1646
+ # @!attribute [rw] operator
1647
+ # The matching operator for an IP condition expression.
1648
+ # @return [String]
1649
+ #
1650
+ # @!attribute [rw] values
1651
+ # The right hand side argument of an IP condition expression.
1652
+ # @return [Array<String>]
1653
+ #
1654
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mailmanager-2023-10-17/IngressIpv4Expression AWS API Documentation
1655
+ #
1656
+ class IngressIpv4Expression < Struct.new(
1657
+ :evaluate,
1658
+ :operator,
1659
+ :values)
1660
+ SENSITIVE = []
1661
+ include Aws::Structure
1662
+ end
1663
+
1664
+ # The structure of an ingress endpoint resource.
1665
+ #
1666
+ # @!attribute [rw] a_record
1667
+ # The DNS A Record that identifies your ingress endpoint. Configure
1668
+ # your DNS Mail Exchange (MX) record with this value to route emails
1669
+ # to Mail Manager.
1670
+ # @return [String]
1671
+ #
1672
+ # @!attribute [rw] ingress_point_id
1673
+ # The identifier of the ingress endpoint resource.
1674
+ # @return [String]
1675
+ #
1676
+ # @!attribute [rw] ingress_point_name
1677
+ # A user friendly name for the ingress endpoint resource.
1678
+ # @return [String]
1679
+ #
1680
+ # @!attribute [rw] status
1681
+ # The status of the ingress endpoint resource.
1682
+ # @return [String]
1683
+ #
1684
+ # @!attribute [rw] type
1685
+ # The type of ingress endpoint resource.
1686
+ # @return [String]
1687
+ #
1688
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mailmanager-2023-10-17/IngressPoint AWS API Documentation
1689
+ #
1690
+ class IngressPoint < Struct.new(
1691
+ :a_record,
1692
+ :ingress_point_id,
1693
+ :ingress_point_name,
1694
+ :status,
1695
+ :type)
1696
+ SENSITIVE = []
1697
+ include Aws::Structure
1698
+ end
1699
+
1700
+ # The authentication configuration for the ingress endpoint resource.
1701
+ #
1702
+ # @!attribute [rw] ingress_point_password_configuration
1703
+ # The ingress endpoint password configuration for the ingress endpoint
1704
+ # resource.
1705
+ # @return [Types::IngressPointPasswordConfiguration]
1706
+ #
1707
+ # @!attribute [rw] secret_arn
1708
+ # The ingress endpoint SecretsManager::Secret ARN configuration for
1709
+ # the ingress endpoint resource.
1710
+ # @return [String]
1711
+ #
1712
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mailmanager-2023-10-17/IngressPointAuthConfiguration AWS API Documentation
1713
+ #
1714
+ class IngressPointAuthConfiguration < Struct.new(
1715
+ :ingress_point_password_configuration,
1716
+ :secret_arn)
1717
+ SENSITIVE = []
1718
+ include Aws::Structure
1719
+ end
1720
+
1721
+ # The configuration of the ingress endpoint resource.
1722
+ #
1723
+ # @note IngressPointConfiguration is a union - when making an API calls you must set exactly one of the members.
1724
+ #
1725
+ # @!attribute [rw] secret_arn
1726
+ # The SecretsManager::Secret ARN of the ingress endpoint resource.
1727
+ # @return [String]
1728
+ #
1729
+ # @!attribute [rw] smtp_password
1730
+ # The password of the ingress endpoint resource.
1731
+ # @return [String]
1732
+ #
1733
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mailmanager-2023-10-17/IngressPointConfiguration AWS API Documentation
1734
+ #
1735
+ class IngressPointConfiguration < Struct.new(
1736
+ :secret_arn,
1737
+ :smtp_password,
1738
+ :unknown)
1739
+ SENSITIVE = [:smtp_password]
1740
+ include Aws::Structure
1741
+ include Aws::Structure::Union
1742
+
1743
+ class SecretArn < IngressPointConfiguration; end
1744
+ class SmtpPassword < IngressPointConfiguration; end
1745
+ class Unknown < IngressPointConfiguration; end
1746
+ end
1747
+
1748
+ # The password configuration of the ingress endpoint resource.
1749
+ #
1750
+ # @!attribute [rw] previous_smtp_password_expiry_timestamp
1751
+ # The previous password expiry timestamp of the ingress endpoint
1752
+ # resource.
1753
+ # @return [Time]
1754
+ #
1755
+ # @!attribute [rw] previous_smtp_password_version
1756
+ # The previous password version of the ingress endpoint resource.
1757
+ # @return [String]
1758
+ #
1759
+ # @!attribute [rw] smtp_password_version
1760
+ # The current password expiry timestamp of the ingress endpoint
1761
+ # resource.
1762
+ # @return [String]
1763
+ #
1764
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mailmanager-2023-10-17/IngressPointPasswordConfiguration AWS API Documentation
1765
+ #
1766
+ class IngressPointPasswordConfiguration < Struct.new(
1767
+ :previous_smtp_password_expiry_timestamp,
1768
+ :previous_smtp_password_version,
1769
+ :smtp_password_version)
1770
+ SENSITIVE = []
1771
+ include Aws::Structure
1772
+ end
1773
+
1774
+ # The structure for a string based condition matching on the incoming
1775
+ # mail.
1776
+ #
1777
+ # @!attribute [rw] evaluate
1778
+ # The left hand side argument of a string condition expression.
1779
+ # @return [Types::IngressStringToEvaluate]
1780
+ #
1781
+ # @!attribute [rw] operator
1782
+ # The matching operator for a string condition expression.
1783
+ # @return [String]
1784
+ #
1785
+ # @!attribute [rw] values
1786
+ # The right hand side argument of a string condition expression.
1787
+ # @return [Array<String>]
1788
+ #
1789
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mailmanager-2023-10-17/IngressStringExpression AWS API Documentation
1790
+ #
1791
+ class IngressStringExpression < Struct.new(
1792
+ :evaluate,
1793
+ :operator,
1794
+ :values)
1795
+ SENSITIVE = []
1796
+ include Aws::Structure
1797
+ end
1798
+
1799
+ # The union type representing the allowed types for the left hand side
1800
+ # of a string condition.
1801
+ #
1802
+ # @note IngressStringToEvaluate is a union - when making an API calls you must set exactly one of the members.
1803
+ #
1804
+ # @note IngressStringToEvaluate is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of IngressStringToEvaluate corresponding to the set member.
1805
+ #
1806
+ # @!attribute [rw] attribute
1807
+ # The enum type representing the allowed attribute types for a string
1808
+ # condition.
1809
+ # @return [String]
1810
+ #
1811
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mailmanager-2023-10-17/IngressStringToEvaluate AWS API Documentation
1812
+ #
1813
+ class IngressStringToEvaluate < Struct.new(
1814
+ :attribute,
1815
+ :unknown)
1816
+ SENSITIVE = []
1817
+ include Aws::Structure
1818
+ include Aws::Structure::Union
1819
+
1820
+ class Attribute < IngressStringToEvaluate; end
1821
+ class Unknown < IngressStringToEvaluate; end
1822
+ end
1823
+
1824
+ # The structure for a TLS related condition matching on the incoming
1825
+ # mail.
1826
+ #
1827
+ # @!attribute [rw] evaluate
1828
+ # The left hand side argument of a TLS condition expression.
1829
+ # @return [Types::IngressTlsProtocolToEvaluate]
1830
+ #
1831
+ # @!attribute [rw] operator
1832
+ # The matching operator for a TLS condition expression.
1833
+ # @return [String]
1834
+ #
1835
+ # @!attribute [rw] value
1836
+ # The right hand side argument of a TLS condition expression.
1837
+ # @return [String]
1838
+ #
1839
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mailmanager-2023-10-17/IngressTlsProtocolExpression AWS API Documentation
1840
+ #
1841
+ class IngressTlsProtocolExpression < Struct.new(
1842
+ :evaluate,
1843
+ :operator,
1844
+ :value)
1845
+ SENSITIVE = []
1846
+ include Aws::Structure
1847
+ end
1848
+
1849
+ # The union type representing the allowed types for the left hand side
1850
+ # of a TLS condition.
1851
+ #
1852
+ # @note IngressTlsProtocolToEvaluate is a union - when making an API calls you must set exactly one of the members.
1853
+ #
1854
+ # @note IngressTlsProtocolToEvaluate is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of IngressTlsProtocolToEvaluate corresponding to the set member.
1855
+ #
1856
+ # @!attribute [rw] attribute
1857
+ # The enum type representing the allowed attribute types for the TLS
1858
+ # condition.
1859
+ # @return [String]
1860
+ #
1861
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mailmanager-2023-10-17/IngressTlsProtocolToEvaluate AWS API Documentation
1862
+ #
1863
+ class IngressTlsProtocolToEvaluate < Struct.new(
1864
+ :attribute,
1865
+ :unknown)
1866
+ SENSITIVE = []
1867
+ include Aws::Structure
1868
+ include Aws::Structure::Union
1869
+
1870
+ class Attribute < IngressTlsProtocolToEvaluate; end
1871
+ class Unknown < IngressTlsProtocolToEvaluate; end
1872
+ end
1873
+
1874
+ # @!attribute [rw] next_token
1875
+ # If you received a pagination token from a previous call to this API,
1876
+ # you can provide it here to continue paginating through the next page
1877
+ # of results.
1878
+ # @return [String]
1879
+ #
1880
+ # @!attribute [rw] page_size
1881
+ # The maximum number of ingress endpoint resources that are returned
1882
+ # per call. You can use NextToken to obtain further ingress endpoints.
1883
+ # @return [Integer]
1884
+ #
1885
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mailmanager-2023-10-17/ListAddonInstancesRequest AWS API Documentation
1886
+ #
1887
+ class ListAddonInstancesRequest < Struct.new(
1888
+ :next_token,
1889
+ :page_size)
1890
+ SENSITIVE = []
1891
+ include Aws::Structure
1892
+ end
1893
+
1894
+ # @!attribute [rw] addon_instances
1895
+ # The list of ingress endpoints.
1896
+ # @return [Array<Types::AddonInstance>]
1897
+ #
1898
+ # @!attribute [rw] next_token
1899
+ # If NextToken is returned, there are more results available. The
1900
+ # value of NextToken is a unique pagination token for each page. Make
1901
+ # the call again using the returned token to retrieve the next page.
1902
+ # @return [String]
1903
+ #
1904
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mailmanager-2023-10-17/ListAddonInstancesResponse AWS API Documentation
1905
+ #
1906
+ class ListAddonInstancesResponse < Struct.new(
1907
+ :addon_instances,
1908
+ :next_token)
1909
+ SENSITIVE = []
1910
+ include Aws::Structure
1911
+ end
1912
+
1913
+ # @!attribute [rw] next_token
1914
+ # If you received a pagination token from a previous call to this API,
1915
+ # you can provide it here to continue paginating through the next page
1916
+ # of results.
1917
+ # @return [String]
1918
+ #
1919
+ # @!attribute [rw] page_size
1920
+ # The maximum number of ingress endpoint resources that are returned
1921
+ # per call. You can use NextToken to obtain further ingress endpoints.
1922
+ # @return [Integer]
1923
+ #
1924
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mailmanager-2023-10-17/ListAddonSubscriptionsRequest AWS API Documentation
1925
+ #
1926
+ class ListAddonSubscriptionsRequest < Struct.new(
1927
+ :next_token,
1928
+ :page_size)
1929
+ SENSITIVE = []
1930
+ include Aws::Structure
1931
+ end
1932
+
1933
+ # @!attribute [rw] addon_subscriptions
1934
+ # The list of ingress endpoints.
1935
+ # @return [Array<Types::AddonSubscription>]
1936
+ #
1937
+ # @!attribute [rw] next_token
1938
+ # If NextToken is returned, there are more results available. The
1939
+ # value of NextToken is a unique pagination token for each page. Make
1940
+ # the call again using the returned token to retrieve the next page.
1941
+ # @return [String]
1942
+ #
1943
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mailmanager-2023-10-17/ListAddonSubscriptionsResponse AWS API Documentation
1944
+ #
1945
+ class ListAddonSubscriptionsResponse < Struct.new(
1946
+ :addon_subscriptions,
1947
+ :next_token)
1948
+ SENSITIVE = []
1949
+ include Aws::Structure
1950
+ end
1951
+
1952
+ # The request to list archive export jobs in your account.
1953
+ #
1954
+ # @!attribute [rw] archive_id
1955
+ # The identifier of the archive.
1956
+ # @return [String]
1957
+ #
1958
+ # @!attribute [rw] next_token
1959
+ # If NextToken is returned, there are more results available. The
1960
+ # value of NextToken is a unique pagination token for each page. Make
1961
+ # the call again using the returned token to retrieve the next page.
1962
+ # @return [String]
1963
+ #
1964
+ # @!attribute [rw] page_size
1965
+ # The maximum number of archive export jobs that are returned per
1966
+ # call. You can use NextToken to obtain further pages of archives.
1967
+ # @return [Integer]
1968
+ #
1969
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mailmanager-2023-10-17/ListArchiveExportsRequest AWS API Documentation
1970
+ #
1971
+ class ListArchiveExportsRequest < Struct.new(
1972
+ :archive_id,
1973
+ :next_token,
1974
+ :page_size)
1975
+ SENSITIVE = []
1976
+ include Aws::Structure
1977
+ end
1978
+
1979
+ # The response containing a list of archive export jobs and their
1980
+ # statuses.
1981
+ #
1982
+ # @!attribute [rw] exports
1983
+ # The list of export job identifiers and statuses.
1984
+ # @return [Array<Types::ExportSummary>]
1985
+ #
1986
+ # @!attribute [rw] next_token
1987
+ # If present, use to retrieve the next page of results.
1988
+ # @return [String]
1989
+ #
1990
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mailmanager-2023-10-17/ListArchiveExportsResponse AWS API Documentation
1991
+ #
1992
+ class ListArchiveExportsResponse < Struct.new(
1993
+ :exports,
1994
+ :next_token)
1995
+ SENSITIVE = []
1996
+ include Aws::Structure
1997
+ end
1998
+
1999
+ # The request to list archive search jobs in your account.
2000
+ #
2001
+ # @!attribute [rw] archive_id
2002
+ # The identifier of the archive.
2003
+ # @return [String]
2004
+ #
2005
+ # @!attribute [rw] next_token
2006
+ # If NextToken is returned, there are more results available. The
2007
+ # value of NextToken is a unique pagination token for each page. Make
2008
+ # the call again using the returned token to retrieve the next page.
2009
+ # @return [String]
2010
+ #
2011
+ # @!attribute [rw] page_size
2012
+ # The maximum number of archive search jobs that are returned per
2013
+ # call. You can use NextToken to obtain further pages of archives.
2014
+ # @return [Integer]
2015
+ #
2016
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mailmanager-2023-10-17/ListArchiveSearchesRequest AWS API Documentation
2017
+ #
2018
+ class ListArchiveSearchesRequest < Struct.new(
2019
+ :archive_id,
2020
+ :next_token,
2021
+ :page_size)
2022
+ SENSITIVE = []
2023
+ include Aws::Structure
2024
+ end
2025
+
2026
+ # The response containing a list of archive search jobs and their
2027
+ # statuses.
2028
+ #
2029
+ # @!attribute [rw] next_token
2030
+ # If present, use to retrieve the next page of results.
2031
+ # @return [String]
2032
+ #
2033
+ # @!attribute [rw] searches
2034
+ # The list of search job identifiers and statuses.
2035
+ # @return [Array<Types::SearchSummary>]
2036
+ #
2037
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mailmanager-2023-10-17/ListArchiveSearchesResponse AWS API Documentation
2038
+ #
2039
+ class ListArchiveSearchesResponse < Struct.new(
2040
+ :next_token,
2041
+ :searches)
2042
+ SENSITIVE = []
2043
+ include Aws::Structure
2044
+ end
2045
+
2046
+ # The request to list email archives in your account.
2047
+ #
2048
+ # @!attribute [rw] next_token
2049
+ # If NextToken is returned, there are more results available. The
2050
+ # value of NextToken is a unique pagination token for each page. Make
2051
+ # the call again using the returned token to retrieve the next page.
2052
+ # @return [String]
2053
+ #
2054
+ # @!attribute [rw] page_size
2055
+ # The maximum number of archives that are returned per call. You can
2056
+ # use NextToken to obtain further pages of archives.
2057
+ # @return [Integer]
2058
+ #
2059
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mailmanager-2023-10-17/ListArchivesRequest AWS API Documentation
2060
+ #
2061
+ class ListArchivesRequest < Struct.new(
2062
+ :next_token,
2063
+ :page_size)
2064
+ SENSITIVE = []
2065
+ include Aws::Structure
2066
+ end
2067
+
2068
+ # The response containing a list of your email archives.
2069
+ #
2070
+ # @!attribute [rw] archives
2071
+ # The list of archive details.
2072
+ # @return [Array<Types::Archive>]
2073
+ #
2074
+ # @!attribute [rw] next_token
2075
+ # If present, use to retrieve the next page of results.
2076
+ # @return [String]
2077
+ #
2078
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mailmanager-2023-10-17/ListArchivesResponse AWS API Documentation
2079
+ #
2080
+ class ListArchivesResponse < Struct.new(
2081
+ :archives,
2082
+ :next_token)
2083
+ SENSITIVE = []
2084
+ include Aws::Structure
2085
+ end
2086
+
2087
+ # @!attribute [rw] next_token
2088
+ # If you received a pagination token from a previous call to this API,
2089
+ # you can provide it here to continue paginating through the next page
2090
+ # of results.
2091
+ # @return [String]
2092
+ #
2093
+ # @!attribute [rw] page_size
2094
+ # The maximum number of ingress endpoint resources that are returned
2095
+ # per call. You can use NextToken to obtain further ingress endpoints.
2096
+ # @return [Integer]
2097
+ #
2098
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mailmanager-2023-10-17/ListIngressPointsRequest AWS API Documentation
2099
+ #
2100
+ class ListIngressPointsRequest < Struct.new(
2101
+ :next_token,
2102
+ :page_size)
2103
+ SENSITIVE = []
2104
+ include Aws::Structure
2105
+ end
2106
+
2107
+ # @!attribute [rw] ingress_points
2108
+ # The list of ingress endpoints.
2109
+ # @return [Array<Types::IngressPoint>]
2110
+ #
2111
+ # @!attribute [rw] next_token
2112
+ # If NextToken is returned, there are more results available. The
2113
+ # value of NextToken is a unique pagination token for each page. Make
2114
+ # the call again using the returned token to retrieve the next page.
2115
+ # @return [String]
2116
+ #
2117
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mailmanager-2023-10-17/ListIngressPointsResponse AWS API Documentation
2118
+ #
2119
+ class ListIngressPointsResponse < Struct.new(
2120
+ :ingress_points,
2121
+ :next_token)
2122
+ SENSITIVE = []
2123
+ include Aws::Structure
2124
+ end
2125
+
2126
+ # @!attribute [rw] next_token
2127
+ # If you received a pagination token from a previous call to this API,
2128
+ # you can provide it here to continue paginating through the next page
2129
+ # of results.
2130
+ # @return [String]
2131
+ #
2132
+ # @!attribute [rw] page_size
2133
+ # The number of relays to be returned in one request.
2134
+ # @return [Integer]
2135
+ #
2136
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mailmanager-2023-10-17/ListRelaysRequest AWS API Documentation
2137
+ #
2138
+ class ListRelaysRequest < Struct.new(
2139
+ :next_token,
2140
+ :page_size)
2141
+ SENSITIVE = []
2142
+ include Aws::Structure
2143
+ end
2144
+
2145
+ # @!attribute [rw] next_token
2146
+ # If NextToken is returned, there are more results available. The
2147
+ # value of NextToken is a unique pagination token for each page. Make
2148
+ # the call again using the returned token to retrieve the next page.
2149
+ # @return [String]
2150
+ #
2151
+ # @!attribute [rw] relays
2152
+ # The list of returned relays.
2153
+ # @return [Array<Types::Relay>]
2154
+ #
2155
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mailmanager-2023-10-17/ListRelaysResponse AWS API Documentation
2156
+ #
2157
+ class ListRelaysResponse < Struct.new(
2158
+ :next_token,
2159
+ :relays)
2160
+ SENSITIVE = []
2161
+ include Aws::Structure
2162
+ end
2163
+
2164
+ # @!attribute [rw] next_token
2165
+ # If you received a pagination token from a previous call to this API,
2166
+ # you can provide it here to continue paginating through the next page
2167
+ # of results.
2168
+ # @return [String]
2169
+ #
2170
+ # @!attribute [rw] page_size
2171
+ # The maximum number of rule set resources that are returned per call.
2172
+ # You can use NextToken to obtain further rule sets.
2173
+ # @return [Integer]
2174
+ #
2175
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mailmanager-2023-10-17/ListRuleSetsRequest AWS API Documentation
2176
+ #
2177
+ class ListRuleSetsRequest < Struct.new(
2178
+ :next_token,
2179
+ :page_size)
2180
+ SENSITIVE = []
2181
+ include Aws::Structure
2182
+ end
2183
+
2184
+ # @!attribute [rw] next_token
2185
+ # If NextToken is returned, there are more results available. The
2186
+ # value of NextToken is a unique pagination token for each page. Make
2187
+ # the call again using the returned token to retrieve the next page.
2188
+ # @return [String]
2189
+ #
2190
+ # @!attribute [rw] rule_sets
2191
+ # The list of rule sets.
2192
+ # @return [Array<Types::RuleSet>]
2193
+ #
2194
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mailmanager-2023-10-17/ListRuleSetsResponse AWS API Documentation
2195
+ #
2196
+ class ListRuleSetsResponse < Struct.new(
2197
+ :next_token,
2198
+ :rule_sets)
2199
+ SENSITIVE = []
2200
+ include Aws::Structure
2201
+ end
2202
+
2203
+ # @!attribute [rw] resource_arn
2204
+ # The Amazon Resource Name (ARN) of the resource to retrieve tags
2205
+ # from.
2206
+ # @return [String]
2207
+ #
2208
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mailmanager-2023-10-17/ListTagsForResourceRequest AWS API Documentation
2209
+ #
2210
+ class ListTagsForResourceRequest < Struct.new(
2211
+ :resource_arn)
2212
+ SENSITIVE = []
2213
+ include Aws::Structure
2214
+ end
2215
+
2216
+ # @!attribute [rw] tags
2217
+ # The tags used to organize, track, or control access for the
2218
+ # resource. For example, \\\{ "tags": \\\{"key1":"value1",
2219
+ # "key2":"value2"\\} \\}.
2220
+ # @return [Array<Types::Tag>]
2221
+ #
2222
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mailmanager-2023-10-17/ListTagsForResourceResponse AWS API Documentation
2223
+ #
2224
+ class ListTagsForResourceResponse < Struct.new(
2225
+ :tags)
2226
+ SENSITIVE = []
2227
+ include Aws::Structure
2228
+ end
2229
+
2230
+ # @!attribute [rw] next_token
2231
+ # If you received a pagination token from a previous call to this API,
2232
+ # you can provide it here to continue paginating through the next page
2233
+ # of results.
2234
+ # @return [String]
2235
+ #
2236
+ # @!attribute [rw] page_size
2237
+ # The maximum number of traffic policy resources that are returned per
2238
+ # call. You can use NextToken to obtain further traffic policies.
2239
+ # @return [Integer]
2240
+ #
2241
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mailmanager-2023-10-17/ListTrafficPoliciesRequest AWS API Documentation
2242
+ #
2243
+ class ListTrafficPoliciesRequest < Struct.new(
2244
+ :next_token,
2245
+ :page_size)
2246
+ SENSITIVE = []
2247
+ include Aws::Structure
2248
+ end
2249
+
2250
+ # @!attribute [rw] next_token
2251
+ # If NextToken is returned, there are more results available. The
2252
+ # value of NextToken is a unique pagination token for each page. Make
2253
+ # the call again using the returned token to retrieve the next page.
2254
+ # @return [String]
2255
+ #
2256
+ # @!attribute [rw] traffic_policies
2257
+ # The list of traffic policies.
2258
+ # @return [Array<Types::TrafficPolicy>]
2259
+ #
2260
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mailmanager-2023-10-17/ListTrafficPoliciesResponse AWS API Documentation
2261
+ #
2262
+ class ListTrafficPoliciesResponse < Struct.new(
2263
+ :next_token,
2264
+ :traffic_policies)
2265
+ SENSITIVE = []
2266
+ include Aws::Structure
2267
+ end
2268
+
2269
+ # The textual body content of an email message.
2270
+ #
2271
+ # @!attribute [rw] html
2272
+ # The HTML body content of the message.
2273
+ # @return [String]
2274
+ #
2275
+ # @!attribute [rw] message_malformed
2276
+ # A flag indicating if the email was malformed.
2277
+ # @return [Boolean]
2278
+ #
2279
+ # @!attribute [rw] text
2280
+ # The plain text body content of the message.
2281
+ # @return [String]
2282
+ #
2283
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mailmanager-2023-10-17/MessageBody AWS API Documentation
2284
+ #
2285
+ class MessageBody < Struct.new(
2286
+ :html,
2287
+ :message_malformed,
2288
+ :text)
2289
+ SENSITIVE = []
2290
+ include Aws::Structure
2291
+ end
2292
+
2293
+ # Explicitly indicate that the relay destination server does not require
2294
+ # SMTP credential authentication.
2295
+ #
2296
+ # @api private
2297
+ #
2298
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mailmanager-2023-10-17/NoAuthentication AWS API Documentation
2299
+ #
2300
+ class NoAuthentication < Aws::EmptyStructure; end
2301
+
2302
+ # The email traffic filtering conditions which are contained in a
2303
+ # traffic policy resource.
2304
+ #
2305
+ # @note PolicyCondition is a union - when making an API calls you must set exactly one of the members.
2306
+ #
2307
+ # @note PolicyCondition is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of PolicyCondition corresponding to the set member.
2308
+ #
2309
+ # @!attribute [rw] boolean_expression
2310
+ # This represents a boolean type condition matching on the incoming
2311
+ # mail. It performs the boolean operation configured in 'Operator'
2312
+ # and evaluates the 'Protocol' object against the 'Value'.
2313
+ # @return [Types::IngressBooleanExpression]
2314
+ #
2315
+ # @!attribute [rw] ip_expression
2316
+ # This represents an IP based condition matching on the incoming mail.
2317
+ # It performs the operation configured in 'Operator' and evaluates
2318
+ # the 'Protocol' object against the 'Value'.
2319
+ # @return [Types::IngressIpv4Expression]
2320
+ #
2321
+ # @!attribute [rw] string_expression
2322
+ # This represents a string based condition matching on the incoming
2323
+ # mail. It performs the string operation configured in 'Operator'
2324
+ # and evaluates the 'Protocol' object against the 'Value'.
2325
+ # @return [Types::IngressStringExpression]
2326
+ #
2327
+ # @!attribute [rw] tls_expression
2328
+ # This represents a TLS based condition matching on the incoming mail.
2329
+ # It performs the operation configured in 'Operator' and evaluates
2330
+ # the 'Protocol' object against the 'Value'.
2331
+ # @return [Types::IngressTlsProtocolExpression]
2332
+ #
2333
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mailmanager-2023-10-17/PolicyCondition AWS API Documentation
2334
+ #
2335
+ class PolicyCondition < Struct.new(
2336
+ :boolean_expression,
2337
+ :ip_expression,
2338
+ :string_expression,
2339
+ :tls_expression,
2340
+ :unknown)
2341
+ SENSITIVE = []
2342
+ include Aws::Structure
2343
+ include Aws::Structure::Union
2344
+
2345
+ class BooleanExpression < PolicyCondition; end
2346
+ class IpExpression < PolicyCondition; end
2347
+ class StringExpression < PolicyCondition; end
2348
+ class TlsExpression < PolicyCondition; end
2349
+ class Unknown < PolicyCondition; end
2350
+ end
2351
+
2352
+ # The structure containing traffic policy conditions and actions.
2353
+ #
2354
+ # @!attribute [rw] action
2355
+ # The action that informs a traffic policy resource to either allow or
2356
+ # block the email if it matches a condition in the policy statement.
2357
+ # @return [String]
2358
+ #
2359
+ # @!attribute [rw] conditions
2360
+ # The list of conditions to apply to incoming messages for filtering
2361
+ # email traffic.
2362
+ # @return [Array<Types::PolicyCondition>]
2363
+ #
2364
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mailmanager-2023-10-17/PolicyStatement AWS API Documentation
2365
+ #
2366
+ class PolicyStatement < Struct.new(
2367
+ :action,
2368
+ :conditions)
2369
+ SENSITIVE = []
2370
+ include Aws::Structure
2371
+ end
2372
+
2373
+ # The relay resource that can be used as a rule to relay receiving
2374
+ # emails to the destination relay server.
2375
+ #
2376
+ # @!attribute [rw] last_modified_timestamp
2377
+ # The timestamp of when the relay was last modified.
2378
+ # @return [Time]
2379
+ #
2380
+ # @!attribute [rw] relay_id
2381
+ # The unique relay identifier.
2382
+ # @return [String]
2383
+ #
2384
+ # @!attribute [rw] relay_name
2385
+ # The unique relay name.
2386
+ # @return [String]
2387
+ #
2388
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mailmanager-2023-10-17/Relay AWS API Documentation
2389
+ #
2390
+ class Relay < Struct.new(
2391
+ :last_modified_timestamp,
2392
+ :relay_id,
2393
+ :relay_name)
2394
+ SENSITIVE = []
2395
+ include Aws::Structure
2396
+ end
2397
+
2398
+ # The action relays the email via SMTP to another specific SMTP server.
2399
+ #
2400
+ # @!attribute [rw] action_failure_policy
2401
+ # A policy that states what to do in the case of failure. The action
2402
+ # will fail if there are configuration errors. For example, the
2403
+ # specified relay has been deleted.
2404
+ # @return [String]
2405
+ #
2406
+ # @!attribute [rw] mail_from
2407
+ # This action specifies whether to preserve or replace original mail
2408
+ # from address while relaying received emails to a destination server.
2409
+ # @return [String]
2410
+ #
2411
+ # @!attribute [rw] relay
2412
+ # The identifier of the relay resource to be used when relaying an
2413
+ # email.
2414
+ # @return [String]
2415
+ #
2416
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mailmanager-2023-10-17/RelayAction AWS API Documentation
2417
+ #
2418
+ class RelayAction < Struct.new(
2419
+ :action_failure_policy,
2420
+ :mail_from,
2421
+ :relay)
2422
+ SENSITIVE = []
2423
+ include Aws::Structure
2424
+ end
2425
+
2426
+ # Authentication for the relay destination server—specify the secretARN
2427
+ # where the SMTP credentials are stored, or specify an empty
2428
+ # NoAuthentication structure if the relay destination server does not
2429
+ # require SMTP credential authentication.
2430
+ #
2431
+ # @note RelayAuthentication is a union - when making an API calls you must set exactly one of the members.
2432
+ #
2433
+ # @note RelayAuthentication is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of RelayAuthentication corresponding to the set member.
2434
+ #
2435
+ # @!attribute [rw] no_authentication
2436
+ # Keep an empty structure if the relay destination server does not
2437
+ # require SMTP credential authentication.
2438
+ # @return [Types::NoAuthentication]
2439
+ #
2440
+ # @!attribute [rw] secret_arn
2441
+ # The ARN of the secret created in secrets manager where the relay
2442
+ # server's SMTP credentials are stored.
2443
+ # @return [String]
2444
+ #
2445
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mailmanager-2023-10-17/RelayAuthentication AWS API Documentation
2446
+ #
2447
+ class RelayAuthentication < Struct.new(
2448
+ :no_authentication,
2449
+ :secret_arn,
2450
+ :unknown)
2451
+ SENSITIVE = []
2452
+ include Aws::Structure
2453
+ include Aws::Structure::Union
2454
+
2455
+ class NoAuthentication < RelayAuthentication; end
2456
+ class SecretArn < RelayAuthentication; end
2457
+ class Unknown < RelayAuthentication; end
2458
+ end
2459
+
2460
+ # This action replaces the email envelope recipients with the given list
2461
+ # of recipients. If the condition of this action applies only to a
2462
+ # subset of recipients, only those recipients are replaced with the
2463
+ # recipients specified in the action. The message contents and headers
2464
+ # are unaffected by this action, only the envelope recipients are
2465
+ # updated.
2466
+ #
2467
+ # @!attribute [rw] replace_with
2468
+ # This action specifies the replacement recipient email addresses to
2469
+ # insert.
2470
+ # @return [Array<String>]
2471
+ #
2472
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mailmanager-2023-10-17/ReplaceRecipientAction AWS API Documentation
2473
+ #
2474
+ class ReplaceRecipientAction < Struct.new(
2475
+ :replace_with)
2476
+ SENSITIVE = []
2477
+ include Aws::Structure
2478
+ end
2479
+
2480
+ # Occurs when a requested resource is not found.
2481
+ #
2482
+ # @!attribute [rw] message
2483
+ # @return [String]
2484
+ #
2485
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mailmanager-2023-10-17/ResourceNotFoundException AWS API Documentation
2486
+ #
2487
+ class ResourceNotFoundException < Struct.new(
2488
+ :message)
2489
+ SENSITIVE = []
2490
+ include Aws::Structure
2491
+ end
2492
+
2493
+ # A result row containing metadata for an archived email message.
2494
+ #
2495
+ # @!attribute [rw] archived_message_id
2496
+ # The unique identifier of the archived message.
2497
+ # @return [String]
2498
+ #
2499
+ # @!attribute [rw] cc
2500
+ # The email addresses in the CC header.
2501
+ # @return [String]
2502
+ #
2503
+ # @!attribute [rw] date
2504
+ # The date the email was sent.
2505
+ # @return [String]
2506
+ #
2507
+ # @!attribute [rw] from
2508
+ # The email address of the sender.
2509
+ # @return [String]
2510
+ #
2511
+ # @!attribute [rw] has_attachments
2512
+ # A flag indicating if the email has attachments.
2513
+ # @return [Boolean]
2514
+ #
2515
+ # @!attribute [rw] in_reply_to
2516
+ # The email message ID this is a reply to.
2517
+ # @return [String]
2518
+ #
2519
+ # @!attribute [rw] message_id
2520
+ # The unique message ID of the email.
2521
+ # @return [String]
2522
+ #
2523
+ # @!attribute [rw] received_headers
2524
+ # The received headers from the email delivery path.
2525
+ # @return [Array<String>]
2526
+ #
2527
+ # @!attribute [rw] received_timestamp
2528
+ # The timestamp of when the email was received.
2529
+ # @return [Time]
2530
+ #
2531
+ # @!attribute [rw] subject
2532
+ # The subject header value of the email.
2533
+ # @return [String]
2534
+ #
2535
+ # @!attribute [rw] to
2536
+ # The email addresses in the To header.
2537
+ # @return [String]
2538
+ #
2539
+ # @!attribute [rw] x_mailer
2540
+ # The user agent that sent the email.
2541
+ # @return [String]
2542
+ #
2543
+ # @!attribute [rw] x_original_mailer
2544
+ # The original user agent that sent the email.
2545
+ # @return [String]
2546
+ #
2547
+ # @!attribute [rw] x_priority
2548
+ # The priority level of the email.
2549
+ # @return [String]
2550
+ #
2551
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mailmanager-2023-10-17/Row AWS API Documentation
2552
+ #
2553
+ class Row < Struct.new(
2554
+ :archived_message_id,
2555
+ :cc,
2556
+ :date,
2557
+ :from,
2558
+ :has_attachments,
2559
+ :in_reply_to,
2560
+ :message_id,
2561
+ :received_headers,
2562
+ :received_timestamp,
2563
+ :subject,
2564
+ :to,
2565
+ :x_mailer,
2566
+ :x_original_mailer,
2567
+ :x_priority)
2568
+ SENSITIVE = []
2569
+ include Aws::Structure
2570
+ end
2571
+
2572
+ # A rule contains conditions, "unless conditions" and actions. For
2573
+ # each envelope recipient of an email, if all conditions match and none
2574
+ # of the "unless conditions" match, then all of the actions are
2575
+ # executed sequentially. If no conditions are provided, the rule always
2576
+ # applies and the actions are implicitly executed. If only "unless
2577
+ # conditions" are provided, the rule applies if the email does not
2578
+ # match the evaluation of the "unless conditions".
2579
+ #
2580
+ # @!attribute [rw] actions
2581
+ # The list of actions to execute when the conditions match the
2582
+ # incoming email, and none of the "unless conditions" match.
2583
+ # @return [Array<Types::RuleAction>]
2584
+ #
2585
+ # @!attribute [rw] conditions
2586
+ # The conditions of this rule. All conditions must match the email for
2587
+ # the actions to be executed. An empty list of conditions means that
2588
+ # all emails match, but are still subject to any "unless conditions"
2589
+ # @return [Array<Types::RuleCondition>]
2590
+ #
2591
+ # @!attribute [rw] name
2592
+ # The user-friendly name of the rule.
2593
+ # @return [String]
2594
+ #
2595
+ # @!attribute [rw] unless
2596
+ # The "unless conditions" of this rule. None of the conditions can
2597
+ # match the email for the actions to be executed. If any of these
2598
+ # conditions do match the email, then the actions are not executed.
2599
+ # @return [Array<Types::RuleCondition>]
2600
+ #
2601
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mailmanager-2023-10-17/Rule AWS API Documentation
2602
+ #
2603
+ class Rule < Struct.new(
2604
+ :actions,
2605
+ :conditions,
2606
+ :name,
2607
+ :unless)
2608
+ SENSITIVE = []
2609
+ include Aws::Structure
2610
+ end
2611
+
2612
+ # The action for a rule to take. Only one of the contained actions can
2613
+ # be set.
2614
+ #
2615
+ # @note RuleAction is a union - when making an API calls you must set exactly one of the members.
2616
+ #
2617
+ # @note RuleAction is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of RuleAction corresponding to the set member.
2618
+ #
2619
+ # @!attribute [rw] add_header
2620
+ # This action adds a header. This can be used to add arbitrary email
2621
+ # headers.
2622
+ # @return [Types::AddHeaderAction]
2623
+ #
2624
+ # @!attribute [rw] archive
2625
+ # This action archives the email. This can be used to deliver an email
2626
+ # to an archive.
2627
+ # @return [Types::ArchiveAction]
2628
+ #
2629
+ # @!attribute [rw] deliver_to_mailbox
2630
+ # This action delivers an email to a WorkMail mailbox.
2631
+ # @return [Types::DeliverToMailboxAction]
2632
+ #
2633
+ # @!attribute [rw] drop
2634
+ # This action terminates the evaluation of rules in the rule set.
2635
+ # @return [Types::DropAction]
2636
+ #
2637
+ # @!attribute [rw] relay
2638
+ # This action relays the email to another SMTP server.
2639
+ # @return [Types::RelayAction]
2640
+ #
2641
+ # @!attribute [rw] replace_recipient
2642
+ # The action replaces certain or all recipients with a different set
2643
+ # of recipients.
2644
+ # @return [Types::ReplaceRecipientAction]
2645
+ #
2646
+ # @!attribute [rw] send
2647
+ # This action sends the email to the internet.
2648
+ # @return [Types::SendAction]
2649
+ #
2650
+ # @!attribute [rw] write_to_s3
2651
+ # This action writes the MIME content of the email to an S3 bucket.
2652
+ # @return [Types::S3Action]
2653
+ #
2654
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mailmanager-2023-10-17/RuleAction AWS API Documentation
2655
+ #
2656
+ class RuleAction < Struct.new(
2657
+ :add_header,
2658
+ :archive,
2659
+ :deliver_to_mailbox,
2660
+ :drop,
2661
+ :relay,
2662
+ :replace_recipient,
2663
+ :send,
2664
+ :write_to_s3,
2665
+ :unknown)
2666
+ SENSITIVE = []
2667
+ include Aws::Structure
2668
+ include Aws::Structure::Union
2669
+
2670
+ class AddHeader < RuleAction; end
2671
+ class Archive < RuleAction; end
2672
+ class DeliverToMailbox < RuleAction; end
2673
+ class Drop < RuleAction; end
2674
+ class Relay < RuleAction; end
2675
+ class ReplaceRecipient < RuleAction; end
2676
+ class Send < RuleAction; end
2677
+ class WriteToS3 < RuleAction; end
2678
+ class Unknown < RuleAction; end
2679
+ end
2680
+
2681
+ # A boolean expression to be used in a rule condition.
2682
+ #
2683
+ # @!attribute [rw] evaluate
2684
+ # The operand on which to perform a boolean condition operation.
2685
+ # @return [Types::RuleBooleanToEvaluate]
2686
+ #
2687
+ # @!attribute [rw] operator
2688
+ # The matching operator for a boolean condition expression.
2689
+ # @return [String]
2690
+ #
2691
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mailmanager-2023-10-17/RuleBooleanExpression AWS API Documentation
2692
+ #
2693
+ class RuleBooleanExpression < Struct.new(
2694
+ :evaluate,
2695
+ :operator)
2696
+ SENSITIVE = []
2697
+ include Aws::Structure
2698
+ end
2699
+
2700
+ # The union type representing the allowed types of operands for a
2701
+ # boolean condition.
2702
+ #
2703
+ # @note RuleBooleanToEvaluate is a union - when making an API calls you must set exactly one of the members.
2704
+ #
2705
+ # @note RuleBooleanToEvaluate is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of RuleBooleanToEvaluate corresponding to the set member.
2706
+ #
2707
+ # @!attribute [rw] attribute
2708
+ # The boolean type representing the allowed attribute types for an
2709
+ # email.
2710
+ # @return [String]
2711
+ #
2712
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mailmanager-2023-10-17/RuleBooleanToEvaluate AWS API Documentation
2713
+ #
2714
+ class RuleBooleanToEvaluate < Struct.new(
2715
+ :attribute,
2716
+ :unknown)
2717
+ SENSITIVE = []
2718
+ include Aws::Structure
2719
+ include Aws::Structure::Union
2720
+
2721
+ class Attribute < RuleBooleanToEvaluate; end
2722
+ class Unknown < RuleBooleanToEvaluate; end
2723
+ end
2724
+
2725
+ # The conditional expression used to evaluate an email for determining
2726
+ # if a rule action should be taken.
2727
+ #
2728
+ # @note RuleCondition is a union - when making an API calls you must set exactly one of the members.
2729
+ #
2730
+ # @note RuleCondition is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of RuleCondition corresponding to the set member.
2731
+ #
2732
+ # @!attribute [rw] boolean_expression
2733
+ # The condition applies to a boolean expression passed in this field.
2734
+ # @return [Types::RuleBooleanExpression]
2735
+ #
2736
+ # @!attribute [rw] dmarc_expression
2737
+ # The condition applies to a DMARC policy expression passed in this
2738
+ # field.
2739
+ # @return [Types::RuleDmarcExpression]
2740
+ #
2741
+ # @!attribute [rw] ip_expression
2742
+ # The condition applies to an IP address expression passed in this
2743
+ # field.
2744
+ # @return [Types::RuleIpExpression]
2745
+ #
2746
+ # @!attribute [rw] number_expression
2747
+ # The condition applies to a number expression passed in this field.
2748
+ # @return [Types::RuleNumberExpression]
2749
+ #
2750
+ # @!attribute [rw] string_expression
2751
+ # The condition applies to a string expression passed in this field.
2752
+ # @return [Types::RuleStringExpression]
2753
+ #
2754
+ # @!attribute [rw] verdict_expression
2755
+ # The condition applies to a verdict expression passed in this field.
2756
+ # @return [Types::RuleVerdictExpression]
2757
+ #
2758
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mailmanager-2023-10-17/RuleCondition AWS API Documentation
2759
+ #
2760
+ class RuleCondition < Struct.new(
2761
+ :boolean_expression,
2762
+ :dmarc_expression,
2763
+ :ip_expression,
2764
+ :number_expression,
2765
+ :string_expression,
2766
+ :verdict_expression,
2767
+ :unknown)
2768
+ SENSITIVE = []
2769
+ include Aws::Structure
2770
+ include Aws::Structure::Union
2771
+
2772
+ class BooleanExpression < RuleCondition; end
2773
+ class DmarcExpression < RuleCondition; end
2774
+ class IpExpression < RuleCondition; end
2775
+ class NumberExpression < RuleCondition; end
2776
+ class StringExpression < RuleCondition; end
2777
+ class VerdictExpression < RuleCondition; end
2778
+ class Unknown < RuleCondition; end
2779
+ end
2780
+
2781
+ # A DMARC policy expression. The condition matches if the given DMARC
2782
+ # policy matches that of the incoming email.
2783
+ #
2784
+ # @!attribute [rw] operator
2785
+ # The operator to apply to the DMARC policy of the incoming email.
2786
+ # @return [String]
2787
+ #
2788
+ # @!attribute [rw] values
2789
+ # The values to use for the given DMARC policy operator. For the
2790
+ # operator EQUALS, if multiple values are given, they are evaluated as
2791
+ # an OR. That is, if any of the given values match, the condition is
2792
+ # deemed to match. For the operator NOT\_EQUALS, if multiple values
2793
+ # are given, they are evaluated as an AND. That is, only if the
2794
+ # email's DMARC policy is not equal to any of the given values, then
2795
+ # the condition is deemed to match.
2796
+ # @return [Array<String>]
2797
+ #
2798
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mailmanager-2023-10-17/RuleDmarcExpression AWS API Documentation
2799
+ #
2800
+ class RuleDmarcExpression < Struct.new(
2801
+ :operator,
2802
+ :values)
2803
+ SENSITIVE = []
2804
+ include Aws::Structure
2805
+ end
2806
+
2807
+ # An IP address expression matching certain IP addresses within a given
2808
+ # range of IP addresses.
2809
+ #
2810
+ # @!attribute [rw] evaluate
2811
+ # The IP address to evaluate in this condition.
2812
+ # @return [Types::RuleIpToEvaluate]
2813
+ #
2814
+ # @!attribute [rw] operator
2815
+ # The operator to evaluate the IP address.
2816
+ # @return [String]
2817
+ #
2818
+ # @!attribute [rw] values
2819
+ # The IP CIDR blocks in format "x.y.z.w/n" (eg 10.0.0.0/8) to match
2820
+ # with the email's IP address. For the operator CIDR\_MATCHES, if
2821
+ # multiple values are given, they are evaluated as an OR. That is, if
2822
+ # the IP address is contained within any of the given CIDR ranges, the
2823
+ # condition is deemed to match. For NOT\_CIDR\_MATCHES, if multiple
2824
+ # CIDR ranges are given, the condition is deemed to match if the IP
2825
+ # address is not contained in any of the given CIDR ranges.
2826
+ # @return [Array<String>]
2827
+ #
2828
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mailmanager-2023-10-17/RuleIpExpression AWS API Documentation
2829
+ #
2830
+ class RuleIpExpression < Struct.new(
2831
+ :evaluate,
2832
+ :operator,
2833
+ :values)
2834
+ SENSITIVE = []
2835
+ include Aws::Structure
2836
+ end
2837
+
2838
+ # The IP address to evaluate for this condition.
2839
+ #
2840
+ # @note RuleIpToEvaluate is a union - when making an API calls you must set exactly one of the members.
2841
+ #
2842
+ # @note RuleIpToEvaluate is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of RuleIpToEvaluate corresponding to the set member.
2843
+ #
2844
+ # @!attribute [rw] attribute
2845
+ # The attribute of the email to evaluate.
2846
+ # @return [String]
2847
+ #
2848
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mailmanager-2023-10-17/RuleIpToEvaluate AWS API Documentation
2849
+ #
2850
+ class RuleIpToEvaluate < Struct.new(
2851
+ :attribute,
2852
+ :unknown)
2853
+ SENSITIVE = []
2854
+ include Aws::Structure
2855
+ include Aws::Structure::Union
2856
+
2857
+ class Attribute < RuleIpToEvaluate; end
2858
+ class Unknown < RuleIpToEvaluate; end
2859
+ end
2860
+
2861
+ # A number expression to match numeric conditions with integers from the
2862
+ # incoming email.
2863
+ #
2864
+ # @!attribute [rw] evaluate
2865
+ # The number to evaluate in a numeric condition expression.
2866
+ # @return [Types::RuleNumberToEvaluate]
2867
+ #
2868
+ # @!attribute [rw] operator
2869
+ # The operator for a numeric condition expression.
2870
+ # @return [String]
2871
+ #
2872
+ # @!attribute [rw] value
2873
+ # The value to evaluate in a numeric condition expression.
2874
+ # @return [Float]
2875
+ #
2876
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mailmanager-2023-10-17/RuleNumberExpression AWS API Documentation
2877
+ #
2878
+ class RuleNumberExpression < Struct.new(
2879
+ :evaluate,
2880
+ :operator,
2881
+ :value)
2882
+ SENSITIVE = []
2883
+ include Aws::Structure
2884
+ end
2885
+
2886
+ # The number to evaluate in a numeric condition expression.
2887
+ #
2888
+ # @note RuleNumberToEvaluate is a union - when making an API calls you must set exactly one of the members.
2889
+ #
2890
+ # @note RuleNumberToEvaluate is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of RuleNumberToEvaluate corresponding to the set member.
2891
+ #
2892
+ # @!attribute [rw] attribute
2893
+ # An email attribute that is used as the number to evaluate.
2894
+ # @return [String]
2895
+ #
2896
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mailmanager-2023-10-17/RuleNumberToEvaluate AWS API Documentation
2897
+ #
2898
+ class RuleNumberToEvaluate < Struct.new(
2899
+ :attribute,
2900
+ :unknown)
2901
+ SENSITIVE = []
2902
+ include Aws::Structure
2903
+ include Aws::Structure::Union
2904
+
2905
+ class Attribute < RuleNumberToEvaluate; end
2906
+ class Unknown < RuleNumberToEvaluate; end
2907
+ end
2908
+
2909
+ # A rule set contains a list of rules that are evaluated in order. Each
2910
+ # rule is evaluated sequentially for each email.
2911
+ #
2912
+ # @!attribute [rw] last_modification_date
2913
+ # The last modification date of the rule set.
2914
+ # @return [Time]
2915
+ #
2916
+ # @!attribute [rw] rule_set_id
2917
+ # The identifier of the rule set.
2918
+ # @return [String]
2919
+ #
2920
+ # @!attribute [rw] rule_set_name
2921
+ # A user-friendly name for the rule set.
2922
+ # @return [String]
2923
+ #
2924
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mailmanager-2023-10-17/RuleSet AWS API Documentation
2925
+ #
2926
+ class RuleSet < Struct.new(
2927
+ :last_modification_date,
2928
+ :rule_set_id,
2929
+ :rule_set_name)
2930
+ SENSITIVE = []
2931
+ include Aws::Structure
2932
+ end
2933
+
2934
+ # A string expression is evaluated against strings or substrings of the
2935
+ # email.
2936
+ #
2937
+ # @!attribute [rw] evaluate
2938
+ # The string to evaluate in a string condition expression.
2939
+ # @return [Types::RuleStringToEvaluate]
2940
+ #
2941
+ # @!attribute [rw] operator
2942
+ # The matching operator for a string condition expression.
2943
+ # @return [String]
2944
+ #
2945
+ # @!attribute [rw] values
2946
+ # The string(s) to be evaluated in a string condition expression. For
2947
+ # all operators, except for NOT\_EQUALS, if multiple values are given,
2948
+ # the values are processed as an OR. That is, if any of the values
2949
+ # match the email's string using the given operator, the condition is
2950
+ # deemed to match. However, for NOT\_EQUALS, the condition is only
2951
+ # deemed to match if none of the given strings match the email's
2952
+ # string.
2953
+ # @return [Array<String>]
2954
+ #
2955
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mailmanager-2023-10-17/RuleStringExpression AWS API Documentation
2956
+ #
2957
+ class RuleStringExpression < Struct.new(
2958
+ :evaluate,
2959
+ :operator,
2960
+ :values)
2961
+ SENSITIVE = []
2962
+ include Aws::Structure
2963
+ end
2964
+
2965
+ # The string to evaluate in a string condition expression.
2966
+ #
2967
+ # @note RuleStringToEvaluate is a union - when making an API calls you must set exactly one of the members.
2968
+ #
2969
+ # @note RuleStringToEvaluate is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of RuleStringToEvaluate corresponding to the set member.
2970
+ #
2971
+ # @!attribute [rw] attribute
2972
+ # The email attribute to evaluate in a string condition expression.
2973
+ # @return [String]
2974
+ #
2975
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mailmanager-2023-10-17/RuleStringToEvaluate AWS API Documentation
2976
+ #
2977
+ class RuleStringToEvaluate < Struct.new(
2978
+ :attribute,
2979
+ :unknown)
2980
+ SENSITIVE = []
2981
+ include Aws::Structure
2982
+ include Aws::Structure::Union
2983
+
2984
+ class Attribute < RuleStringToEvaluate; end
2985
+ class Unknown < RuleStringToEvaluate; end
2986
+ end
2987
+
2988
+ # A verdict expression is evaluated against verdicts of the email.
2989
+ #
2990
+ # @!attribute [rw] evaluate
2991
+ # The verdict to evaluate in a verdict condition expression.
2992
+ # @return [Types::RuleVerdictToEvaluate]
2993
+ #
2994
+ # @!attribute [rw] operator
2995
+ # The matching operator for a verdict condition expression.
2996
+ # @return [String]
2997
+ #
2998
+ # @!attribute [rw] values
2999
+ # The values to match with the email's verdict using the given
3000
+ # operator. For the EQUALS operator, if multiple values are given, the
3001
+ # condition is deemed to match if any of the given verdicts match that
3002
+ # of the email. For the NOT\_EQUALS operator, if multiple values are
3003
+ # given, the condition is deemed to match of none of the given
3004
+ # verdicts match the verdict of the email.
3005
+ # @return [Array<String>]
3006
+ #
3007
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mailmanager-2023-10-17/RuleVerdictExpression AWS API Documentation
3008
+ #
3009
+ class RuleVerdictExpression < Struct.new(
3010
+ :evaluate,
3011
+ :operator,
3012
+ :values)
3013
+ SENSITIVE = []
3014
+ include Aws::Structure
3015
+ end
3016
+
3017
+ # The verdict to evaluate in a verdict condition expression.
3018
+ #
3019
+ # @note RuleVerdictToEvaluate is a union - when making an API calls you must set exactly one of the members.
3020
+ #
3021
+ # @note RuleVerdictToEvaluate is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of RuleVerdictToEvaluate corresponding to the set member.
3022
+ #
3023
+ # @!attribute [rw] analysis
3024
+ # The Add On ARN and its returned value to evaluate in a verdict
3025
+ # condition expression.
3026
+ # @return [Types::Analysis]
3027
+ #
3028
+ # @!attribute [rw] attribute
3029
+ # The email verdict attribute to evaluate in a string verdict
3030
+ # expression.
3031
+ # @return [String]
3032
+ #
3033
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mailmanager-2023-10-17/RuleVerdictToEvaluate AWS API Documentation
3034
+ #
3035
+ class RuleVerdictToEvaluate < Struct.new(
3036
+ :analysis,
3037
+ :attribute,
3038
+ :unknown)
3039
+ SENSITIVE = []
3040
+ include Aws::Structure
3041
+ include Aws::Structure::Union
3042
+
3043
+ class Analysis < RuleVerdictToEvaluate; end
3044
+ class Attribute < RuleVerdictToEvaluate; end
3045
+ class Unknown < RuleVerdictToEvaluate; end
3046
+ end
3047
+
3048
+ # Writes the MIME content of the email to an S3 bucket.
3049
+ #
3050
+ # @!attribute [rw] action_failure_policy
3051
+ # A policy that states what to do in the case of failure. The action
3052
+ # will fail if there are configuration errors. For example, the
3053
+ # specified the bucket has been deleted.
3054
+ # @return [String]
3055
+ #
3056
+ # @!attribute [rw] role_arn
3057
+ # The Amazon Resource Name (ARN) of the IAM Role to use while writing
3058
+ # to S3. This role must have access to the s3:PutObject, kms:Encrypt,
3059
+ # and kms:GenerateDataKey APIs for the given bucket.
3060
+ # @return [String]
3061
+ #
3062
+ # @!attribute [rw] s3_bucket
3063
+ # The bucket name of the S3 bucket to write to.
3064
+ # @return [String]
3065
+ #
3066
+ # @!attribute [rw] s3_prefix
3067
+ # The S3 prefix to use for the write to the s3 bucket.
3068
+ # @return [String]
3069
+ #
3070
+ # @!attribute [rw] s3_sse_kms_key_id
3071
+ # The KMS Key ID to use to encrypt the message in S3.
3072
+ # @return [String]
3073
+ #
3074
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mailmanager-2023-10-17/S3Action AWS API Documentation
3075
+ #
3076
+ class S3Action < Struct.new(
3077
+ :action_failure_policy,
3078
+ :role_arn,
3079
+ :s3_bucket,
3080
+ :s3_prefix,
3081
+ :s3_sse_kms_key_id)
3082
+ SENSITIVE = []
3083
+ include Aws::Structure
3084
+ end
3085
+
3086
+ # The configuration for exporting email data to an Amazon S3 bucket.
3087
+ #
3088
+ # @!attribute [rw] s3_location
3089
+ # The S3 location to deliver the exported email data.
3090
+ # @return [String]
3091
+ #
3092
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mailmanager-2023-10-17/S3ExportDestinationConfiguration AWS API Documentation
3093
+ #
3094
+ class S3ExportDestinationConfiguration < Struct.new(
3095
+ :s3_location)
3096
+ SENSITIVE = []
3097
+ include Aws::Structure
3098
+ end
3099
+
3100
+ # The current status of an archive search job.
3101
+ #
3102
+ # @!attribute [rw] completion_timestamp
3103
+ # The timestamp of when the search completed (if finished).
3104
+ # @return [Time]
3105
+ #
3106
+ # @!attribute [rw] error_message
3107
+ # An error message if the search failed.
3108
+ # @return [String]
3109
+ #
3110
+ # @!attribute [rw] state
3111
+ # The current state of the search job.
3112
+ # @return [String]
3113
+ #
3114
+ # @!attribute [rw] submission_timestamp
3115
+ # The timestamp of when the search was submitted.
3116
+ # @return [Time]
3117
+ #
3118
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mailmanager-2023-10-17/SearchStatus AWS API Documentation
3119
+ #
3120
+ class SearchStatus < Struct.new(
3121
+ :completion_timestamp,
3122
+ :error_message,
3123
+ :state,
3124
+ :submission_timestamp)
3125
+ SENSITIVE = []
3126
+ include Aws::Structure
3127
+ end
3128
+
3129
+ # Summary details of an archive search job.
3130
+ #
3131
+ # @!attribute [rw] search_id
3132
+ # The unique identifier of the search job.
3133
+ # @return [String]
3134
+ #
3135
+ # @!attribute [rw] status
3136
+ # The current status of the search job.
3137
+ # @return [Types::SearchStatus]
3138
+ #
3139
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mailmanager-2023-10-17/SearchSummary AWS API Documentation
3140
+ #
3141
+ class SearchSummary < Struct.new(
3142
+ :search_id,
3143
+ :status)
3144
+ SENSITIVE = []
3145
+ include Aws::Structure
3146
+ end
3147
+
3148
+ # Sends the email to the internet using the ses:SendRawEmail API.
3149
+ #
3150
+ # @!attribute [rw] action_failure_policy
3151
+ # A policy that states what to do in the case of failure. The action
3152
+ # will fail if there are configuration errors. For example, the caller
3153
+ # does not have the permissions to call the sendRawEmail API.
3154
+ # @return [String]
3155
+ #
3156
+ # @!attribute [rw] role_arn
3157
+ # The Amazon Resource Name (ARN) of the role to use for this action.
3158
+ # This role must have access to the ses:SendRawEmail API.
3159
+ # @return [String]
3160
+ #
3161
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mailmanager-2023-10-17/SendAction AWS API Documentation
3162
+ #
3163
+ class SendAction < Struct.new(
3164
+ :action_failure_policy,
3165
+ :role_arn)
3166
+ SENSITIVE = []
3167
+ include Aws::Structure
3168
+ end
3169
+
3170
+ # Occurs when an operation exceeds a predefined service quota or limit.
3171
+ #
3172
+ # @!attribute [rw] message
3173
+ # @return [String]
3174
+ #
3175
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mailmanager-2023-10-17/ServiceQuotaExceededException AWS API Documentation
3176
+ #
3177
+ class ServiceQuotaExceededException < Struct.new(
3178
+ :message)
3179
+ SENSITIVE = []
3180
+ include Aws::Structure
3181
+ end
3182
+
3183
+ # The request to initiate an export of emails from an archive.
3184
+ #
3185
+ # @!attribute [rw] archive_id
3186
+ # The identifier of the archive to export emails from.
3187
+ # @return [String]
3188
+ #
3189
+ # @!attribute [rw] export_destination_configuration
3190
+ # Details on where to deliver the exported email data.
3191
+ # @return [Types::ExportDestinationConfiguration]
3192
+ #
3193
+ # @!attribute [rw] filters
3194
+ # Criteria to filter which emails are included in the export.
3195
+ # @return [Types::ArchiveFilters]
3196
+ #
3197
+ # @!attribute [rw] from_timestamp
3198
+ # The start of the timestamp range to include emails from.
3199
+ # @return [Time]
3200
+ #
3201
+ # @!attribute [rw] max_results
3202
+ # The maximum number of email items to include in the export.
3203
+ # @return [Integer]
3204
+ #
3205
+ # @!attribute [rw] to_timestamp
3206
+ # The end of the timestamp range to include emails from.
3207
+ # @return [Time]
3208
+ #
3209
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mailmanager-2023-10-17/StartArchiveExportRequest AWS API Documentation
3210
+ #
3211
+ class StartArchiveExportRequest < Struct.new(
3212
+ :archive_id,
3213
+ :export_destination_configuration,
3214
+ :filters,
3215
+ :from_timestamp,
3216
+ :max_results,
3217
+ :to_timestamp)
3218
+ SENSITIVE = []
3219
+ include Aws::Structure
3220
+ end
3221
+
3222
+ # The response from initiating an archive export.
3223
+ #
3224
+ # @!attribute [rw] export_id
3225
+ # The unique identifier for the initiated export job.
3226
+ # @return [String]
3227
+ #
3228
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mailmanager-2023-10-17/StartArchiveExportResponse AWS API Documentation
3229
+ #
3230
+ class StartArchiveExportResponse < Struct.new(
3231
+ :export_id)
3232
+ SENSITIVE = []
3233
+ include Aws::Structure
3234
+ end
3235
+
3236
+ # The request to initiate a search across emails in an archive.
3237
+ #
3238
+ # @!attribute [rw] archive_id
3239
+ # The identifier of the archive to search emails in.
3240
+ # @return [String]
3241
+ #
3242
+ # @!attribute [rw] filters
3243
+ # Criteria to filter which emails are included in the search results.
3244
+ # @return [Types::ArchiveFilters]
3245
+ #
3246
+ # @!attribute [rw] from_timestamp
3247
+ # The start timestamp of the range to search emails from.
3248
+ # @return [Time]
3249
+ #
3250
+ # @!attribute [rw] max_results
3251
+ # The maximum number of search results to return.
3252
+ # @return [Integer]
3253
+ #
3254
+ # @!attribute [rw] to_timestamp
3255
+ # The end timestamp of the range to search emails from.
3256
+ # @return [Time]
3257
+ #
3258
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mailmanager-2023-10-17/StartArchiveSearchRequest AWS API Documentation
3259
+ #
3260
+ class StartArchiveSearchRequest < Struct.new(
3261
+ :archive_id,
3262
+ :filters,
3263
+ :from_timestamp,
3264
+ :max_results,
3265
+ :to_timestamp)
3266
+ SENSITIVE = []
3267
+ include Aws::Structure
3268
+ end
3269
+
3270
+ # The response from initiating an archive search.
3271
+ #
3272
+ # @!attribute [rw] search_id
3273
+ # The unique identifier for the initiated search job.
3274
+ # @return [String]
3275
+ #
3276
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mailmanager-2023-10-17/StartArchiveSearchResponse AWS API Documentation
3277
+ #
3278
+ class StartArchiveSearchResponse < Struct.new(
3279
+ :search_id)
3280
+ SENSITIVE = []
3281
+ include Aws::Structure
3282
+ end
3283
+
3284
+ # The request to stop an in-progress archive export job.
3285
+ #
3286
+ # @!attribute [rw] export_id
3287
+ # The identifier of the export job to stop.
3288
+ # @return [String]
3289
+ #
3290
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mailmanager-2023-10-17/StopArchiveExportRequest AWS API Documentation
3291
+ #
3292
+ class StopArchiveExportRequest < Struct.new(
3293
+ :export_id)
3294
+ SENSITIVE = []
3295
+ include Aws::Structure
3296
+ end
3297
+
3298
+ # The response indicating if the request to stop the export job
3299
+ # succeeded.
3300
+ #
3301
+ # On success, returns an HTTP 200 status code. On failure, returns an
3302
+ # error message.
3303
+ #
3304
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mailmanager-2023-10-17/StopArchiveExportResponse AWS API Documentation
3305
+ #
3306
+ class StopArchiveExportResponse < Aws::EmptyStructure; end
3307
+
3308
+ # The request to stop an in-progress archive search job.
3309
+ #
3310
+ # @!attribute [rw] search_id
3311
+ # The identifier of the search job to stop.
3312
+ # @return [String]
3313
+ #
3314
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mailmanager-2023-10-17/StopArchiveSearchRequest AWS API Documentation
3315
+ #
3316
+ class StopArchiveSearchRequest < Struct.new(
3317
+ :search_id)
3318
+ SENSITIVE = []
3319
+ include Aws::Structure
3320
+ end
3321
+
3322
+ # The response indicating if the request to stop the search job
3323
+ # succeeded.
3324
+ #
3325
+ # On success, returns an HTTP 200 status code. On failure, returns an
3326
+ # error message.
3327
+ #
3328
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mailmanager-2023-10-17/StopArchiveSearchResponse AWS API Documentation
3329
+ #
3330
+ class StopArchiveSearchResponse < Aws::EmptyStructure; end
3331
+
3332
+ # A key-value pair (the value is optional), that you can define and
3333
+ # assign to Amazon Web Services resources.
3334
+ #
3335
+ # @!attribute [rw] key
3336
+ # The key of the key-value tag.
3337
+ # @return [String]
3338
+ #
3339
+ # @!attribute [rw] value
3340
+ # The value of the key-value tag.
3341
+ # @return [String]
3342
+ #
3343
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mailmanager-2023-10-17/Tag AWS API Documentation
3344
+ #
3345
+ class Tag < Struct.new(
3346
+ :key,
3347
+ :value)
3348
+ SENSITIVE = [:key, :value]
3349
+ include Aws::Structure
3350
+ end
3351
+
3352
+ # @!attribute [rw] resource_arn
3353
+ # The Amazon Resource Name (ARN) of the resource that you want to tag.
3354
+ # @return [String]
3355
+ #
3356
+ # @!attribute [rw] tags
3357
+ # The tags used to organize, track, or control access for the
3358
+ # resource. For example, \\\{ "tags": \\\{"key1":"value1",
3359
+ # "key2":"value2"\\} \\}.
3360
+ # @return [Array<Types::Tag>]
3361
+ #
3362
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mailmanager-2023-10-17/TagResourceRequest AWS API Documentation
3363
+ #
3364
+ class TagResourceRequest < Struct.new(
3365
+ :resource_arn,
3366
+ :tags)
3367
+ SENSITIVE = []
3368
+ include Aws::Structure
3369
+ end
3370
+
3371
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mailmanager-2023-10-17/TagResourceResponse AWS API Documentation
3372
+ #
3373
+ class TagResourceResponse < Aws::EmptyStructure; end
3374
+
3375
+ # Occurs when a service's request rate limit is exceeded, resulting in
3376
+ # throttling of further requests.
3377
+ #
3378
+ # @!attribute [rw] message
3379
+ # @return [String]
3380
+ #
3381
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mailmanager-2023-10-17/ThrottlingException AWS API Documentation
3382
+ #
3383
+ class ThrottlingException < Struct.new(
3384
+ :message)
3385
+ SENSITIVE = []
3386
+ include Aws::Structure
3387
+ end
3388
+
3389
+ # The structure of a traffic policy resource which is a container for
3390
+ # policy statements.
3391
+ #
3392
+ # @!attribute [rw] default_action
3393
+ # Default action instructs the traffic policy to either Allow or Deny
3394
+ # (block) messages that fall outside of (or not addressed by) the
3395
+ # conditions of your policy statements
3396
+ # @return [String]
3397
+ #
3398
+ # @!attribute [rw] traffic_policy_id
3399
+ # The identifier of the traffic policy resource.
3400
+ # @return [String]
3401
+ #
3402
+ # @!attribute [rw] traffic_policy_name
3403
+ # A user-friendly name of the traffic policy resource.
3404
+ # @return [String]
3405
+ #
3406
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mailmanager-2023-10-17/TrafficPolicy AWS API Documentation
3407
+ #
3408
+ class TrafficPolicy < Struct.new(
3409
+ :default_action,
3410
+ :traffic_policy_id,
3411
+ :traffic_policy_name)
3412
+ SENSITIVE = []
3413
+ include Aws::Structure
3414
+ end
3415
+
3416
+ # @!attribute [rw] resource_arn
3417
+ # The Amazon Resource Name (ARN) of the resource that you want to
3418
+ # untag.
3419
+ # @return [String]
3420
+ #
3421
+ # @!attribute [rw] tag_keys
3422
+ # The keys of the key-value pairs for the tag or tags you want to
3423
+ # remove from the specified resource.
3424
+ # @return [Array<String>]
3425
+ #
3426
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mailmanager-2023-10-17/UntagResourceRequest AWS API Documentation
3427
+ #
3428
+ class UntagResourceRequest < Struct.new(
3429
+ :resource_arn,
3430
+ :tag_keys)
3431
+ SENSITIVE = []
3432
+ include Aws::Structure
3433
+ end
3434
+
3435
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mailmanager-2023-10-17/UntagResourceResponse AWS API Documentation
3436
+ #
3437
+ class UntagResourceResponse < Aws::EmptyStructure; end
3438
+
3439
+ # The request to update properties of an existing email archive.
3440
+ #
3441
+ # @!attribute [rw] archive_id
3442
+ # The identifier of the archive to update.
3443
+ # @return [String]
3444
+ #
3445
+ # @!attribute [rw] archive_name
3446
+ # A new, unique name for the archive.
3447
+ # @return [String]
3448
+ #
3449
+ # @!attribute [rw] retention
3450
+ # A new retention period for emails in the archive.
3451
+ # @return [Types::ArchiveRetention]
3452
+ #
3453
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mailmanager-2023-10-17/UpdateArchiveRequest AWS API Documentation
3454
+ #
3455
+ class UpdateArchiveRequest < Struct.new(
3456
+ :archive_id,
3457
+ :archive_name,
3458
+ :retention)
3459
+ SENSITIVE = []
3460
+ include Aws::Structure
3461
+ end
3462
+
3463
+ # The response indicating if the archive update succeeded or failed.
3464
+ #
3465
+ # On success, returns an HTTP 200 status code. On failure, returns an
3466
+ # error message.
3467
+ #
3468
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mailmanager-2023-10-17/UpdateArchiveResponse AWS API Documentation
3469
+ #
3470
+ class UpdateArchiveResponse < Aws::EmptyStructure; end
3471
+
3472
+ # @!attribute [rw] ingress_point_configuration
3473
+ # If you choose an Authenticated ingress endpoint, you must configure
3474
+ # either an SMTP password or a secret ARN.
3475
+ # @return [Types::IngressPointConfiguration]
3476
+ #
3477
+ # @!attribute [rw] ingress_point_id
3478
+ # The identifier for the ingress endpoint you want to update.
3479
+ # @return [String]
3480
+ #
3481
+ # @!attribute [rw] ingress_point_name
3482
+ # A user friendly name for the ingress endpoint resource.
3483
+ # @return [String]
3484
+ #
3485
+ # @!attribute [rw] rule_set_id
3486
+ # The identifier of an existing rule set that you attach to an ingress
3487
+ # endpoint resource.
3488
+ # @return [String]
3489
+ #
3490
+ # @!attribute [rw] status_to_update
3491
+ # The update status of an ingress endpoint.
3492
+ # @return [String]
3493
+ #
3494
+ # @!attribute [rw] traffic_policy_id
3495
+ # The identifier of an existing traffic policy that you attach to an
3496
+ # ingress endpoint resource.
3497
+ # @return [String]
3498
+ #
3499
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mailmanager-2023-10-17/UpdateIngressPointRequest AWS API Documentation
3500
+ #
3501
+ class UpdateIngressPointRequest < Struct.new(
3502
+ :ingress_point_configuration,
3503
+ :ingress_point_id,
3504
+ :ingress_point_name,
3505
+ :rule_set_id,
3506
+ :status_to_update,
3507
+ :traffic_policy_id)
3508
+ SENSITIVE = []
3509
+ include Aws::Structure
3510
+ end
3511
+
3512
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mailmanager-2023-10-17/UpdateIngressPointResponse AWS API Documentation
3513
+ #
3514
+ class UpdateIngressPointResponse < Aws::EmptyStructure; end
3515
+
3516
+ # @!attribute [rw] authentication
3517
+ # Authentication for the relay destination server—specify the
3518
+ # secretARN where the SMTP credentials are stored.
3519
+ # @return [Types::RelayAuthentication]
3520
+ #
3521
+ # @!attribute [rw] relay_id
3522
+ # The unique relay identifier.
3523
+ # @return [String]
3524
+ #
3525
+ # @!attribute [rw] relay_name
3526
+ # The name of the relay resource.
3527
+ # @return [String]
3528
+ #
3529
+ # @!attribute [rw] server_name
3530
+ # The destination relay server address.
3531
+ # @return [String]
3532
+ #
3533
+ # @!attribute [rw] server_port
3534
+ # The destination relay server port.
3535
+ # @return [Integer]
3536
+ #
3537
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mailmanager-2023-10-17/UpdateRelayRequest AWS API Documentation
3538
+ #
3539
+ class UpdateRelayRequest < Struct.new(
3540
+ :authentication,
3541
+ :relay_id,
3542
+ :relay_name,
3543
+ :server_name,
3544
+ :server_port)
3545
+ SENSITIVE = []
3546
+ include Aws::Structure
3547
+ end
3548
+
3549
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mailmanager-2023-10-17/UpdateRelayResponse AWS API Documentation
3550
+ #
3551
+ class UpdateRelayResponse < Aws::EmptyStructure; end
3552
+
3553
+ # @!attribute [rw] rule_set_id
3554
+ # The identifier of a rule set you want to update.
3555
+ # @return [String]
3556
+ #
3557
+ # @!attribute [rw] rule_set_name
3558
+ # A user-friendly name for the rule set resource.
3559
+ # @return [String]
3560
+ #
3561
+ # @!attribute [rw] rules
3562
+ # A new set of rules to replace the current rules of the rule
3563
+ # set—these rules will override all the rules of the rule set.
3564
+ # @return [Array<Types::Rule>]
3565
+ #
3566
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mailmanager-2023-10-17/UpdateRuleSetRequest AWS API Documentation
3567
+ #
3568
+ class UpdateRuleSetRequest < Struct.new(
3569
+ :rule_set_id,
3570
+ :rule_set_name,
3571
+ :rules)
3572
+ SENSITIVE = []
3573
+ include Aws::Structure
3574
+ end
3575
+
3576
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mailmanager-2023-10-17/UpdateRuleSetResponse AWS API Documentation
3577
+ #
3578
+ class UpdateRuleSetResponse < Aws::EmptyStructure; end
3579
+
3580
+ # @!attribute [rw] default_action
3581
+ # Default action instructs the traffic policy to either Allow or Deny
3582
+ # (block) messages that fall outside of (or not addressed by) the
3583
+ # conditions of your policy statements
3584
+ # @return [String]
3585
+ #
3586
+ # @!attribute [rw] max_message_size_bytes
3587
+ # The maximum message size in bytes of email which is allowed in by
3588
+ # this traffic policy—anything larger will be blocked.
3589
+ # @return [Integer]
3590
+ #
3591
+ # @!attribute [rw] policy_statements
3592
+ # The list of conditions to be updated for filtering email traffic.
3593
+ # @return [Array<Types::PolicyStatement>]
3594
+ #
3595
+ # @!attribute [rw] traffic_policy_id
3596
+ # The identifier of the traffic policy that you want to update.
3597
+ # @return [String]
3598
+ #
3599
+ # @!attribute [rw] traffic_policy_name
3600
+ # A user-friendly name for the traffic policy resource.
3601
+ # @return [String]
3602
+ #
3603
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mailmanager-2023-10-17/UpdateTrafficPolicyRequest AWS API Documentation
3604
+ #
3605
+ class UpdateTrafficPolicyRequest < Struct.new(
3606
+ :default_action,
3607
+ :max_message_size_bytes,
3608
+ :policy_statements,
3609
+ :traffic_policy_id,
3610
+ :traffic_policy_name)
3611
+ SENSITIVE = []
3612
+ include Aws::Structure
3613
+ end
3614
+
3615
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mailmanager-2023-10-17/UpdateTrafficPolicyResponse AWS API Documentation
3616
+ #
3617
+ class UpdateTrafficPolicyResponse < Aws::EmptyStructure; end
3618
+
3619
+ # The request validation has failed. For details, see the accompanying
3620
+ # error message.
3621
+ #
3622
+ # @!attribute [rw] message
3623
+ # @return [String]
3624
+ #
3625
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mailmanager-2023-10-17/ValidationException AWS API Documentation
3626
+ #
3627
+ class ValidationException < Struct.new(
3628
+ :message)
3629
+ SENSITIVE = []
3630
+ include Aws::Structure
3631
+ end
3632
+
3633
+ end
3634
+ end