aws-sdk-notifications 1.0.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -0,0 +1,2075 @@
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::Notifications
11
+ module Types
12
+
13
+ # User does not have sufficient access to perform this action.
14
+ #
15
+ # @!attribute [rw] message
16
+ # @return [String]
17
+ #
18
+ # @see http://docs.aws.amazon.com/goto/WebAPI/notifications-2018-05-10/AccessDeniedException AWS API Documentation
19
+ #
20
+ class AccessDeniedException < Struct.new(
21
+ :message)
22
+ SENSITIVE = []
23
+ include Aws::Structure
24
+ end
25
+
26
+ # @!attribute [rw] arn
27
+ # The Amazon Resource Name (ARN) of the Channel to associate with the
28
+ # NotificationConfiguration.
29
+ #
30
+ # Supported ARNs include AWS Chatbot, the Console Mobile Application,
31
+ # and notifications-contacts.
32
+ # @return [String]
33
+ #
34
+ # @!attribute [rw] notification_configuration_arn
35
+ # The ARN of the NotificationConfiguration to associate with the
36
+ # Channel.
37
+ # @return [String]
38
+ #
39
+ # @see http://docs.aws.amazon.com/goto/WebAPI/notifications-2018-05-10/AssociateChannelRequest AWS API Documentation
40
+ #
41
+ class AssociateChannelRequest < Struct.new(
42
+ :arn,
43
+ :notification_configuration_arn)
44
+ SENSITIVE = []
45
+ include Aws::Structure
46
+ end
47
+
48
+ # @see http://docs.aws.amazon.com/goto/WebAPI/notifications-2018-05-10/AssociateChannelResponse AWS API Documentation
49
+ #
50
+ class AssociateChannelResponse < Aws::EmptyStructure; end
51
+
52
+ # Updating or deleting a resource can cause an inconsistent state.
53
+ #
54
+ # @!attribute [rw] message
55
+ # @return [String]
56
+ #
57
+ # @!attribute [rw] resource_id
58
+ # The resource ID that prompted the conflict error.
59
+ # @return [String]
60
+ #
61
+ # @see http://docs.aws.amazon.com/goto/WebAPI/notifications-2018-05-10/ConflictException AWS API Documentation
62
+ #
63
+ class ConflictException < Struct.new(
64
+ :message,
65
+ :resource_id)
66
+ SENSITIVE = []
67
+ include Aws::Structure
68
+ end
69
+
70
+ # @!attribute [rw] notification_configuration_arn
71
+ # The Amazon Resource Name (ARN) of the NotificationConfiguration
72
+ # associated with this EventRule.
73
+ # @return [String]
74
+ #
75
+ # @!attribute [rw] source
76
+ # The matched event source.
77
+ #
78
+ # Must match one of the valid EventBridge sources. Only AWS service
79
+ # sourced events are supported. For example, `aws.ec2` and
80
+ # `aws.cloudwatch`. For more information, see [Event delivery from AWS
81
+ # services][1] in the *Amazon EventBridge User Guide*.
82
+ #
83
+ #
84
+ #
85
+ # [1]: https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-service-event.html#eb-service-event-delivery-level
86
+ # @return [String]
87
+ #
88
+ # @!attribute [rw] event_type
89
+ # The event type to match.
90
+ #
91
+ # Must match one of the valid Amazon EventBridge event types. For
92
+ # example, EC2 Instance State-change Notification and AWS CloudWatch
93
+ # Alarm State Change. For more information, see [Event delivery from
94
+ # AWS services][1] in the *Amazon EventBridge User Guide*.
95
+ #
96
+ #
97
+ #
98
+ # [1]: https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-service-event.html#eb-service-event-delivery-level
99
+ # @return [String]
100
+ #
101
+ # @!attribute [rw] event_pattern
102
+ # An additional event pattern used to further filter the events this
103
+ # EventRule receives.
104
+ #
105
+ # For more information, see [Amazon EventBridge event patterns][1] in
106
+ # the *Amazon EventBridge User Guide.*
107
+ #
108
+ #
109
+ #
110
+ # [1]: https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-event-patterns.html
111
+ # @return [String]
112
+ #
113
+ # @!attribute [rw] regions
114
+ # A list of AWS Regions that send events to this EventRule.
115
+ # @return [Array<String>]
116
+ #
117
+ # @see http://docs.aws.amazon.com/goto/WebAPI/notifications-2018-05-10/CreateEventRuleRequest AWS API Documentation
118
+ #
119
+ class CreateEventRuleRequest < Struct.new(
120
+ :notification_configuration_arn,
121
+ :source,
122
+ :event_type,
123
+ :event_pattern,
124
+ :regions)
125
+ SENSITIVE = []
126
+ include Aws::Structure
127
+ end
128
+
129
+ # @!attribute [rw] arn
130
+ # The ARN of the resource.
131
+ # @return [String]
132
+ #
133
+ # @!attribute [rw] notification_configuration_arn
134
+ # The ARN of a NotificationConfiguration.
135
+ # @return [String]
136
+ #
137
+ # @!attribute [rw] status_summary_by_region
138
+ # A list of an EventRule's status by Region. Regions are mapped to
139
+ # EventRuleStatusSummary.
140
+ # @return [Hash<String,Types::EventRuleStatusSummary>]
141
+ #
142
+ # @see http://docs.aws.amazon.com/goto/WebAPI/notifications-2018-05-10/CreateEventRuleResponse AWS API Documentation
143
+ #
144
+ class CreateEventRuleResponse < Struct.new(
145
+ :arn,
146
+ :notification_configuration_arn,
147
+ :status_summary_by_region)
148
+ SENSITIVE = []
149
+ include Aws::Structure
150
+ end
151
+
152
+ # @!attribute [rw] name
153
+ # The name of the NotificationConfiguration. Supports RFC 3986's
154
+ # unreserved characters.
155
+ # @return [String]
156
+ #
157
+ # @!attribute [rw] description
158
+ # The description of the NotificationConfiguration.
159
+ # @return [String]
160
+ #
161
+ # @!attribute [rw] aggregation_duration
162
+ # The aggregation preference of the NotificationConfiguration.
163
+ #
164
+ # * Values:
165
+ #
166
+ # * `LONG`
167
+ #
168
+ # * Aggregate notifications for long periods of time (12 hours).
169
+ #
170
+ # ^
171
+ # * `SHORT`
172
+ #
173
+ # * Aggregate notifications for short periods of time (5 minutes).
174
+ #
175
+ # ^
176
+ # * `NONE`
177
+ #
178
+ # * Don't aggregate notifications.
179
+ #
180
+ # No delay in delivery.
181
+ # @return [String]
182
+ #
183
+ # @!attribute [rw] tags
184
+ # A map of tags assigned to a resource. A tag is a string-to-string
185
+ # map of key-value pairs.
186
+ # @return [Hash<String,String>]
187
+ #
188
+ # @see http://docs.aws.amazon.com/goto/WebAPI/notifications-2018-05-10/CreateNotificationConfigurationRequest AWS API Documentation
189
+ #
190
+ class CreateNotificationConfigurationRequest < Struct.new(
191
+ :name,
192
+ :description,
193
+ :aggregation_duration,
194
+ :tags)
195
+ SENSITIVE = []
196
+ include Aws::Structure
197
+ end
198
+
199
+ # @!attribute [rw] arn
200
+ # The Amazon Resource Name (ARN) of the the resource.
201
+ # @return [String]
202
+ #
203
+ # @!attribute [rw] status
204
+ # The status of this NotificationConfiguration.
205
+ #
206
+ # The status should always be `INACTIVE` when part of the
207
+ # CreateNotificationConfiguration response.
208
+ #
209
+ # * Values:
210
+ #
211
+ # * `ACTIVE`
212
+ #
213
+ # * All EventRules are `ACTIVE` and any call can be run.
214
+ #
215
+ # ^
216
+ # * `PARTIALLY_ACTIVE`
217
+ #
218
+ # * Some EventRules are `ACTIVE` and some are `INACTIVE`.
219
+ #
220
+ # * Any call can be run.
221
+ # * `INACTIVE`
222
+ #
223
+ # * All EventRules are `INACTIVE` and any call can be run.
224
+ #
225
+ # ^
226
+ # * `DELETING`
227
+ #
228
+ # * This NotificationConfiguration is being deleted.
229
+ #
230
+ # * Only `GET` and `LIST` calls can be run.
231
+ # @return [String]
232
+ #
233
+ # @see http://docs.aws.amazon.com/goto/WebAPI/notifications-2018-05-10/CreateNotificationConfigurationResponse AWS API Documentation
234
+ #
235
+ class CreateNotificationConfigurationResponse < Struct.new(
236
+ :arn,
237
+ :status)
238
+ SENSITIVE = []
239
+ include Aws::Structure
240
+ end
241
+
242
+ # @!attribute [rw] arn
243
+ # The Amazon Resource Name (ARN) of the EventRule to delete.
244
+ # @return [String]
245
+ #
246
+ # @see http://docs.aws.amazon.com/goto/WebAPI/notifications-2018-05-10/DeleteEventRuleRequest AWS API Documentation
247
+ #
248
+ class DeleteEventRuleRequest < Struct.new(
249
+ :arn)
250
+ SENSITIVE = []
251
+ include Aws::Structure
252
+ end
253
+
254
+ # @see http://docs.aws.amazon.com/goto/WebAPI/notifications-2018-05-10/DeleteEventRuleResponse AWS API Documentation
255
+ #
256
+ class DeleteEventRuleResponse < Aws::EmptyStructure; end
257
+
258
+ # @!attribute [rw] arn
259
+ # The Amazon Resource Name (ARN) of the NotificationConfiguration to
260
+ # delete.
261
+ # @return [String]
262
+ #
263
+ # @see http://docs.aws.amazon.com/goto/WebAPI/notifications-2018-05-10/DeleteNotificationConfigurationRequest AWS API Documentation
264
+ #
265
+ class DeleteNotificationConfigurationRequest < Struct.new(
266
+ :arn)
267
+ SENSITIVE = []
268
+ include Aws::Structure
269
+ end
270
+
271
+ # @see http://docs.aws.amazon.com/goto/WebAPI/notifications-2018-05-10/DeleteNotificationConfigurationResponse AWS API Documentation
272
+ #
273
+ class DeleteNotificationConfigurationResponse < Aws::EmptyStructure; end
274
+
275
+ # @!attribute [rw] notification_hub_region
276
+ # The NotificationHub Region.
277
+ # @return [String]
278
+ #
279
+ # @see http://docs.aws.amazon.com/goto/WebAPI/notifications-2018-05-10/DeregisterNotificationHubRequest AWS API Documentation
280
+ #
281
+ class DeregisterNotificationHubRequest < Struct.new(
282
+ :notification_hub_region)
283
+ SENSITIVE = []
284
+ include Aws::Structure
285
+ end
286
+
287
+ # @!attribute [rw] notification_hub_region
288
+ # The NotificationHub Region.
289
+ # @return [String]
290
+ #
291
+ # @!attribute [rw] status_summary
292
+ # NotificationHub status information.
293
+ # @return [Types::NotificationHubStatusSummary]
294
+ #
295
+ # @see http://docs.aws.amazon.com/goto/WebAPI/notifications-2018-05-10/DeregisterNotificationHubResponse AWS API Documentation
296
+ #
297
+ class DeregisterNotificationHubResponse < Struct.new(
298
+ :notification_hub_region,
299
+ :status_summary)
300
+ SENSITIVE = []
301
+ include Aws::Structure
302
+ end
303
+
304
+ # The key-value pair of properties for an event.
305
+ #
306
+ # @!attribute [rw] name
307
+ # The name of the dimension
308
+ # @return [String]
309
+ #
310
+ # @!attribute [rw] value
311
+ # The value of the dimension.
312
+ # @return [String]
313
+ #
314
+ # @see http://docs.aws.amazon.com/goto/WebAPI/notifications-2018-05-10/Dimension AWS API Documentation
315
+ #
316
+ class Dimension < Struct.new(
317
+ :name,
318
+ :value)
319
+ SENSITIVE = []
320
+ include Aws::Structure
321
+ end
322
+
323
+ # @!attribute [rw] arn
324
+ # The Amazon Resource Name (ARN) of the Channel to disassociate.
325
+ # @return [String]
326
+ #
327
+ # @!attribute [rw] notification_configuration_arn
328
+ # The ARN of the NotificationConfiguration to disassociate.
329
+ # @return [String]
330
+ #
331
+ # @see http://docs.aws.amazon.com/goto/WebAPI/notifications-2018-05-10/DisassociateChannelRequest AWS API Documentation
332
+ #
333
+ class DisassociateChannelRequest < Struct.new(
334
+ :arn,
335
+ :notification_configuration_arn)
336
+ SENSITIVE = []
337
+ include Aws::Structure
338
+ end
339
+
340
+ # @see http://docs.aws.amazon.com/goto/WebAPI/notifications-2018-05-10/DisassociateChannelResponse AWS API Documentation
341
+ #
342
+ class DisassociateChannelResponse < Aws::EmptyStructure; end
343
+
344
+ # Describes EventRule status information.
345
+ #
346
+ # @!attribute [rw] status
347
+ # The status of the EventRule.
348
+ #
349
+ # * Values:
350
+ #
351
+ # * `ACTIVE`
352
+ #
353
+ # * The EventRule can process events.
354
+ #
355
+ # ^
356
+ # * `INACTIVE`
357
+ #
358
+ # * The EventRule may be unable to process events.
359
+ #
360
+ # ^
361
+ # * `CREATING`
362
+ #
363
+ # * The EventRule is being created.
364
+ #
365
+ # Only `GET` and `LIST` calls can be run.
366
+ # * `UPDATING`
367
+ #
368
+ # * The EventRule is being updated.
369
+ #
370
+ # Only `GET` and `LIST` calls can be run.
371
+ # * `DELETING`
372
+ #
373
+ # * The EventRule is being deleted.
374
+ #
375
+ # Only `GET` and `LIST` calls can be run.
376
+ # @return [String]
377
+ #
378
+ # @!attribute [rw] reason
379
+ # A human-readable reason for EventRuleStatus.
380
+ # @return [String]
381
+ #
382
+ # @see http://docs.aws.amazon.com/goto/WebAPI/notifications-2018-05-10/EventRuleStatusSummary AWS API Documentation
383
+ #
384
+ class EventRuleStatusSummary < Struct.new(
385
+ :status,
386
+ :reason)
387
+ SENSITIVE = []
388
+ include Aws::Structure
389
+ end
390
+
391
+ # Contains a complete list of fields related to an EventRule.
392
+ #
393
+ # @!attribute [rw] arn
394
+ # The Amazon Resource Name (ARN) of the resource.
395
+ # @return [String]
396
+ #
397
+ # @!attribute [rw] notification_configuration_arn
398
+ # The ARN for the NotificationConfiguration associated with this
399
+ # EventRule.
400
+ # @return [String]
401
+ #
402
+ # @!attribute [rw] creation_time
403
+ # The creation time of the resource.
404
+ # @return [Time]
405
+ #
406
+ # @!attribute [rw] source
407
+ # The matched event source.
408
+ #
409
+ # Must match one of the valid EventBridge sources. Only AWS service
410
+ # sourced events are supported. For example, `aws.ec2` and
411
+ # `aws.cloudwatch`. For more information, see [Event delivery from AWS
412
+ # services][1] in the *Amazon EventBridge User Guide*.
413
+ #
414
+ #
415
+ #
416
+ # [1]: https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-service-event.html#eb-service-event-delivery-level
417
+ # @return [String]
418
+ #
419
+ # @!attribute [rw] event_type
420
+ # The event type to match.
421
+ #
422
+ # Must match one of the valid Amazon EventBridge event types. For
423
+ # example, EC2 Instance State-change Notification and AWS CloudWatch
424
+ # Alarm State Change. For more information, see [Event delivery from
425
+ # AWS services][1] in the *Amazon EventBridge User Guide*.
426
+ #
427
+ #
428
+ #
429
+ # [1]: https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-service-event.html#eb-service-event-delivery-level
430
+ # @return [String]
431
+ #
432
+ # @!attribute [rw] event_pattern
433
+ # An additional event pattern used to further filter the events this
434
+ # EventRule receives.
435
+ #
436
+ # For more information, see [Amazon EventBridge event patterns][1] in
437
+ # the *Amazon EventBridge User Guide.*
438
+ #
439
+ #
440
+ #
441
+ # [1]: https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-event-patterns.html
442
+ # @return [String]
443
+ #
444
+ # @!attribute [rw] regions
445
+ # A list of AWS Regions that send events to this EventRule.
446
+ # @return [Array<String>]
447
+ #
448
+ # @!attribute [rw] managed_rules
449
+ # A list of Amazon EventBridge Managed Rule ARNs associated with this
450
+ # EventRule.
451
+ #
452
+ # <note markdown="1"> These are created by AWS User Notifications within your account so
453
+ # your EventRules can function.
454
+ #
455
+ # </note>
456
+ # @return [Array<String>]
457
+ #
458
+ # @!attribute [rw] status_summary_by_region
459
+ # A list of an EventRule's status by Region. Regions are mapped to
460
+ # EventRuleStatusSummary.
461
+ # @return [Hash<String,Types::EventRuleStatusSummary>]
462
+ #
463
+ # @see http://docs.aws.amazon.com/goto/WebAPI/notifications-2018-05-10/EventRuleStructure AWS API Documentation
464
+ #
465
+ class EventRuleStructure < Struct.new(
466
+ :arn,
467
+ :notification_configuration_arn,
468
+ :creation_time,
469
+ :source,
470
+ :event_type,
471
+ :event_pattern,
472
+ :regions,
473
+ :managed_rules,
474
+ :status_summary_by_region)
475
+ SENSITIVE = []
476
+ include Aws::Structure
477
+ end
478
+
479
+ # @!attribute [rw] arn
480
+ # The Amazon Resource Name (ARN) of the EventRule to return.
481
+ # @return [String]
482
+ #
483
+ # @see http://docs.aws.amazon.com/goto/WebAPI/notifications-2018-05-10/GetEventRuleRequest AWS API Documentation
484
+ #
485
+ class GetEventRuleRequest < Struct.new(
486
+ :arn)
487
+ SENSITIVE = []
488
+ include Aws::Structure
489
+ end
490
+
491
+ # @!attribute [rw] arn
492
+ # The ARN of the resource.
493
+ # @return [String]
494
+ #
495
+ # @!attribute [rw] notification_configuration_arn
496
+ # The ARN of a NotificationConfiguration.
497
+ # @return [String]
498
+ #
499
+ # @!attribute [rw] creation_time
500
+ # The date when the EventRule was created.
501
+ # @return [Time]
502
+ #
503
+ # @!attribute [rw] source
504
+ # The matched event source.
505
+ #
506
+ # Must match one of the valid EventBridge sources. Only AWS service
507
+ # sourced events are supported. For example, `aws.ec2` and
508
+ # `aws.cloudwatch`. For more information, see [Event delivery from AWS
509
+ # services][1] in the *Amazon EventBridge User Guide*.
510
+ #
511
+ #
512
+ #
513
+ # [1]: https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-service-event.html#eb-service-event-delivery-level
514
+ # @return [String]
515
+ #
516
+ # @!attribute [rw] event_type
517
+ # The event type to match.
518
+ #
519
+ # Must match one of the valid Amazon EventBridge event types. For
520
+ # example, EC2 Instance State-change Notification and AWS CloudWatch
521
+ # Alarm State Change. For more information, see [Event delivery from
522
+ # AWS services][1] in the *Amazon EventBridge User Guide*.
523
+ #
524
+ #
525
+ #
526
+ # [1]: https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-service-event.html#eb-service-event-delivery-level
527
+ # @return [String]
528
+ #
529
+ # @!attribute [rw] event_pattern
530
+ # An additional event pattern used to further filter the events this
531
+ # EventRule receives.
532
+ #
533
+ # For more information, see [Amazon EventBridge event patterns][1] in
534
+ # the *Amazon EventBridge User Guide.*
535
+ #
536
+ #
537
+ #
538
+ # [1]: https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-event-patterns.html
539
+ # @return [String]
540
+ #
541
+ # @!attribute [rw] regions
542
+ # A list of AWS Regions that send events to this EventRule.
543
+ # @return [Array<String>]
544
+ #
545
+ # @!attribute [rw] managed_rules
546
+ # A list of managed rules from EventBridge that are are associated
547
+ # with this EventRule.
548
+ #
549
+ # <note markdown="1"> These are created by AWS User Notifications within your account so
550
+ # this EventRule functions.
551
+ #
552
+ # </note>
553
+ # @return [Array<String>]
554
+ #
555
+ # @!attribute [rw] status_summary_by_region
556
+ # A list of an EventRule's status by Region. Regions are mapped to
557
+ # EventRuleStatusSummary.
558
+ # @return [Hash<String,Types::EventRuleStatusSummary>]
559
+ #
560
+ # @see http://docs.aws.amazon.com/goto/WebAPI/notifications-2018-05-10/GetEventRuleResponse AWS API Documentation
561
+ #
562
+ class GetEventRuleResponse < Struct.new(
563
+ :arn,
564
+ :notification_configuration_arn,
565
+ :creation_time,
566
+ :source,
567
+ :event_type,
568
+ :event_pattern,
569
+ :regions,
570
+ :managed_rules,
571
+ :status_summary_by_region)
572
+ SENSITIVE = []
573
+ include Aws::Structure
574
+ end
575
+
576
+ # @!attribute [rw] arn
577
+ # The Amazon Resource Name (ARN) of the NotificationConfiguration to
578
+ # return.
579
+ # @return [String]
580
+ #
581
+ # @see http://docs.aws.amazon.com/goto/WebAPI/notifications-2018-05-10/GetNotificationConfigurationRequest AWS API Documentation
582
+ #
583
+ class GetNotificationConfigurationRequest < Struct.new(
584
+ :arn)
585
+ SENSITIVE = []
586
+ include Aws::Structure
587
+ end
588
+
589
+ # @!attribute [rw] arn
590
+ # The ARN of the resource.
591
+ # @return [String]
592
+ #
593
+ # @!attribute [rw] name
594
+ # The name of the NotificationConfiguration.
595
+ # @return [String]
596
+ #
597
+ # @!attribute [rw] description
598
+ # The description of the NotificationConfiguration.
599
+ # @return [String]
600
+ #
601
+ # @!attribute [rw] status
602
+ # The status of this NotificationConfiguration.
603
+ #
604
+ # The status should always be `INACTIVE` when part of the
605
+ # CreateNotificationConfiguration response.
606
+ #
607
+ # * Values:
608
+ #
609
+ # * `ACTIVE`
610
+ #
611
+ # * All EventRules are `ACTIVE` and any call can be run.
612
+ #
613
+ # ^
614
+ # * `PARTIALLY_ACTIVE`
615
+ #
616
+ # * Some EventRules are `ACTIVE` and some are `INACTIVE`.
617
+ #
618
+ # * Any call can be run.
619
+ # * `INACTIVE`
620
+ #
621
+ # * All EventRules are `INACTIVE` and any call can be run.
622
+ #
623
+ # ^
624
+ # * `DELETING`
625
+ #
626
+ # * This NotificationConfiguration is being deleted. Only `GET`
627
+ # and `LIST` calls can be run.
628
+ #
629
+ # * Only `GET` and `LIST` calls can be run.
630
+ # @return [String]
631
+ #
632
+ # @!attribute [rw] creation_time
633
+ # The creation time of the NotificationConfiguration.
634
+ # @return [Time]
635
+ #
636
+ # @!attribute [rw] aggregation_duration
637
+ # The aggregation preference of the NotificationConfiguration.
638
+ #
639
+ # * Values:
640
+ #
641
+ # * `LONG`
642
+ #
643
+ # * Aggregate notifications for long periods of time (12 hours).
644
+ #
645
+ # ^
646
+ # * `SHORT`
647
+ #
648
+ # * Aggregate notifications for short periods of time (5 minutes).
649
+ #
650
+ # ^
651
+ # * `NONE`
652
+ #
653
+ # * Don't aggregate notifications.
654
+ #
655
+ # No delay in delivery.
656
+ # @return [String]
657
+ #
658
+ # @see http://docs.aws.amazon.com/goto/WebAPI/notifications-2018-05-10/GetNotificationConfigurationResponse AWS API Documentation
659
+ #
660
+ class GetNotificationConfigurationResponse < Struct.new(
661
+ :arn,
662
+ :name,
663
+ :description,
664
+ :status,
665
+ :creation_time,
666
+ :aggregation_duration)
667
+ SENSITIVE = []
668
+ include Aws::Structure
669
+ end
670
+
671
+ # @!attribute [rw] arn
672
+ # The Amazon Resource Name (ARN) of the NotificationEvent to return.
673
+ # @return [String]
674
+ #
675
+ # @!attribute [rw] locale
676
+ # The locale code of the language used for the retrieved
677
+ # NotificationEvent. The default locale is English `en_US`.
678
+ # @return [String]
679
+ #
680
+ # @see http://docs.aws.amazon.com/goto/WebAPI/notifications-2018-05-10/GetNotificationEventRequest AWS API Documentation
681
+ #
682
+ class GetNotificationEventRequest < Struct.new(
683
+ :arn,
684
+ :locale)
685
+ SENSITIVE = []
686
+ include Aws::Structure
687
+ end
688
+
689
+ # @!attribute [rw] arn
690
+ # The ARN of the resource.
691
+ # @return [String]
692
+ #
693
+ # @!attribute [rw] notification_configuration_arn
694
+ # The ARN of the NotificationConfiguration.
695
+ # @return [String]
696
+ #
697
+ # @!attribute [rw] creation_time
698
+ # The creation time of the NotificationEvent.
699
+ # @return [Time]
700
+ #
701
+ # @!attribute [rw] content
702
+ # The content of the NotificationEvent.
703
+ # @return [Types::NotificationEvent]
704
+ #
705
+ # @see http://docs.aws.amazon.com/goto/WebAPI/notifications-2018-05-10/GetNotificationEventResponse AWS API Documentation
706
+ #
707
+ class GetNotificationEventResponse < Struct.new(
708
+ :arn,
709
+ :notification_configuration_arn,
710
+ :creation_time,
711
+ :content)
712
+ SENSITIVE = []
713
+ include Aws::Structure
714
+ end
715
+
716
+ # Unexpected error during processing of request.
717
+ #
718
+ # @!attribute [rw] message
719
+ # @return [String]
720
+ #
721
+ # @see http://docs.aws.amazon.com/goto/WebAPI/notifications-2018-05-10/InternalServerException AWS API Documentation
722
+ #
723
+ class InternalServerException < Struct.new(
724
+ :message)
725
+ SENSITIVE = []
726
+ include Aws::Structure
727
+ end
728
+
729
+ # @!attribute [rw] notification_configuration_arn
730
+ # The Amazon Resource Name (ARN) of the NotificationConfiguration.
731
+ # @return [String]
732
+ #
733
+ # @!attribute [rw] max_results
734
+ # The maximum number of results to be returned in this call. The
735
+ # default value is 20.
736
+ # @return [Integer]
737
+ #
738
+ # @!attribute [rw] next_token
739
+ # The start token for paginated calls. Retrieved from the response of
740
+ # a previous ListNotificationEvents call. NextToken uses Base64
741
+ # encoding.
742
+ # @return [String]
743
+ #
744
+ # @see http://docs.aws.amazon.com/goto/WebAPI/notifications-2018-05-10/ListChannelsRequest AWS API Documentation
745
+ #
746
+ class ListChannelsRequest < Struct.new(
747
+ :notification_configuration_arn,
748
+ :max_results,
749
+ :next_token)
750
+ SENSITIVE = []
751
+ include Aws::Structure
752
+ end
753
+
754
+ # @!attribute [rw] next_token
755
+ # A pagination token. If a non-null pagination token is returned in a
756
+ # result, pass its value in another request to retrieve more entries.
757
+ # @return [String]
758
+ #
759
+ # @!attribute [rw] channels
760
+ # A list of Channels.
761
+ # @return [Array<String>]
762
+ #
763
+ # @see http://docs.aws.amazon.com/goto/WebAPI/notifications-2018-05-10/ListChannelsResponse AWS API Documentation
764
+ #
765
+ class ListChannelsResponse < Struct.new(
766
+ :next_token,
767
+ :channels)
768
+ SENSITIVE = []
769
+ include Aws::Structure
770
+ end
771
+
772
+ # @!attribute [rw] notification_configuration_arn
773
+ # The Amazon Resource Name (ARN) of the NotificationConfiguration.
774
+ # @return [String]
775
+ #
776
+ # @!attribute [rw] max_results
777
+ # The maximum number of results to be returned in this call. The
778
+ # default value is 20.
779
+ # @return [Integer]
780
+ #
781
+ # @!attribute [rw] next_token
782
+ # The start token for paginated calls. Retrieved from the response of
783
+ # a previous ListEventRules call. Next token uses Base64 encoding.
784
+ # @return [String]
785
+ #
786
+ # @see http://docs.aws.amazon.com/goto/WebAPI/notifications-2018-05-10/ListEventRulesRequest AWS API Documentation
787
+ #
788
+ class ListEventRulesRequest < Struct.new(
789
+ :notification_configuration_arn,
790
+ :max_results,
791
+ :next_token)
792
+ SENSITIVE = []
793
+ include Aws::Structure
794
+ end
795
+
796
+ # @!attribute [rw] next_token
797
+ # A pagination token. If a non-null pagination token is returned in a
798
+ # result, pass its value in another request to retrieve more entries.
799
+ # @return [String]
800
+ #
801
+ # @!attribute [rw] event_rules
802
+ # A list of EventRules.
803
+ # @return [Array<Types::EventRuleStructure>]
804
+ #
805
+ # @see http://docs.aws.amazon.com/goto/WebAPI/notifications-2018-05-10/ListEventRulesResponse AWS API Documentation
806
+ #
807
+ class ListEventRulesResponse < Struct.new(
808
+ :next_token,
809
+ :event_rules)
810
+ SENSITIVE = []
811
+ include Aws::Structure
812
+ end
813
+
814
+ # @!attribute [rw] event_rule_source
815
+ # The matched event source.
816
+ #
817
+ # Must match one of the valid EventBridge sources. Only AWS service
818
+ # sourced events are supported. For example, `aws.ec2` and
819
+ # `aws.cloudwatch`. For more information, see [Event delivery from AWS
820
+ # services][1] in the *Amazon EventBridge User Guide*.
821
+ #
822
+ #
823
+ #
824
+ # [1]: https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-service-event.html#eb-service-event-delivery-level
825
+ # @return [String]
826
+ #
827
+ # @!attribute [rw] channel_arn
828
+ # The Amazon Resource Name (ARN) of the Channel to match.
829
+ # @return [String]
830
+ #
831
+ # @!attribute [rw] status
832
+ # The NotificationConfiguration status to match.
833
+ #
834
+ # * Values:
835
+ #
836
+ # * `ACTIVE`
837
+ #
838
+ # * All EventRules are `ACTIVE` and any call can be run.
839
+ #
840
+ # ^
841
+ # * `PARTIALLY_ACTIVE`
842
+ #
843
+ # * Some EventRules are `ACTIVE` and some are `INACTIVE`. Any call
844
+ # can be run.
845
+ #
846
+ # * Any call can be run.
847
+ # * `INACTIVE`
848
+ #
849
+ # * All EventRules are `INACTIVE` and any call can be run.
850
+ #
851
+ # ^
852
+ # * `DELETING`
853
+ #
854
+ # * This NotificationConfiguration is being deleted.
855
+ #
856
+ # * Only `GET` and `LIST` calls can be run.
857
+ # @return [String]
858
+ #
859
+ # @!attribute [rw] max_results
860
+ # The maximum number of results to be returned in this call. Defaults
861
+ # to 20.
862
+ # @return [Integer]
863
+ #
864
+ # @!attribute [rw] next_token
865
+ # The start token for paginated calls. Retrieved from the response of
866
+ # a previous ListEventRules call. Next token uses Base64 encoding.
867
+ # @return [String]
868
+ #
869
+ # @see http://docs.aws.amazon.com/goto/WebAPI/notifications-2018-05-10/ListNotificationConfigurationsRequest AWS API Documentation
870
+ #
871
+ class ListNotificationConfigurationsRequest < Struct.new(
872
+ :event_rule_source,
873
+ :channel_arn,
874
+ :status,
875
+ :max_results,
876
+ :next_token)
877
+ SENSITIVE = []
878
+ include Aws::Structure
879
+ end
880
+
881
+ # @!attribute [rw] next_token
882
+ # A pagination token. If a non-null pagination token is returned in a
883
+ # result, pass its value in another request to retrieve more entries.
884
+ # @return [String]
885
+ #
886
+ # @!attribute [rw] notification_configurations
887
+ # The NotificationConfigurations in the account.
888
+ # @return [Array<Types::NotificationConfigurationStructure>]
889
+ #
890
+ # @see http://docs.aws.amazon.com/goto/WebAPI/notifications-2018-05-10/ListNotificationConfigurationsResponse AWS API Documentation
891
+ #
892
+ class ListNotificationConfigurationsResponse < Struct.new(
893
+ :next_token,
894
+ :notification_configurations)
895
+ SENSITIVE = []
896
+ include Aws::Structure
897
+ end
898
+
899
+ # @!attribute [rw] start_time
900
+ # The earliest time of events to return from this call.
901
+ # @return [Time]
902
+ #
903
+ # @!attribute [rw] end_time
904
+ # Latest time of events to return from this call.
905
+ # @return [Time]
906
+ #
907
+ # @!attribute [rw] locale
908
+ # The locale code of the language used for the retrieved
909
+ # NotificationEvent. The default locale is English `(en_US)`.
910
+ # @return [String]
911
+ #
912
+ # @!attribute [rw] source
913
+ # The matched event source.
914
+ #
915
+ # Must match one of the valid EventBridge sources. Only AWS service
916
+ # sourced events are supported. For example, `aws.ec2` and
917
+ # `aws.cloudwatch`. For more information, see [Event delivery from AWS
918
+ # services][1] in the *Amazon EventBridge User Guide*.
919
+ #
920
+ #
921
+ #
922
+ # [1]: https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-service-event.html#eb-service-event-delivery-level
923
+ # @return [String]
924
+ #
925
+ # @!attribute [rw] include_child_events
926
+ # Include aggregated child events in the result.
927
+ # @return [Boolean]
928
+ #
929
+ # @!attribute [rw] aggregate_notification_event_arn
930
+ # The Amazon Resource Name (ARN) of the aggregatedNotificationEventArn
931
+ # to match.
932
+ # @return [String]
933
+ #
934
+ # @!attribute [rw] max_results
935
+ # The maximum number of results to be returned in this call. Defaults
936
+ # to 20.
937
+ # @return [Integer]
938
+ #
939
+ # @!attribute [rw] next_token
940
+ # The start token for paginated calls. Retrieved from the response of
941
+ # a previous ListEventRules call. Next token uses Base64 encoding.
942
+ # @return [String]
943
+ #
944
+ # @see http://docs.aws.amazon.com/goto/WebAPI/notifications-2018-05-10/ListNotificationEventsRequest AWS API Documentation
945
+ #
946
+ class ListNotificationEventsRequest < Struct.new(
947
+ :start_time,
948
+ :end_time,
949
+ :locale,
950
+ :source,
951
+ :include_child_events,
952
+ :aggregate_notification_event_arn,
953
+ :max_results,
954
+ :next_token)
955
+ SENSITIVE = []
956
+ include Aws::Structure
957
+ end
958
+
959
+ # @!attribute [rw] next_token
960
+ # A pagination token. If a non-null pagination token is returned in a
961
+ # result, pass its value in another request to retrieve more entries.
962
+ # @return [String]
963
+ #
964
+ # @!attribute [rw] notification_events
965
+ # The list of notification events.
966
+ # @return [Array<Types::NotificationEventOverview>]
967
+ #
968
+ # @see http://docs.aws.amazon.com/goto/WebAPI/notifications-2018-05-10/ListNotificationEventsResponse AWS API Documentation
969
+ #
970
+ class ListNotificationEventsResponse < Struct.new(
971
+ :next_token,
972
+ :notification_events)
973
+ SENSITIVE = []
974
+ include Aws::Structure
975
+ end
976
+
977
+ # @!attribute [rw] max_results
978
+ # The maximum number of records to list in a single response.
979
+ # @return [Integer]
980
+ #
981
+ # @!attribute [rw] next_token
982
+ # A pagination token. Set to null to start listing notification hubs
983
+ # from the start.
984
+ # @return [String]
985
+ #
986
+ # @see http://docs.aws.amazon.com/goto/WebAPI/notifications-2018-05-10/ListNotificationHubsRequest AWS API Documentation
987
+ #
988
+ class ListNotificationHubsRequest < Struct.new(
989
+ :max_results,
990
+ :next_token)
991
+ SENSITIVE = []
992
+ include Aws::Structure
993
+ end
994
+
995
+ # @!attribute [rw] notification_hubs
996
+ # The NotificationHubs in the account.
997
+ # @return [Array<Types::NotificationHubOverview>]
998
+ #
999
+ # @!attribute [rw] next_token
1000
+ # A pagination token. If a non-null pagination token is returned in a
1001
+ # result, pass its value in another request to retrieve more entries.
1002
+ # @return [String]
1003
+ #
1004
+ # @see http://docs.aws.amazon.com/goto/WebAPI/notifications-2018-05-10/ListNotificationHubsResponse AWS API Documentation
1005
+ #
1006
+ class ListNotificationHubsResponse < Struct.new(
1007
+ :notification_hubs,
1008
+ :next_token)
1009
+ SENSITIVE = []
1010
+ include Aws::Structure
1011
+ end
1012
+
1013
+ # @!attribute [rw] arn
1014
+ # The Amazon Resource Name (ARN) to use to list tags.
1015
+ # @return [String]
1016
+ #
1017
+ # @see http://docs.aws.amazon.com/goto/WebAPI/notifications-2018-05-10/ListTagsForResourceRequest AWS API Documentation
1018
+ #
1019
+ class ListTagsForResourceRequest < Struct.new(
1020
+ :arn)
1021
+ SENSITIVE = []
1022
+ include Aws::Structure
1023
+ end
1024
+
1025
+ # @!attribute [rw] tags
1026
+ # A list of tags for the specified ARN.
1027
+ # @return [Hash<String,String>]
1028
+ #
1029
+ # @see http://docs.aws.amazon.com/goto/WebAPI/notifications-2018-05-10/ListTagsForResourceResponse AWS API Documentation
1030
+ #
1031
+ class ListTagsForResourceResponse < Struct.new(
1032
+ :tags)
1033
+ SENSITIVE = []
1034
+ include Aws::Structure
1035
+ end
1036
+
1037
+ # Describes a media element.
1038
+ #
1039
+ # @!attribute [rw] media_id
1040
+ # The unique ID for the media.
1041
+ # @return [String]
1042
+ #
1043
+ # @!attribute [rw] type
1044
+ # The type of media.
1045
+ # @return [String]
1046
+ #
1047
+ # @!attribute [rw] url
1048
+ # The url of the media.
1049
+ # @return [String]
1050
+ #
1051
+ # @!attribute [rw] caption
1052
+ # The caption of the media.
1053
+ # @return [String]
1054
+ #
1055
+ # @see http://docs.aws.amazon.com/goto/WebAPI/notifications-2018-05-10/MediaElement AWS API Documentation
1056
+ #
1057
+ class MediaElement < Struct.new(
1058
+ :media_id,
1059
+ :type,
1060
+ :url,
1061
+ :caption)
1062
+ SENSITIVE = []
1063
+ include Aws::Structure
1064
+ end
1065
+
1066
+ # Describes the components of a notification message.
1067
+ #
1068
+ # @!attribute [rw] headline
1069
+ # A sentence long summary. For example, titles or an email subject
1070
+ # line.
1071
+ # @return [String]
1072
+ #
1073
+ # @!attribute [rw] paragraph_summary
1074
+ # A paragraph long or multiple sentence summary. For example, AWS
1075
+ # Chatbot notifications.
1076
+ # @return [String]
1077
+ #
1078
+ # @!attribute [rw] complete_description
1079
+ # A complete summary with all possible relevant information.
1080
+ # @return [String]
1081
+ #
1082
+ # @!attribute [rw] dimensions
1083
+ # A list of properties in key-value pairs. Pairs are shown in order of
1084
+ # importance from most important to least important. Channels may
1085
+ # limit the number of dimensions shown to the notification viewer.
1086
+ #
1087
+ # <note markdown="1"> Included dimensions, keys, and values are subject to change.
1088
+ #
1089
+ # </note>
1090
+ # @return [Array<Types::Dimension>]
1091
+ #
1092
+ # @see http://docs.aws.amazon.com/goto/WebAPI/notifications-2018-05-10/MessageComponents AWS API Documentation
1093
+ #
1094
+ class MessageComponents < Struct.new(
1095
+ :headline,
1096
+ :paragraph_summary,
1097
+ :complete_description,
1098
+ :dimensions)
1099
+ SENSITIVE = []
1100
+ include Aws::Structure
1101
+ end
1102
+
1103
+ # Contains the headline message component.
1104
+ #
1105
+ # @!attribute [rw] headline
1106
+ # A sentence long summary. For example, titles or an email subject
1107
+ # line.
1108
+ # @return [String]
1109
+ #
1110
+ # @see http://docs.aws.amazon.com/goto/WebAPI/notifications-2018-05-10/MessageComponentsSummary AWS API Documentation
1111
+ #
1112
+ class MessageComponentsSummary < Struct.new(
1113
+ :headline)
1114
+ SENSITIVE = []
1115
+ include Aws::Structure
1116
+ end
1117
+
1118
+ # Contains the complete list of fields for a NotificationConfiguration.
1119
+ #
1120
+ # @!attribute [rw] arn
1121
+ # The Amazon Resource Name (ARN) of the resource.
1122
+ # @return [String]
1123
+ #
1124
+ # @!attribute [rw] name
1125
+ # The name of the NotificationConfiguration. Supports RFC 3986's
1126
+ # unreserved characters.
1127
+ # @return [String]
1128
+ #
1129
+ # @!attribute [rw] description
1130
+ # The description of the NotificationConfiguration.
1131
+ # @return [String]
1132
+ #
1133
+ # @!attribute [rw] status
1134
+ # The status of this NotificationConfiguration.
1135
+ #
1136
+ # The status should always be INACTIVE when part of the
1137
+ # CreateNotificationConfiguration response.
1138
+ #
1139
+ # * Values:
1140
+ #
1141
+ # * `ACTIVE`
1142
+ #
1143
+ # * All EventRules are `ACTIVE` and any call can be run.
1144
+ #
1145
+ # ^
1146
+ # * `PARTIALLY_ACTIVE`
1147
+ #
1148
+ # * Some EventRules are `ACTIVE` and some are `INACTIVE`.
1149
+ #
1150
+ # * Any call can be run.
1151
+ # * `INACTIVE`
1152
+ #
1153
+ # * All EventRules are `INACTIVE` and any call can be run.
1154
+ #
1155
+ # ^
1156
+ # * `DELETING`
1157
+ #
1158
+ # * This NotificationConfiguration is being deleted. Only `GET`
1159
+ # and `LIST` calls can be run.
1160
+ #
1161
+ # * Only `GET` and `LIST` calls can be run.
1162
+ # @return [String]
1163
+ #
1164
+ # @!attribute [rw] creation_time
1165
+ # The creation time of the resource.
1166
+ # @return [Time]
1167
+ #
1168
+ # @!attribute [rw] aggregation_duration
1169
+ # The aggregation preference of the NotificationConfiguration.
1170
+ #
1171
+ # * Values:
1172
+ #
1173
+ # * `LONG`
1174
+ #
1175
+ # * Aggregate notifications for long periods of time (12 hours).
1176
+ #
1177
+ # ^
1178
+ # * `SHORT`
1179
+ #
1180
+ # * Aggregate notifications for short periods of time (5 minutes).
1181
+ #
1182
+ # ^
1183
+ # * `NONE`
1184
+ #
1185
+ # * Don't aggregate notifications.
1186
+ #
1187
+ # No delay in delivery.
1188
+ # @return [String]
1189
+ #
1190
+ # @see http://docs.aws.amazon.com/goto/WebAPI/notifications-2018-05-10/NotificationConfigurationStructure AWS API Documentation
1191
+ #
1192
+ class NotificationConfigurationStructure < Struct.new(
1193
+ :arn,
1194
+ :name,
1195
+ :description,
1196
+ :status,
1197
+ :creation_time,
1198
+ :aggregation_duration)
1199
+ SENSITIVE = []
1200
+ include Aws::Structure
1201
+ end
1202
+
1203
+ # A NotificationEvent is a notification-focused representation of an
1204
+ # event. They contain semantic information used by Channels to create
1205
+ # end-user notifications.
1206
+ #
1207
+ # @!attribute [rw] schema_version
1208
+ # The schema version of the Notification Event.
1209
+ # @return [String]
1210
+ #
1211
+ # @!attribute [rw] id
1212
+ # The unique identifier for a NotificationEvent.
1213
+ # @return [String]
1214
+ #
1215
+ # @!attribute [rw] source_event_metadata
1216
+ # The source event metadata.
1217
+ # @return [Types::SourceEventMetadata]
1218
+ #
1219
+ # @!attribute [rw] message_components
1220
+ # Describes the components of a notification message.
1221
+ # @return [Types::MessageComponents]
1222
+ #
1223
+ # @!attribute [rw] source_event_detail_url
1224
+ # The source event URL.
1225
+ # @return [String]
1226
+ #
1227
+ # @!attribute [rw] source_event_detail_url_display_text
1228
+ # The detailed URL for the source event.
1229
+ # @return [String]
1230
+ #
1231
+ # @!attribute [rw] notification_type
1232
+ # The type of event causing the notification.
1233
+ #
1234
+ # * Values:
1235
+ #
1236
+ # * `ALERT`
1237
+ #
1238
+ # * A notification about an event where something was triggered,
1239
+ # initiated, reopened, deployed, or a threshold was breached.
1240
+ #
1241
+ # ^
1242
+ # * `WARNING`
1243
+ #
1244
+ # * A notification about an event where an issue is about to
1245
+ # arise. For example, something is approaching a threshold.
1246
+ #
1247
+ # ^
1248
+ # * `ANNOUNCEMENT`
1249
+ #
1250
+ # * A notification about an important event. For example, a step
1251
+ # in a workflow or escalation path or that a workflow was
1252
+ # updated.
1253
+ #
1254
+ # ^
1255
+ # * `INFORMATIONAL`
1256
+ #
1257
+ # * A notification about informational messages. For example,
1258
+ # recommendations, service announcements, or reminders.
1259
+ #
1260
+ # ^
1261
+ # @return [String]
1262
+ #
1263
+ # @!attribute [rw] event_status
1264
+ # The assesed nature of the event.
1265
+ #
1266
+ # * Values:
1267
+ #
1268
+ # * `HEALTHY`
1269
+ #
1270
+ # * All EventRules are `ACTIVE` and any call can be run.
1271
+ #
1272
+ # ^
1273
+ # * `UNHEALTHY`
1274
+ #
1275
+ # * Some EventRules are `ACTIVE` and some are `INACTIVE`. Any call
1276
+ # can be run.
1277
+ #
1278
+ # ^
1279
+ # @return [String]
1280
+ #
1281
+ # @!attribute [rw] aggregation_event_type
1282
+ # The NotificationConfiguration's aggregation type.
1283
+ #
1284
+ # * Values:
1285
+ #
1286
+ # * `AGGREGATE`
1287
+ #
1288
+ # * The notification event is an aggregate notification. Aggregate
1289
+ # notifications summarize grouped events over a specified time
1290
+ # period.
1291
+ #
1292
+ # ^
1293
+ # * `CHILD`
1294
+ #
1295
+ # * Some EventRules are `ACTIVE` and some are `INACTIVE`. Any call
1296
+ # can be run.
1297
+ #
1298
+ # ^
1299
+ # * `NONE`
1300
+ #
1301
+ # * The notification isn't aggregated.
1302
+ #
1303
+ # ^
1304
+ # @return [String]
1305
+ #
1306
+ # @!attribute [rw] aggregate_notification_event_arn
1307
+ # If the value of aggregationEventType is not `NONE`, this is the
1308
+ # Amazon Resource Event (ARN) of the parent aggregate notification.
1309
+ #
1310
+ # This is omitted if notification isn't aggregated.
1311
+ # @return [String]
1312
+ #
1313
+ # @!attribute [rw] start_time
1314
+ # The notification event start time.
1315
+ # @return [Time]
1316
+ #
1317
+ # @!attribute [rw] end_time
1318
+ # The end time of the event.
1319
+ # @return [Time]
1320
+ #
1321
+ # @!attribute [rw] text_parts
1322
+ # A list of text values.
1323
+ # @return [Hash<String,Types::TextPartValue>]
1324
+ #
1325
+ # @!attribute [rw] media
1326
+ # A list of media elements.
1327
+ # @return [Array<Types::MediaElement>]
1328
+ #
1329
+ # @see http://docs.aws.amazon.com/goto/WebAPI/notifications-2018-05-10/NotificationEvent AWS API Documentation
1330
+ #
1331
+ class NotificationEvent < Struct.new(
1332
+ :schema_version,
1333
+ :id,
1334
+ :source_event_metadata,
1335
+ :message_components,
1336
+ :source_event_detail_url,
1337
+ :source_event_detail_url_display_text,
1338
+ :notification_type,
1339
+ :event_status,
1340
+ :aggregation_event_type,
1341
+ :aggregate_notification_event_arn,
1342
+ :start_time,
1343
+ :end_time,
1344
+ :text_parts,
1345
+ :media)
1346
+ SENSITIVE = []
1347
+ include Aws::Structure
1348
+ end
1349
+
1350
+ # Describes a short summary of a NotificationEvent. This is only used
1351
+ # when listing notification events.
1352
+ #
1353
+ # @!attribute [rw] arn
1354
+ # The Amazon Resource Name (ARN) of the resource.
1355
+ # @return [String]
1356
+ #
1357
+ # @!attribute [rw] notification_configuration_arn
1358
+ # The ARN of the NotificationConfiguration.
1359
+ # @return [String]
1360
+ #
1361
+ # @!attribute [rw] related_account
1362
+ # The account name containing the NotificationHub.
1363
+ # @return [String]
1364
+ #
1365
+ # @!attribute [rw] creation_time
1366
+ # The creation time of the NotificationEvent.
1367
+ # @return [Time]
1368
+ #
1369
+ # @!attribute [rw] notification_event
1370
+ # Refers to a NotificationEventSummary object.
1371
+ #
1372
+ # Similar in structure to `content` in the GetNotificationEvent
1373
+ # response.
1374
+ # @return [Types::NotificationEventSummary]
1375
+ #
1376
+ # @!attribute [rw] aggregation_event_type
1377
+ # The NotificationConfiguration's aggregation type.
1378
+ #
1379
+ # * Values:
1380
+ #
1381
+ # * `AGGREGATE`
1382
+ #
1383
+ # * The notification event is an aggregate notification. Aggregate
1384
+ # notifications summarize grouped events over a specified time
1385
+ # period.
1386
+ #
1387
+ # ^
1388
+ # * `CHILD`
1389
+ #
1390
+ # * Some EventRules are `ACTIVE` and some are `INACTIVE`. Any call
1391
+ # can be run.
1392
+ #
1393
+ # ^
1394
+ # * `NONE`
1395
+ #
1396
+ # * The notification isn't aggregated.
1397
+ #
1398
+ # ^
1399
+ # @return [String]
1400
+ #
1401
+ # @!attribute [rw] aggregate_notification_event_arn
1402
+ # The ARN of the aggregatedNotificationEventArn to match.
1403
+ # @return [String]
1404
+ #
1405
+ # @see http://docs.aws.amazon.com/goto/WebAPI/notifications-2018-05-10/NotificationEventOverview AWS API Documentation
1406
+ #
1407
+ class NotificationEventOverview < Struct.new(
1408
+ :arn,
1409
+ :notification_configuration_arn,
1410
+ :related_account,
1411
+ :creation_time,
1412
+ :notification_event,
1413
+ :aggregation_event_type,
1414
+ :aggregate_notification_event_arn)
1415
+ SENSITIVE = []
1416
+ include Aws::Structure
1417
+ end
1418
+
1419
+ # Describes a short summary and metadata for a notification event.
1420
+ #
1421
+ # @!attribute [rw] schema_version
1422
+ # The schema version of the Notification Event.
1423
+ # @return [String]
1424
+ #
1425
+ # @!attribute [rw] source_event_metadata
1426
+ # The source event metadata.
1427
+ # @return [Types::SourceEventMetadataSummary]
1428
+ #
1429
+ # @!attribute [rw] message_components
1430
+ # The message components of a notification event.
1431
+ # @return [Types::MessageComponentsSummary]
1432
+ #
1433
+ # @!attribute [rw] event_status
1434
+ # The notification event status.
1435
+ #
1436
+ # * Values:
1437
+ #
1438
+ # * `HEALTHY`
1439
+ #
1440
+ # * All EventRules are `ACTIVE` and any call can be run.
1441
+ #
1442
+ # ^
1443
+ # * `UNHEALTHY`
1444
+ #
1445
+ # * Some EventRules are `ACTIVE` and some are `INACTIVE`. Any call
1446
+ # can be run.
1447
+ #
1448
+ # ^
1449
+ # @return [String]
1450
+ #
1451
+ # @!attribute [rw] notification_type
1452
+ # The type of event causing the notification.
1453
+ #
1454
+ # * Values:
1455
+ #
1456
+ # * `ALERT`
1457
+ #
1458
+ # * A notification about an event where something was triggered,
1459
+ # initiated, reopened, deployed, or a threshold was breached.
1460
+ #
1461
+ # ^
1462
+ # * `WARNING`
1463
+ #
1464
+ # * A notification about an event where an issue is about to
1465
+ # arise. For example, something is approaching a threshold.
1466
+ #
1467
+ # ^
1468
+ # * `ANNOUNCEMENT`
1469
+ #
1470
+ # * A notification about an important event. For example, a step
1471
+ # in a workflow or escalation path or that a workflow was
1472
+ # updated.
1473
+ #
1474
+ # ^
1475
+ # * `INFORMATIONAL`
1476
+ #
1477
+ # * A notification about informational messages. For example,
1478
+ # recommendations, service announcements, or reminders.
1479
+ #
1480
+ # ^
1481
+ # @return [String]
1482
+ #
1483
+ # @see http://docs.aws.amazon.com/goto/WebAPI/notifications-2018-05-10/NotificationEventSummary AWS API Documentation
1484
+ #
1485
+ class NotificationEventSummary < Struct.new(
1486
+ :schema_version,
1487
+ :source_event_metadata,
1488
+ :message_components,
1489
+ :event_status,
1490
+ :notification_type)
1491
+ SENSITIVE = []
1492
+ include Aws::Structure
1493
+ end
1494
+
1495
+ # Describes an overview of a NotificationHub.
1496
+ #
1497
+ # A NotificationHub is an account-level setting used to select the
1498
+ # Regions where you want to store, process and replicate your
1499
+ # notifications.
1500
+ #
1501
+ # @!attribute [rw] notification_hub_region
1502
+ # The Region of the resource.
1503
+ # @return [String]
1504
+ #
1505
+ # @!attribute [rw] status_summary
1506
+ # The status summary of the resource.
1507
+ # @return [Types::NotificationHubStatusSummary]
1508
+ #
1509
+ # @!attribute [rw] creation_time
1510
+ # The date and time the resource was created.
1511
+ # @return [Time]
1512
+ #
1513
+ # @!attribute [rw] last_activation_time
1514
+ # The most recent time this NotificationHub had an ACTIVE status.
1515
+ # @return [Time]
1516
+ #
1517
+ # @see http://docs.aws.amazon.com/goto/WebAPI/notifications-2018-05-10/NotificationHubOverview AWS API Documentation
1518
+ #
1519
+ class NotificationHubOverview < Struct.new(
1520
+ :notification_hub_region,
1521
+ :status_summary,
1522
+ :creation_time,
1523
+ :last_activation_time)
1524
+ SENSITIVE = []
1525
+ include Aws::Structure
1526
+ end
1527
+
1528
+ # NotificationHub status information.
1529
+ #
1530
+ # @!attribute [rw] status
1531
+ # Status information about the NotificationHub.
1532
+ #
1533
+ # * Values:
1534
+ #
1535
+ # * `ACTIVE`
1536
+ #
1537
+ # * Incoming NotificationEvents are replicated to this
1538
+ # NotificationHub.
1539
+ #
1540
+ # ^
1541
+ # * `REGISTERING`
1542
+ #
1543
+ # * The NotificationHub is initializing. A NotificationHub with
1544
+ # this status can't be deregistered.
1545
+ #
1546
+ # ^
1547
+ # * `DEREGISTERING`
1548
+ #
1549
+ # * The NotificationHub is being deleted. You can't register
1550
+ # additional NotificationHubs in the same Region as a
1551
+ # NotificationHub with this status.
1552
+ #
1553
+ # ^
1554
+ # @return [String]
1555
+ #
1556
+ # @!attribute [rw] reason
1557
+ # An Explanation for the current status.
1558
+ # @return [String]
1559
+ #
1560
+ # @see http://docs.aws.amazon.com/goto/WebAPI/notifications-2018-05-10/NotificationHubStatusSummary AWS API Documentation
1561
+ #
1562
+ class NotificationHubStatusSummary < Struct.new(
1563
+ :status,
1564
+ :reason)
1565
+ SENSITIVE = []
1566
+ include Aws::Structure
1567
+ end
1568
+
1569
+ # @!attribute [rw] notification_hub_region
1570
+ # The Region of the NotificationHub.
1571
+ # @return [String]
1572
+ #
1573
+ # @see http://docs.aws.amazon.com/goto/WebAPI/notifications-2018-05-10/RegisterNotificationHubRequest AWS API Documentation
1574
+ #
1575
+ class RegisterNotificationHubRequest < Struct.new(
1576
+ :notification_hub_region)
1577
+ SENSITIVE = []
1578
+ include Aws::Structure
1579
+ end
1580
+
1581
+ # @!attribute [rw] notification_hub_region
1582
+ # The Region of the NotificationHub.
1583
+ # @return [String]
1584
+ #
1585
+ # @!attribute [rw] status_summary
1586
+ # NotificationHub status information.
1587
+ # @return [Types::NotificationHubStatusSummary]
1588
+ #
1589
+ # @!attribute [rw] creation_time
1590
+ # The date the resource was created.
1591
+ # @return [Time]
1592
+ #
1593
+ # @!attribute [rw] last_activation_time
1594
+ # The date the resource was last activated.
1595
+ # @return [Time]
1596
+ #
1597
+ # @see http://docs.aws.amazon.com/goto/WebAPI/notifications-2018-05-10/RegisterNotificationHubResponse AWS API Documentation
1598
+ #
1599
+ class RegisterNotificationHubResponse < Struct.new(
1600
+ :notification_hub_region,
1601
+ :status_summary,
1602
+ :creation_time,
1603
+ :last_activation_time)
1604
+ SENSITIVE = []
1605
+ include Aws::Structure
1606
+ end
1607
+
1608
+ # A resource affected by or closely linked to an event.
1609
+ #
1610
+ # @!attribute [rw] id
1611
+ # The unique identifier for the resource.
1612
+ #
1613
+ # At least one id or ARN is required.
1614
+ # @return [String]
1615
+ #
1616
+ # @!attribute [rw] arn
1617
+ # The Amazon Resource Name (ARN) of the resource. At least one id or
1618
+ # ARN is required.
1619
+ # @return [String]
1620
+ #
1621
+ # @!attribute [rw] detail_url
1622
+ # The URL to the resource's detail page. If a detail page URL is
1623
+ # unavailable, it is the URL to an informational page that describes
1624
+ # the resource's type.
1625
+ # @return [String]
1626
+ #
1627
+ # @!attribute [rw] tags
1628
+ # A map of tags assigned to a resource. A tag is a string-to-string
1629
+ # map of key-value pairs.
1630
+ # @return [Array<String>]
1631
+ #
1632
+ # @see http://docs.aws.amazon.com/goto/WebAPI/notifications-2018-05-10/Resource AWS API Documentation
1633
+ #
1634
+ class Resource < Struct.new(
1635
+ :id,
1636
+ :arn,
1637
+ :detail_url,
1638
+ :tags)
1639
+ SENSITIVE = []
1640
+ include Aws::Structure
1641
+ end
1642
+
1643
+ # Request references a resource which does not exist.
1644
+ #
1645
+ # @!attribute [rw] message
1646
+ # @return [String]
1647
+ #
1648
+ # @!attribute [rw] resource_id
1649
+ # The ID of the resource that wasn't found.
1650
+ # @return [String]
1651
+ #
1652
+ # @see http://docs.aws.amazon.com/goto/WebAPI/notifications-2018-05-10/ResourceNotFoundException AWS API Documentation
1653
+ #
1654
+ class ResourceNotFoundException < Struct.new(
1655
+ :message,
1656
+ :resource_id)
1657
+ SENSITIVE = []
1658
+ include Aws::Structure
1659
+ end
1660
+
1661
+ # Request would cause a service quota to be exceeded.
1662
+ #
1663
+ # @!attribute [rw] message
1664
+ # @return [String]
1665
+ #
1666
+ # @!attribute [rw] resource_type
1667
+ # The type of the resource that exceeds the service quota.
1668
+ # @return [String]
1669
+ #
1670
+ # @!attribute [rw] resource_id
1671
+ # The ID of the resource that exceeds the service quota.
1672
+ # @return [String]
1673
+ #
1674
+ # @!attribute [rw] service_code
1675
+ # The code for the service quota exceeded in [Service Quotas][1].
1676
+ #
1677
+ #
1678
+ #
1679
+ # [1]: https://docs.aws.amazon.com/servicequotas/latest/userguide/intro.html
1680
+ # @return [String]
1681
+ #
1682
+ # @!attribute [rw] quota_code
1683
+ # The code for the service quota in [Service Quotas][1].
1684
+ #
1685
+ #
1686
+ #
1687
+ # [1]: https://docs.aws.amazon.com/servicequotas/latest/userguide/intro.html
1688
+ # @return [String]
1689
+ #
1690
+ # @see http://docs.aws.amazon.com/goto/WebAPI/notifications-2018-05-10/ServiceQuotaExceededException AWS API Documentation
1691
+ #
1692
+ class ServiceQuotaExceededException < Struct.new(
1693
+ :message,
1694
+ :resource_type,
1695
+ :resource_id,
1696
+ :service_code,
1697
+ :quota_code)
1698
+ SENSITIVE = []
1699
+ include Aws::Structure
1700
+ end
1701
+
1702
+ # Describes the metadata for a source event.
1703
+ #
1704
+ # For more information, see [Event structure reference][1] in the
1705
+ # *Amazon EventBridge User Guide*.
1706
+ #
1707
+ #
1708
+ #
1709
+ # [1]: https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-events-structure.html
1710
+ #
1711
+ # @!attribute [rw] event_type_version
1712
+ # The version of the type of event.
1713
+ # @return [String]
1714
+ #
1715
+ # @!attribute [rw] source_event_id
1716
+ # The source event id.
1717
+ # @return [String]
1718
+ #
1719
+ # @!attribute [rw] event_origin_region
1720
+ # The Region the event originated from.
1721
+ # @return [String]
1722
+ #
1723
+ # @!attribute [rw] related_account
1724
+ # The Primary AWS account of Source Event
1725
+ # @return [String]
1726
+ #
1727
+ # @!attribute [rw] source
1728
+ # The AWS servvice the event originates from. For example
1729
+ # `aws.cloudwatch`.
1730
+ # @return [String]
1731
+ #
1732
+ # @!attribute [rw] event_occurrence_time
1733
+ # The date and time the source event occurred. This is based on the
1734
+ # Source Event.
1735
+ # @return [Time]
1736
+ #
1737
+ # @!attribute [rw] event_type
1738
+ # The type of event. For example, an AWS CloudWatch state change.
1739
+ # @return [String]
1740
+ #
1741
+ # @!attribute [rw] related_resources
1742
+ # A list of resources related to this NotificationEvent.
1743
+ # @return [Array<Types::Resource>]
1744
+ #
1745
+ # @see http://docs.aws.amazon.com/goto/WebAPI/notifications-2018-05-10/SourceEventMetadata AWS API Documentation
1746
+ #
1747
+ class SourceEventMetadata < Struct.new(
1748
+ :event_type_version,
1749
+ :source_event_id,
1750
+ :event_origin_region,
1751
+ :related_account,
1752
+ :source,
1753
+ :event_occurrence_time,
1754
+ :event_type,
1755
+ :related_resources)
1756
+ SENSITIVE = []
1757
+ include Aws::Structure
1758
+ end
1759
+
1760
+ # Contains metadata about the event that caused the NotificationEvent.
1761
+ # For other specific values, see sourceEventMetadata.
1762
+ #
1763
+ # @!attribute [rw] event_origin_region
1764
+ # The Region where the notification originated.
1765
+ #
1766
+ # Unavailable for aggregated notifications.
1767
+ # @return [String]
1768
+ #
1769
+ # @!attribute [rw] source
1770
+ # The matched event source.
1771
+ #
1772
+ # Must match one of the valid EventBridge sources. Only AWS service
1773
+ # sourced events are supported. For example, `aws.ec2` and
1774
+ # `aws.cloudwatch`. For more information, see [Event delivery from AWS
1775
+ # services][1] in the *Amazon EventBridge User Guide*.
1776
+ #
1777
+ #
1778
+ #
1779
+ # [1]: https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-service-event.html#eb-service-event-delivery-level
1780
+ # @return [String]
1781
+ #
1782
+ # @!attribute [rw] event_type
1783
+ # The event type to match.
1784
+ #
1785
+ # Must match one of the valid Amazon EventBridge event types. For
1786
+ # example, EC2 Instance State-change Notification and AWS CloudWatch
1787
+ # Alarm State Change. For more information, see [Event delivery from
1788
+ # AWS services][1] in the *Amazon EventBridge User Guide*.
1789
+ #
1790
+ #
1791
+ #
1792
+ # [1]: https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-service-event.html#eb-service-event-delivery-level
1793
+ # @return [String]
1794
+ #
1795
+ # @see http://docs.aws.amazon.com/goto/WebAPI/notifications-2018-05-10/SourceEventMetadataSummary AWS API Documentation
1796
+ #
1797
+ class SourceEventMetadataSummary < Struct.new(
1798
+ :event_origin_region,
1799
+ :source,
1800
+ :event_type)
1801
+ SENSITIVE = []
1802
+ include Aws::Structure
1803
+ end
1804
+
1805
+ # @!attribute [rw] arn
1806
+ # The Amazon Resource Name (ARN) to use to tag a resource.
1807
+ # @return [String]
1808
+ #
1809
+ # @!attribute [rw] tags
1810
+ # A map of tags assigned to a resource. A tag is a string-to-string
1811
+ # map of key-value pairs.
1812
+ # @return [Hash<String,String>]
1813
+ #
1814
+ # @see http://docs.aws.amazon.com/goto/WebAPI/notifications-2018-05-10/TagResourceRequest AWS API Documentation
1815
+ #
1816
+ class TagResourceRequest < Struct.new(
1817
+ :arn,
1818
+ :tags)
1819
+ SENSITIVE = []
1820
+ include Aws::Structure
1821
+ end
1822
+
1823
+ # @see http://docs.aws.amazon.com/goto/WebAPI/notifications-2018-05-10/TagResourceResponse AWS API Documentation
1824
+ #
1825
+ class TagResourceResponse < Aws::EmptyStructure; end
1826
+
1827
+ # Describes text information objects containing fields that determine
1828
+ # how text part objects are composed.
1829
+ #
1830
+ # @!attribute [rw] type
1831
+ # The type of text part. Determines the usage of all other fields and
1832
+ # whether or not they're required.
1833
+ # @return [String]
1834
+ #
1835
+ # @!attribute [rw] display_text
1836
+ # A short single line description of the link. Must be hyperlinked
1837
+ # with the URL itself.
1838
+ #
1839
+ # Used for text parts with the type `URL`.
1840
+ # @return [String]
1841
+ #
1842
+ # @!attribute [rw] text_by_locale
1843
+ # A map of locales to the text in that locale.
1844
+ # @return [Hash<String,String>]
1845
+ #
1846
+ # @!attribute [rw] url
1847
+ # The URL itself.
1848
+ # @return [String]
1849
+ #
1850
+ # @see http://docs.aws.amazon.com/goto/WebAPI/notifications-2018-05-10/TextPartValue AWS API Documentation
1851
+ #
1852
+ class TextPartValue < Struct.new(
1853
+ :type,
1854
+ :display_text,
1855
+ :text_by_locale,
1856
+ :url)
1857
+ SENSITIVE = []
1858
+ include Aws::Structure
1859
+ end
1860
+
1861
+ # Request was denied due to request throttling.
1862
+ #
1863
+ # @!attribute [rw] message
1864
+ # @return [String]
1865
+ #
1866
+ # @!attribute [rw] service_code
1867
+ # Identifies the service being throttled.
1868
+ # @return [String]
1869
+ #
1870
+ # @!attribute [rw] quota_code
1871
+ # Identifies the quota that is being throttled.
1872
+ # @return [String]
1873
+ #
1874
+ # @!attribute [rw] retry_after_seconds
1875
+ # The number of seconds a client should wait before retrying the
1876
+ # request.
1877
+ # @return [Integer]
1878
+ #
1879
+ # @see http://docs.aws.amazon.com/goto/WebAPI/notifications-2018-05-10/ThrottlingException AWS API Documentation
1880
+ #
1881
+ class ThrottlingException < Struct.new(
1882
+ :message,
1883
+ :service_code,
1884
+ :quota_code,
1885
+ :retry_after_seconds)
1886
+ SENSITIVE = []
1887
+ include Aws::Structure
1888
+ end
1889
+
1890
+ # @!attribute [rw] arn
1891
+ # The Amazon Resource Name (ARN) to use to untag a resource.
1892
+ # @return [String]
1893
+ #
1894
+ # @!attribute [rw] tag_keys
1895
+ # The tag keys to use to untag a resource.
1896
+ # @return [Array<String>]
1897
+ #
1898
+ # @see http://docs.aws.amazon.com/goto/WebAPI/notifications-2018-05-10/UntagResourceRequest AWS API Documentation
1899
+ #
1900
+ class UntagResourceRequest < Struct.new(
1901
+ :arn,
1902
+ :tag_keys)
1903
+ SENSITIVE = []
1904
+ include Aws::Structure
1905
+ end
1906
+
1907
+ # @see http://docs.aws.amazon.com/goto/WebAPI/notifications-2018-05-10/UntagResourceResponse AWS API Documentation
1908
+ #
1909
+ class UntagResourceResponse < Aws::EmptyStructure; end
1910
+
1911
+ # @!attribute [rw] arn
1912
+ # The Amazon Resource Name (ARN) to use to update the EventRule.
1913
+ # @return [String]
1914
+ #
1915
+ # @!attribute [rw] event_pattern
1916
+ # An additional event pattern used to further filter the events this
1917
+ # EventRule receives.
1918
+ #
1919
+ # For more information, see [Amazon EventBridge event patterns][1] in
1920
+ # the *Amazon EventBridge User Guide.*
1921
+ #
1922
+ #
1923
+ #
1924
+ # [1]: https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-event-patterns.html
1925
+ # @return [String]
1926
+ #
1927
+ # @!attribute [rw] regions
1928
+ # A list of AWS Regions that sends events to this EventRule.
1929
+ # @return [Array<String>]
1930
+ #
1931
+ # @see http://docs.aws.amazon.com/goto/WebAPI/notifications-2018-05-10/UpdateEventRuleRequest AWS API Documentation
1932
+ #
1933
+ class UpdateEventRuleRequest < Struct.new(
1934
+ :arn,
1935
+ :event_pattern,
1936
+ :regions)
1937
+ SENSITIVE = []
1938
+ include Aws::Structure
1939
+ end
1940
+
1941
+ # @!attribute [rw] arn
1942
+ # The Amazon Resource Name (ARN) to use to update the EventRule.
1943
+ # @return [String]
1944
+ #
1945
+ # @!attribute [rw] notification_configuration_arn
1946
+ # The ARN of the NotificationConfiguration.
1947
+ # @return [String]
1948
+ #
1949
+ # @!attribute [rw] status_summary_by_region
1950
+ # The status of the action by Region.
1951
+ # @return [Hash<String,Types::EventRuleStatusSummary>]
1952
+ #
1953
+ # @see http://docs.aws.amazon.com/goto/WebAPI/notifications-2018-05-10/UpdateEventRuleResponse AWS API Documentation
1954
+ #
1955
+ class UpdateEventRuleResponse < Struct.new(
1956
+ :arn,
1957
+ :notification_configuration_arn,
1958
+ :status_summary_by_region)
1959
+ SENSITIVE = []
1960
+ include Aws::Structure
1961
+ end
1962
+
1963
+ # @!attribute [rw] arn
1964
+ # The Amazon Resource Name (ARN) used to update the
1965
+ # NotificationConfiguration.
1966
+ # @return [String]
1967
+ #
1968
+ # @!attribute [rw] name
1969
+ # The name of the NotificationConfiguration.
1970
+ # @return [String]
1971
+ #
1972
+ # @!attribute [rw] description
1973
+ # The description of the NotificationConfiguration.
1974
+ # @return [String]
1975
+ #
1976
+ # @!attribute [rw] aggregation_duration
1977
+ # The status of this NotificationConfiguration.
1978
+ #
1979
+ # The status should always be `INACTIVE` when part of the
1980
+ # CreateNotificationConfiguration response.
1981
+ #
1982
+ # * Values:
1983
+ #
1984
+ # * `ACTIVE`
1985
+ #
1986
+ # * All EventRules are `ACTIVE` and any call can be run.
1987
+ #
1988
+ # ^
1989
+ # * `PARTIALLY_ACTIVE`
1990
+ #
1991
+ # * Some EventRules are `ACTIVE` and some are `INACTIVE`. Any call
1992
+ # can be run.
1993
+ #
1994
+ # * Any call can be run.
1995
+ # * `INACTIVE`
1996
+ #
1997
+ # * All EventRules are `INACTIVE` and any call can be run.
1998
+ #
1999
+ # ^
2000
+ # * `DELETING`
2001
+ #
2002
+ # * This NotificationConfiguration is being deleted.
2003
+ #
2004
+ # * Only `GET` and `LIST` calls can be run.
2005
+ # @return [String]
2006
+ #
2007
+ # @see http://docs.aws.amazon.com/goto/WebAPI/notifications-2018-05-10/UpdateNotificationConfigurationRequest AWS API Documentation
2008
+ #
2009
+ class UpdateNotificationConfigurationRequest < Struct.new(
2010
+ :arn,
2011
+ :name,
2012
+ :description,
2013
+ :aggregation_duration)
2014
+ SENSITIVE = []
2015
+ include Aws::Structure
2016
+ end
2017
+
2018
+ # @!attribute [rw] arn
2019
+ # The ARN used to update the NotificationConfiguration.
2020
+ # @return [String]
2021
+ #
2022
+ # @see http://docs.aws.amazon.com/goto/WebAPI/notifications-2018-05-10/UpdateNotificationConfigurationResponse AWS API Documentation
2023
+ #
2024
+ class UpdateNotificationConfigurationResponse < Struct.new(
2025
+ :arn)
2026
+ SENSITIVE = []
2027
+ include Aws::Structure
2028
+ end
2029
+
2030
+ # This exception is thrown when the notification event fails validation.
2031
+ #
2032
+ # @!attribute [rw] message
2033
+ # @return [String]
2034
+ #
2035
+ # @!attribute [rw] reason
2036
+ # The reason why your input is considered invalid.
2037
+ # @return [String]
2038
+ #
2039
+ # @!attribute [rw] field_list
2040
+ # The list of input fields that are invalid.
2041
+ # @return [Array<Types::ValidationExceptionField>]
2042
+ #
2043
+ # @see http://docs.aws.amazon.com/goto/WebAPI/notifications-2018-05-10/ValidationException AWS API Documentation
2044
+ #
2045
+ class ValidationException < Struct.new(
2046
+ :message,
2047
+ :reason,
2048
+ :field_list)
2049
+ SENSITIVE = []
2050
+ include Aws::Structure
2051
+ end
2052
+
2053
+ # Stores information about a field passed inside a request that resulted
2054
+ # in an exception.
2055
+ #
2056
+ # @!attribute [rw] name
2057
+ # The field name where the invalid entry was detected.
2058
+ # @return [String]
2059
+ #
2060
+ # @!attribute [rw] message
2061
+ # A message with the reason for the validation exception error.
2062
+ # @return [String]
2063
+ #
2064
+ # @see http://docs.aws.amazon.com/goto/WebAPI/notifications-2018-05-10/ValidationExceptionField AWS API Documentation
2065
+ #
2066
+ class ValidationExceptionField < Struct.new(
2067
+ :name,
2068
+ :message)
2069
+ SENSITIVE = []
2070
+ include Aws::Structure
2071
+ end
2072
+
2073
+ end
2074
+ end
2075
+